Fulfillment API

PriceRequest

object

Details of the dispatch price.

totalPricenumber(double)

The total amount to be paid for completing the dispatch.

>= 0.01

Example:500

priceUnitsstring

The currency of totalPrice.

Default:USD

Example:USD

Example

RespondToDispatchRequest

object

Details of the respond request.

acceptboolean

Indicates whether the dispatch should be accepted or declined.

Example:true

inspectionAcknowledgedboolean

Indicates whether the require inspection requirement was acknoowledged.

Default:false

Example:true

carrierEstimatedPickupDatestring(date-time)

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

carrierEstimatedDeliveryDatestring(date-time)

The type of delivery date. Only the date portion of the value passed will be saved.

Example:2025-08-15T00:00:00.000Z

Example

SearchDispatchResult

object

Details of a dispatch search.

itemsarray[string]

A collection of dispatch IDs.

Example:d159acc0-e89b-12d3-a456-426614174000

countinteger(int32)

The maximum number of items to be returned in the response.

Example:1

totalRecordsinteger(int64)

The total count of resources in the collection.

Example:100

Example

SearchRequest

object

Details of search fields.

dispatchStatusarray[string]

A collection of: Dispatch statuses e.g. NEW, PENDING_DELIVERY, DELIVERED, PAID, REJECTED, CANCELED.

pickUpCityarray[string]

A collection of: The pick up city.

pickUpStatearray[string]

A collection of: The pick up state.

pickUpZiparray[string]

A collection of: The pick up ZIP code. Must be a valid United States ZIP code or Canadian postal code.

deliveryCityarray[string]

A collection of: The delivery city.

deliveryStatearray[string]

A collection of: The delivery state.

deliveryZiparray[string]

A collection of: The delivery ZIP code.

externalIdarray[string]

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.

dispatchIDstring

A collection of: The ID of the dispatch.

vinarray[string]

A collection of: The vehicle identification number (VIN).

driverIdarray[string]

A collection of: The Central Dispatch user ID of the driver.

shipperCompanyNamearray[string]

A collection of: The shipper’s company name.

shipperOrderIdarray[string]

A collection of: The ID of the shipper order.

marketPlaceIdsarray[string]

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.
externalCompanyIdsarray[string]

A collection of: The ID of the Central Dispatch customer who is shipping the vehicle.

externalCompanyNamesarray[string]

A collection of: The external company name.

externalVehicleIdsarray[string]

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.

loadIdarray[string]

A collection of: The load number.

carrierNamearray[string]

A collection of: The carrier name.

carrierIdarray[string]

A collection of: The ID of the Central Dispatch customer chosen by the shipper to move cars in the dispatch.

actualPickUpDateTimestring(date-time)

The actual pick up date and time, in UTC/ISO 8601 format.

actualDropOffDateTimestring(date-time)

The actual delivery date and time, in UTC/ISO 8601 format.

estimatedPickUpDateTimestring(date-time)

The estimated pick up date and time, in UTC/ISO 8601 format.

estimatedDropOffDateTimestring(date-time)

The estimated delivery date and time, in UTC/ISO 8601 format.

dispatchDateobject

Search dispatch date request.

Show Child Parameters
listingIdsobject

Search listing IDs information.

Show Child Parameters
dispatchIdsobject

Search dispatch IDs information.

Show Child Parameters
driverIdsobject

Driver IDs search.

Show Child Parameters
isCarrierArchivedboolean

Indicates if the carrier is archived.

isShipperArchivedboolean

Indicates if the shipper is archived.

Example

SortRequest

object

Details of search sort.

namestring

The name of the field to sort by.

Example:actualPickUpDateTime

directionstring

The direction of the sort. Values: ASCENDING, DESCENDING.

Example:ASCENDING

Example