Attached you will find four files with samples.
- SampleCustomerCreation.txt
- SampleCustomerStaff.txt
- ShipmentStatusUpdatePayload.txt
- ShipmentCreationPayload.txt
In the Header include the x-api-key: {INSERT AUTHENTICATION KEY}
From time to time, we will update the test environment with fresh data from Production. When this occurs, auth keys, logins, and webhook URLs will be deleted and need to be re-added.Workflow:
Customer Creation
- https://atl.taicloud.net/PublicApi/swagger/index#!/Organizations/PublicAPIOrganization_CreateCustomer
- Use the Customer Creation endpoint to create the customer in TMS
- The only required field is Company Name, however, the more details the better. CLIENT can define the fields that they require
Customer Staff Update
- https://atl.taicloud.net/PublicApi/swagger/index#!/Staff/PublicAPIStaff_UpdateCustomerStaff
- A customer staff is required in order to create a shipment
- We provide the option to update existing staff members as needed
Create Shipment Webhook
When a shipment is created, a payload will be triggered to the desired webhook URL billToOrganizationId - This denotes the customer ID. You will need to have a mapping generated that correlates the TMS customer ID to the customer in HubSpot.Shipment Status Update Webhook
When a shipment is updated, a payload will be triggered to the desired webhook URL billToOrganizationId - This denotes the customer ID. You will need to have a mapping generated that correlates the TMS customer ID to the customer in HubSpot. Notes for both webhooks: The Create Shipment Webhook is intended to alert that a shipment has been created. The Shipment Status Update Webhook is intended to fire whenever there is a change in status. For the purpose of the CRM, if the status is Quoted or Booked, it is considered a "New Deal". If the status is "Ready" thru "Complete", then it is considered a "Deal Won". Shipment Statuses:- Quoted
- Booked
- Ready
- Sent
- Dispatched
- In Transit
- Out for Delivery
- Delivered
- Complete