For an example of how to use our /dispatches endpoints in a typical business scenario, refer to TMS Integration Workflow.
A dispatch is a collection of dispatch trips while a dispatch trip is a collection of dispatch stops. A dispatch trip has its own set of dispatch stops, which can be in either a not_started, in_progress, completed and cancelled state. A driver can have only one in_progress dispatch trip while having any number of not_started dispatch trips. In the simplest scenario, a dispatch may consist of one dispatch trip. However, we can add more trips to split up a dispatch. Each trip would have its own stops and the stops must be unique across trips.
In v3, dispatches deprecates the notion of an explicit shipper and consignee stop.
Dispatch: Attributes
| Attribute | Type | Description |
|---|---|---|
vendor_id | string (optional) | External system ID for dispatch |
trailer | string (optional) | |
product | string (optional) | |
additional_pickups | integer (optional) | |
additional_drops | integer (optional) | |
loaded_miles | integer (optional) | |
consignee_refno | string (optional) | |
temperature_min | integer (optional) | |
temperature_max | integer (optional) | |
pickup_number | string (optional) | |
order_pieces | float (optional) | |
order_weight | float (optional) | |
order_volume | float (optional) | |
custom_field1-custom_field100 | string (optional) | 100 custom fields to store any extra information for a dispatch |
auto_complete_forms | boolean (optional) |
Dispatch Stop: Attributes
| Attribute | Type | Description |
|---|---|---|
vendor_id | string (optional) | External system ID for stop |
number | integer (required) | Specifies the position of the stop; values start at "1" |
status | string (optional) | Status of stop. Valid values are ["available", "in_progress", "departed"]. Default value: "available" |
dispatch_location_id | integer (required) | Dispatch location associated with stop |
form_ids | Array of strings (required) | Forms to be filled out at stop (array of UUIDs of forms) |
type | string (optional) | |
early_date | datetime (optional) | |
late_date | datetime (optional) | |
driver_load | boolean (optional) | |
pieces | float (optional) | |
weight | float (optional) | |
pallets_in | integer (optional) | |
pallets_out | integer (optional) | |
comments | string (optional) | |
bill_of_lading | string (optional) | |
volume | float (optional) | |
custom_field1-custom_field100 | string (optional) | 100 custom fields to store any extra information for a stop |
Dispatch Trip: Attributes
| Attribute | Type | Description |
|---|---|---|
vendor_id | string (optional) | External system ID for trip |
status | string (required) | Status of trip. Valid values are ["not_started", "in_progress", "completed", "cancelled"]. Default value: "not_started" |
vehicle_id | integer (required) | Vehicle associated to dispatch |
driver_id | integer (required) | Driver associated to dispatch |
dispatch_id | integer (required) | Dispatch with which the trip is associated |
status_updated_at | timestamp | |
created_at | timestamp | |
updated_at | timestamp |