RespondToDispatchRequest
objectDetails 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
SearchDispatchResult
objectDetails 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
SearchRequest
objectDetails of search fields.
A collection of: Dispatch statuses e.g. NEW, PENDING_DELIVERY, DELIVERED, PAID, REJECTED, CANCELED.
A collection of: The pick up city.
A collection of: The pick up state.
A collection of: The pick up ZIP code. Must be a valid United States ZIP code or Canadian postal code.
A collection of: The delivery city.
A collection of: The delivery state.
A collection of: The delivery ZIP code.
A collection of: An identifier managed by the user. Shippers can use this field to map Central Dispatch dispatch ID to a record (e.g. order, shipment, dispatch) in their local TMS.
A collection of: The ID of the dispatch.
A collection of: The vehicle identification number (VIN).
A collection of: The Central Dispatch user ID of the driver.
A collection of: The shipper’s company name.
A collection of: The ID of the shipper order.
A collection of: The ID of the Central Dispatch Marketplace. There are three types of Marketplaces:
- Public: The public Marketplace ID is
10000. - Test: Test Marketplace IDs will be provided to you by Central Dispatch.
- Private: Private Marketplace IDs will be provided to you by Central Dispatch, if necessary.
A collection of: The ID of the Central Dispatch customer who is shipping the vehicle.
A collection of: The external company name.
A collection of: A vehicle identifier managed by the user. Shippers can use this field to map Central Dispatch dispatch ID to a vehicle record in their local TMS.
A collection of: The load number.
A collection of: The carrier name.
A collection of: The ID of the Central Dispatch customer chosen by the shipper to move cars in the dispatch.
The actual pick up date and time, in UTC/ISO 8601 format.
The actual delivery date and time, in UTC/ISO 8601 format.
The estimated pick up date and time, in UTC/ISO 8601 format.
The estimated delivery date and time, in UTC/ISO 8601 format.
Search dispatch date request.
Show Child Parameters
Search listing IDs information.
Show Child Parameters
Search dispatch IDs information.
Show Child Parameters
Driver IDs search.
Show Child Parameters
Indicates if the carrier is archived.
Indicates if the shipper is archived.
SortRequest
objectDetails of search sort.
The name of the field to sort by.
Example:actualPickUpDateTime
The direction of the sort. Values: ASCENDING, DESCENDING.
Example:ASCENDING
StatusChangeResponse
objectDetails of a status change.
The Central Dispatch username of the person who submitted the status change.
Example:d71b5750-e89b-12d3-a456-426614174000
The ID of the dispatch status change.
Example:157a16f0-503d-4256-ba60-a4876e8eb9bb
The date and time of the status change, in UTC/ISO 8601 format.
Example:2024-10-31T00:00:00Z
The status of the dispatch.
Example:PENDING_PICKUP
The ID of the cancellation reason.
Example:cac10000-e89b-12d3-a456-426614174000
Additional notes regarding the status change.
Example:Weather delay.
The party that submitted the status change e.g. SHIPPER or CARRIER.
Example:SHIPPER
The Central Dispatch user ID of the user who submitted the status change.
Example:3ca6e1c2-98fb-4b4e-bfd8-ffaec58fb347