Get a collection of dispatches for the provided dispatch IDs or URLs
Indicates whether the response should include change records (dispatch status change and additional information records with the dispatch and dispatch vehicle status change and dispatch vehicle date change records with the dispatch vehicle).
Default:false
Example:true
Indicates whether the response should include internal load notes for the dispatch. Notes are scoped to the caller’s customer ID and profile type.
Default:false
Example:false
The major version of the API to make a request against. This is a custom MIME type that contains vnd.coxauto.v[#]+. For example, to request a resource from version 1.x.x of an API, the Content-Type header should be set to application/vnd.coxauto.v1+json.
Example:application/vnd.coxauto.v1+json
An array of dispatch IDs and/or dispatch URLs.
OK. Successful request.
A collection of dispatches.
The URL used to query the current collection of the resource.
Example:https://fulfillment-api.centraldispatch.com/api/fulfillments/id/d159acc0-e89b-12d3-a456-426614174000
The total count of resources in the collection.
Example:23
Details of a dispatch.
Get a collection of dispatch IDs based on the specified search criteria.
X-Profile-Type header must be included to distinguish between calling as a dealer or carrier.carrier, dealer.Required when calling as a broker, use to specify the caller’s role. The value must be either carrier or shipper. Default is shipper
Example:carrier
The major version of the API to make a request against. This is a custom MIME type that contains vnd.coxauto.v[#]+. For example, to request a resource from version 1.x.x of an API, the Content-Type header should be set to application/vnd.coxauto.v1+json.
Example:application/vnd.coxauto.v1+json
DispatchSearchRequest
Details of the dispatch search.
Details of search fields.
Determines which record in the collection will be the first one displayed. This value is 1-based, meaning the count starts at 1. Please put this and limit at the end of the request.
Example:10
The maximum number of items to be returned in the response. Please put this and offset at the end of the request.
Default:50
Example:1
Details of search sort.
OK. Successful request.
Details of a dispatch search.
A collection of dispatch IDs.
Example:["d159acc0-e89b-12d3-a456-426614174000"]
The maximum number of items to be returned in the response.
Example:1
The total count of resources in the collection.
Example:100
Update an existing dispatch.
If-Match header is required and its value can be found in the ETag response header of the resource’s GET by ID endpoint.Location header that contains the fully qualified URL of the newly created resource. The final segment of the URL will be the ID of the resource.This is a required field to ensure the update is being completed on an item that has not changed since it was last read. The value of this field will be the value of the ETag header that was received on the preceding get call.
Example:8675309
The major version of the API to make a request against. This is a custom MIME type that contains vnd.coxauto.v[#]+. For example, to request a resource from version 1.x.x of an API, the Content-Type header should be set to application/vnd.coxauto.v1+json.
Example:application/vnd.coxauto.v1+json
UpdateDispatchRequest
Details of a dispatch.
The ID of the dispatch.
Example:d159acc0-e89b-12d3-a456-426614174000
The identifier of the order that created the dispatch in the shipper system managed by the user. This value is not visible on the Central Dispatch website.
Example:ORD-2023-0001
An identifier managed by the user. Shippers can use this field to map a record (e.g. order, shipment, dispatch) in their local TMS to a Central Dispatch record. This value is displayed as the load number on the Central Dispatch website.
Example:RND10 CHEV
Details of the dispatch price.
Details of a stop.
Details of a vehicle.
Details of additional information.
The balance amount that will be due after the COD/COP payment is applied.
>= 0
Example:300
The currency of balanceAmount.
Default:USD
Example:USD
The payment method with which the balance due payment will be paid. Required if balanceAmount is greater than 0. This list is not exhaustive and additional values may be added at any time.
Allowed values:CASHCERTIFIED_FUNDSCOMPANY_CHECKCOMCHEKTCH
Example:CASH
The terms for beginning balance payment. Required if balanceAmount is greater than 0. This list is not exhaustive and additional values may be added at any time.
Allowed values:PICKUPDELIVERYRECEIVING_SIGNED_BOL
Example:PICKUP
The time frame when the balance payment is due. Required if balanceAmount is greater than 0. This list is not exhaustive and additional values may be added at any time.
Allowed values:IMMEDIATELYTWO_BUSINESS_DAYS_QUICK_PAYFIVE_BUSINESS_DAYSTEN_BUSINESS_DAYSFIFTEEN_BUSINESS_DAYSTHIRTY_BUSINESS_DAYS
Example:IMMEDIATELY
The cash on delivery (COD) or cash on pick up (COP) amount due.
>= 0
Example:200
The currency of codAmount.
Default:USD
Example:USD
The location that COD/COP payment is due. Required if codAmount is greater than 0. This list is not exhaustive and additional values may be added at any time.
Allowed values:PICKUPDELIVERY
Example:PICKUP
The method for the COD/COP payment. Required if codAmount is greater than 0. This list is not exhaustive and additional values may be added at any time.
Allowed values:CHECKCASH_CERTIFIED_FUNDS
Example:CASH_CERTIFIED_FUNDS
Displayed in Central Dispatch website/app as “Load-Specific Terms”, these are provisions added to a contract that specify extra obligations, rights, or conditions beyond the standard terms.
Real Life Example: Charging cables need to be picked up with vehicles and if left behind a $200 fee will be applied.
Rules: This information will be visible only to the assigned carrier after the load is dispatched, and it will no longer be editable at that point.
Note: The original instructions value must be sent in any update request. If a different value is provided, the update will be rejected with status code 422 Unprocessable Entity.
Example:Charging cables need to be picked up with vehicles and if left behind a $200 fee will be applied.
Provides general preparation instructions for shipments. This should not contain sensitive data as it is made available prior to acceptance of terms by a carrier.
Rules: This information will always be visible to carriers, and it will no longer be editable once the load is dispatched.
Note: The original preDispatchNotes value must be sent in any update request. If a different value is provided, the update will be rejected with status code 422 Unprocessable Entity.
Example:In order to pick up the keys you will have to walk through a lot with a big dog that protects it, he's chained but will bark at you.
Displayed in Central Dispatch website/app as “Transport Special Instructions”, these are specific guidelines or details for the safe and efficient pick up, delivery, or transportation of a load. This may contain sensitive data and is not available prior to acceptance of terms by a carrier.
Rules: This information is visible only to the assigned carrier after the load is dispatched and remains editable at any time.
Example:You will need special clearance to get in the lot. Call Jean at 303-999-1212.
Indicates if the driver verification process is required. A driver must be assigned to the load before delivery. Information will be emailed to the contact physically present at the pickup location for use in verifying the driver’s identification. The Central Dispatch Mobile App must be used to perform the pickup and delivery inspection. (Only currently applicable to select private Marketplaces).
Default:false
Example:true
No Content. Successful request.
Update the pick up and/or delivery dates of an existing dispatch.
The ID of the dispatch.
Example:d159acc0-e89b-12d3-a456-426614174000
This is a required field to ensure the update is being completed on an item that has not changed since it was last read. The value of this field will be the value of the ETag header that was received on the preceding get call.
Example:8675309
The major version of the API to make a request against. This is a custom MIME type that contains vnd.coxauto.v[#]+. For example, to request a resource from version 1.x.x of an API, the Content-Type header should be set to application/vnd.coxauto.v1+json.
Example:application/vnd.coxauto.v1+json
UpdateDispatchDatesRequest
Details of dispatch vehicle date item.
The ID of the dispatch.
Example:d159acc0-e89b-12d3-a456-426614174000
Details of dispatch vehicle dates.
Accepted. Successful request.
A carrier can accept or decline a load that has been assigned to them by the shipper.
NOT_SIGNED will be processed.The ID of the dispatch to respond to.
Example:d159acc0-e89b-12d3-a456-426614174000
This is a required field to ensure the update is being completed on an item that has not changed since it was last read. The value of this field will be the value of the ETag header that was received on the preceding get call.
Example:8675309
The major version of the API to make a request against. This is a custom MIME type that contains vnd.coxauto.v[#]+. For example, to request a resource from version 1.x.x of an API, the Content-Type header should be set to application/vnd.coxauto.v1+json.
Example:application/vnd.coxauto.v1+json
RespondToDispatchRequest
Details of the respond request.
Indicates whether the dispatch should be accepted or declined.
Example:true
Indicates whether the require inspection requirement was acknoowledged.
Default:false
Example:true
The date the carrier estimates the vehicle will be picked up, in UTC/ISO 8601 format. Only the date portion of the value passed will be saved.
Example:2025-07-15T00:00:00.000Z
The type of delivery date. Only the date portion of the value passed will be saved.
Example:2025-08-15T00:00:00.000Z
Accepted. Successful request.