CreateDispatchRequest
objectDetails of a dispatch.
If creating from a listing, the ID of the listing that this dispatch is created from.
Example:42220470
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
Details of a carrier.
Show Child Parameters
The identifier of the order that created the dispatch in the shipper system managed by the user.
Example:ORD-2023-0001
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: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.
Details of the dispatch price.
Show Child Parameters
Details of a stop.
Show Child Parameters
Details of a vehicle.
Show Child Parameters
Details of additional information.
Show Child Parameters
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.
Allowed values:CASHCERTIFIED_FUNDSCOMPANY_CHECKCOMCHEKTCH
Example:CASH
The terms for beginning balance payment. Required if balanceAmount is greater than 0.
Allowed values:PICKUPDELIVERYRECEIVING_SIGNED_BOL
Example:PICKUP
The time frame when the balance payment is due. Required if balanceAmount is greater than 0.
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.
Allowed values:PICKUPDELIVERY
Example:PICKUP
The method for the COD/COP payment. Required if codAmount is greater than 0.
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.
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.
<= 4000 characters
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.
<= 4000 characters
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
DateChangeReasonCollection
objectDetails of a collection of items with ID and Name pairs.
Details of the date change reason.
Show Child Parameters
DateChangeReasonResponse
objectDetails of the date change reason.
The ID of the date change reason.
Example:da1e0000-e89b-12d3-a456-426614174000
The name of the date change reason.
Example:Mechanical issues with carrier's truck
DateSearchRequest
objectSearch dispatch date request.
The operation type for the date comparison. Values: RANGE, EQ, NEQ.
Example:RANGE
The start date and time, in UTC/ISO 8601 format.
The end date and time, in UTC/ISO 8601 format. Required for RANGE and must be equal or greater than startDateTime.
DispatchCollection
objectA 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.