CarrierRequest
objectDetails of a carrier.
The ID of the Central Dispatch customer chosen by the shipper to move cars in the dispatch. The carrier must belong to the Marketplace identified by the marketplaceId
and have a tier group of BROKER
or CARRIER
.
Example:0ca91a43-fbee-4c05-9a6c-aa5c63888f5c
CodRequest
objectDetails of cash of delivery or cash on payment (COD/COP).
The cash on delivery (COD) or cash on pick up (COP) amount due.
>= 0
Example:200
The method for the COD/COP payment. Required if amount
is greater than 0.
Allowed values:CHECKCASH_CERTIFIED_FUNDS
Example:CASH_CERTIFIED_FUNDS
The location that COD/COP payment is due. Required if amount
is greater than 0.
Allowed values:PICKUPDELIVERY
Example:PICKUP
ContactRequest
objectDetails of a contact.
The name of the contact.
Example:Mickey Smith
The primary phone number of the contact.
Example:949-555-0101
An additional phone number of the contact.
Example:949-555-1323
An additional phone number of the contact.
Example:949-555-2434
An additional phone number of the contact.
Example:949-555-3545
The cell phone number of the contact.
Example:949-555-1212
The email address of the contact. Must be a valid email address format.
Example:mickey@snoogle.com
CreateDispatchFromCanceledDispatchPriceRequest
objectDetails of dispatch price.
The total amount to be paid for completing the dispatch.
>= 0.01
Example:500
The currency of total
.
Default:USD
Example:USD
Details of cash of delivery or cash on payment (COD/COP).
Show Child Parameters
Details of a dispatch balance.
Show Child Parameters
CreateDispatchFromCanceledDispatchRequest
objectDetails of model for creating a dispatch request from an existing dispatch.
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.
Example:10000
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.
Example:RND10 CHEV
The identifier of the order that created the dispatch in the shipper system managed by the user.
Example:ORD-2023-0001
The ID of the Central Dispatch customer chosen by the shipper to move cars in the dispatch. The carrier must belong to the Marketplace identified by the marketplaceId
and have a tier group of BROKER
or CARRIER
.
Example:0ca91a43-fbee-4c05-9a6c-aa5c63888f5c
The date the shipper would like the vehicle to be picked up, in UTC/ISO 8601 format.
Example:2025-07-15T00:00:00.000Z
The date the shipper would like the vehicle to be picked up, in UTC/ISO 8601 format.
Example:2025-08-15T00:00:00.000Z
Details of dispatch price.
Show Child Parameters
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.
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.
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.
Details of additional information.