Overview

Overview of /dispatches

For an example of how to use our /dispatches endpoints in a typical business scenario, refer to TMS Integration Workflow.

Dispatch is a collection of stops, each with their own set of forms, which can be in either a planned, active, cancelled, or completed state. A driver can have only one active dispatch while having any number of planned dispatches.

A dispatch consists of a minimum of two stops. The first is called the shipper stop and the last is called the consignee stop. The shipper stop is where the dispatch is started from and the consignee stop is where the dispatch is completed. Any other stops in between are referred to as additional stops and are called dispatch stops in our system.

Below is a list of all attributes in a Dispatch

AttributeTypeDescription
vendor_idstring (optional)External system ID for dispatch
vehicle_idinteger (required)Vehicle associated to dispatch
driver_idinteger (required)Driver associated to dispatch
vendor_shipper_idstring (optional)External system ID for shipper stop
vendor_consignee_idstring (optional)External system ID for consignee stop
shipper_dispatch_location_idinteger (required)Dispatch location associated with shipper stop for dispatch
consignee_dispatch_location_idinteger (required)Dispatch location associated with consignee stop for dispatch
statusstring (required)Status of dispatch. Valid values are [“planned”, “active”, “cancelled”, “completed”]
shipper_statusstring (required)Status for shipper stop. Valid values are ["available", "in_progress", "departed"]. Default value: "available"
consignee_statusstring (required)Status for consignee stop. Valid values are ["available", "in_progress", "departed"]. Default value: "available"
shipper_form_idsArray of strings (required)Forms to be filled out at shipper stop. Array of UUID’s of forms.
consignee_form_idsArray of strings (required)Forms to be filled out at consignee stop. Array of UUID’s of forms.
shipper_typestring (required)
consignee_typestring (required)
trailerstring (optional)
productstring (optional)
additional_pickupsinteger (optional)
additional_dropsinteger (optional)
loaded_milesinteger (optional)
consignee_refnostring (optional)
temperature_mininteger (optional)
temperature_maxinteger (optional)
pickup_numberstring (optional)
pickup_early_datedatetime (optional)
pickup_late_datedatetime (optional)
shipper_driver_loadboolean (optional)
shipper_piecesfloat (optional)
shipper_weightfloat (optional)
shipper_palletsinteger (optional)
shipper_commentsstring (optional)
shipper_bill_of_ladingstring (optional)
shipper_volumefloat (optional)
delivery_early_datedatetime (optional)
delivery_late_datedatetime (optional)
consignee_driver_loadboolean (optional)
consignee_piecesfloat (optional)
consignee_weightfloat (optional)
consignee_palletsinteger (optional)
consignee_commentsstring (optional)
consignee_bill_of_ladingstring (optional)
consignee_volumefloat (optional)
order_piecesfloat (optional)
order_weightfloat (optional)
order_volumefloat (optional)
custom_field1-10string (optional)10 custom fields to store any extra information for a dispatch
shipper_custom_field1-10string (optional)10 custom fields to store any extra information for a shipper stop
consignee_custom_field1-10string (optional)10 custom fields to store any extra information for a consignee stop
auto_complete_formsboolean (optional)

Below is a list of all attributes in a Dispatch Stop

AttributeTypeDescription
vendor_idstring (optional)External system ID for stop
numberinteger (required)Specifies the position of the stop. Values start at 1
statusstring (required)Status of stop. Valid values are ["available", "in_progress", "departed"]. Default value: "available"
dispatch_location_idinteger (required)Dispatch location associated with stop
form_idsArray of strings (required)Forms to be filled out at stop. Array of UUID’s of forms.
typestring (optional)
early_datedatetime (optional)
late_datedatetime (optional)
driver_loadboolean (optional)
piecesfloat (optional)
weightfloat (optional)
pallets_ininteger (optional)
pallets_outinteger (optional)
commentsstring (optional)
bill_of_ladingstring (optional)
volumefloat (optional)
custom_field1-10string (optional)10 custom fields to store any extra information for a stop