DispatchIdsSearchRequest
objectSearch dispatch IDs information.
The operator to use. Values: EQ, NEQ.
Example:EQ
A collection of dispatch IDs.
Example:d159acc0-e89b-12d3-a456-426614174000, 157a16f0-503d-4256-ba60-a4876e8eb9bb
DispatchResponse
objectDetails of a dispatch.
Dispatch vehicle details.
Show Child Parameters
Details of a stop.
Show Child Parameters
Details of a status change.
Show Child Parameters
Details of additional information.
Show Child Parameters
Details of the drivers.
Show Child Parameters
The date and time the dispatch was created, in UTC/ISO 8601 format.
Example:2024-08-01T00:00:00Z
The date and time the dispatch was last updated, in UTC/ISO 8601 format.
Example:2024-10-15T00:00:00Z
The Central Dispatch user ID of the user who last updated the dispatch.
Example:d71b5750-e89b-12d3-a456-426614174000
The ID of the dispatch.
Example:d159acc0-e89b-12d3-a456-426614174000
The total amount to be paid for completing the dispatch.
Example:500
The currency of priceTotal.
Example:USD
The fully qualified URL of the dispatch.
Example:https://fulfillment-api.centraldispatch.com/api/fulfillments/id/d159acc0-e89b-12d3-a456-426614174000
The ID of the shipment description.
Example:519e0000-e89b-12d3-a456-426614174000
The version of the record which should be used for the If-Match header on updates.
Example:1234567
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 ID of the Central Dispatch customer who is shipping the vehicle.
Example:e8560000-e89b-12d3-a456-426614174000
The ID of the Central Dispatch customer chosen by the shipper to move cars in the dispatch.
Example:0ca91a43-fbee-4c05-9a6c-aa5c63888f5c
The ID of the listing from which the dispatch was created.
Example:42220470
The load number.
Example:987123
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
The ID of the shipper order.
Example:123-abc 900
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.
The cash on delivery (COD) or cash on pick up (COP) amount due.
Example:200
The currency of codAmount.
Example:USD
The method for the COD/COP payment.
Allowed values:CHECKCASH_CERTIFIED_FUNDS
Example:CASH_CERTIFIED_FUNDS
The location that COD/COP payment is due.
Allowed values:PICKUPDELIVERY
Example:PICKUP
The balance amount that will be due after the COD/COP payment is applied.
Example:300
The currency of balanceAmount.
Example:USD
The time frame when the balance payment is due.
Allowed values:IMMEDIATELYTWO_BUSINESS_DAYS_QUICK_PAYFIVE_BUSINESS_DAYSTEN_BUSINESS_DAYSFIFTEEN_BUSINESS_DAYSTHIRTY_BUSINESS_DAYS
Example:IMMEDIATELY
The terms for beginning balance payment.
Allowed values:PICKUPDELIVERYRECEIVING_SIGNED_BOL
Example:PICKUP
The payment method with which the balance due payment will be paid.
Allowed values:CASHCERTIFIED_FUNDSCOMPANY_CHECKCOMCHEKTCH
Example:CASH
The status of the dispatch.
Example:PENDING_PICKUP
The Central Dispatch user ID of the user who created the dispatch.
Example:157a16f0-503d-4256-ba60-a4876e8eb9bb
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.
The source of the dispatch. Values: API, Web, ListingWeb.
Example:API
Terms of the legal contract between the shipper and the carrier.
Example:Nulla poena sine lege.
Indicates that the dispatch was canceled before it was accepted.
Example:true
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).
Example:true
DispatchSearchRequest
objectDetails of the dispatch search.
Details of search fields.
Show Child Parameters
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.
Show Child Parameters
DriverPatchRequest
objectDetails of driver patch operation.
The Central Dispatch user ID of the driver.
Example:d71b5750-e89b-12d3-a456-426614174000
DriverSearchRequest
objectDriver IDs search.
The operation type for the driver IDs. Values: EQ, NEQ.
Example:EQ
A collection of driver ID values.
Example:d71b5750-e89b-12d3-a456-426614174000, 3ca6e1c2-98fb-4b4e-bfd8-ffaec58fb347