Search
K
Fulfillment API

Create Dispatch from Canceled Dispatch

Create a new dispatch by copying information from a canceled dispatch.

👥 Customer Type

  • Shipper

📝 Important Notes

  • All information from the canceled dispatch will be copied to the new dispatch.
  • A new dispatch ID will be generated automatically.
  • The response will contain a Location header that contains the fully qualified URL of the newly created resource. The final segment of the URL will be the ID of the resource.
  • The response will include an ETag header, which should be used for the If-Match header in subsequent updates.
post
https://fulfillment-api.centraldispatch.com/api/fulfillments/dispatches/ref/dispatches/id/{dispatchId}

Path Parameters

dispatchIdstring(uuid)required

The ID of the canceled dispatch to be copied from.

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

Headers

Content-Typestringrequired

The major version of the API to make a request against. This is a custom MIME type that contains vnd.coxauto.v[#]+. For example, to request a resource from version 1.x.x of an API, the Content-Type header should be set to application/vnd.coxauto.v1+json.

Example:application/vnd.coxauto.v1+json

Body

application/json

CreateDispatchFromCanceledDispatchRequest

CreateDispatchFromCanceledDispatchRequest

Details of model for creating a dispatch request from an existing dispatch.

marketplaceIdinteger | null

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

externalIdstring | null

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

externalOrderIdstring | null

The identifier of the order that created the dispatch in the shipper system managed by the user.

Example:ORD-2023-0001

carrierIdstring(uuid)

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

shipperRequestedPickUpDatestring

The date the shipper would like the vehicle to be picked up, in UTC/ISO 8601 format.

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

shipperRequestedDropOffDatestring

The date the shipper would like the vehicle to be picked up, in UTC/ISO 8601 format.

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

priceobject

Details of dispatch price.

Show Child Parameters
instructionsstring | null

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.

preDispatchNotesstring | null

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.

transportationReleaseNotesstring | null

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.

additionalInformationarray | null[object]

Details of additional information.

Show Child Parameters

Response

Created. Successful request.

post/api/fulfillments/dispatches/ref/dispatches/id/{dispatchId}

Body

{ "marketplaceId": 10000, "externalId": "RND10 CHEV", "externalOrderId": "ORD-2023-0001", "carrierId": "0ca91a43-fbee-4c05-9a6c-aa5c63888f5c", "shipperRequestedPickUpDate": "2025-11-05T00:00:00.000Z", "shipperRequestedDropOffDate": "2025-07-15T00:00:00.000Z", "price": { "total": 500, "currency": "USD", "cod": { "amount": 200, "paymentMethod": "CASH_CERTIFIED_FUNDS", "paymentLocation": "PICKUP" }, "balance": { "amount": 300, "paymentTime": "IMMEDIATELY", "balancePaymentTermsBeginOn": "PICKUP", "balancePaymentMethod": "CASH" } }, "additionalInformation": [ { "name": "1d1d1d1d-e89b-12d3-a456-426614174000", "value": "The number one" } ] }
 

Get Dispatch

Get a dispatch by ID.

📝 Important Notes

  • The ID of the resource is returned in resource’s create endpoint. The response will contain a Location header that contains the fully qualified URL of the newly created resource. The final segment of the URL will be the ID of the resource.
  • The response will include an ETag header, which should be used for the If-Match header in subsequent updates.
get
https://fulfillment-api.centraldispatch.com/api/fulfillments/id/{dispatchId}

Query Parameters

includeChangesboolean

Indicates whether the response should include change records (dispatch status change and additional information records with the dispatch and dispatch vehicle status change and dispatch vehicle date change records with the dispatch vehicle).

Default:false

Example:true

Path Parameters

dispatchIdstring(uuid)required

The ID of the dispatch.

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

Headers

Acceptstringrequired

The major version of the API to make a request against. This is a custom MIME type that contains vnd.coxauto.v[#]+. For example, to request a resource from version 1.x.x of an API, the Accept header should be set to application/vnd.coxauto.v1+json.

Example:application/vnd.coxauto.v1+json

Response

application/json

OK. Successful request.

DispatchResponse

Details of a dispatch.

vehiclesarray[object]

Dispatch vehicle details.

Show Child Parameters
stopsarray[object]

Details of a stop.

Show Child Parameters
dispatchStatusChangesarray | null[object]

Details of a status change.

Show Child Parameters
additionalInformationarray | null[object]

Details of additional information.

Show Child Parameters
dispatchDriversobject | null

Details of the drivers.

Show Child Parameters
createdDateUtcstring

The date and time the dispatch was created, in UTC/ISO 8601 format.

Example:2024-08-01T00:00:00Z

lastUpdatedDateUtcstring | null

The date and time the dispatch was last updated, in UTC/ISO 8601 format.

Example:2024-10-15T00:00:00Z

lastUpdatedBystring | null

The Central Dispatch user ID of the user who last updated the dispatch.

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

dispatchIdstring(uuid)

The ID of the dispatch.

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

priceTotalnumber(double)

The total amount to be paid for completing the dispatch.

Example:500

priceTotalCurrencystring

The currency of priceTotal.

Example:USD

hrefstring

The fully qualified URL of the dispatch.

Example:https://fulfillment-api.centraldispatch.com/api/fulfillments/id/d159acc0-e89b-12d3-a456-426614174000

shipmentDescriptionIdstring(uuid)

The ID of the shipment description.

Example:519e0000-e89b-12d3-a456-426614174000

recordVersionstring

The version of the record which should be used for the If-Match header on updates.

Example:1234567

externalIdstring | null

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

externalCompanyIdstring(uuid)

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

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

carrierIdstring(uuid)

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

Example:0ca91a43-fbee-4c05-9a6c-aa5c63888f5c

listingIdstring | null

The ID of the listing from which the dispatch was created.

Example:42220470

loadNumberinteger(int32)

The load number.

Example:987123

marketplaceIdinteger(int32)

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

shipperOrderIdstring | null

The ID of the shipper order.

Example:123-abc 900

instructionsstring | null

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.

codAmountnumber(double)

The cash on delivery (COD) or cash on pick up (COP) amount due.

Example:200

codAmountCurrencystring

The currency of codAmount.

Example:USD

codPaymentMethodstring | null

The method for the COD/COP payment.

Allowed values:CHECKCASH_CERTIFIED_FUNDS

Example:CASH_CERTIFIED_FUNDS

codPaymentLocationstring | null

The location that COD/COP payment is due.

Allowed values:PICKUPDELIVERY

Example:PICKUP

balanceAmountnumber(double)

The balance amount that will be due after the COD/COP payment is applied.

Example:300

balanceAmountCurrencystring | null

The currency of balanceAmount.

Example:USD

balancePaymentTimestring | null

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

balancePaymentTermsBeginOnstring | null

The terms for beginning balance payment.

Allowed values:PICKUPDELIVERYRECEIVING_SIGNED_BOL

Example:PICKUP

balancePaymentMethodstring | null

The payment method with which the balance due payment will be paid.

Allowed values:CASHCERTIFIED_FUNDSCOMPANY_CHECKCOMCHEKTCH

Example:CASH

statusstring

The status of the dispatch.

Example:PENDING_PICKUP

createdBystring(uuid)

The Central Dispatch user ID of the user who created the dispatch.

Example:157a16f0-503d-4256-ba60-a4876e8eb9bb

preDispatchNotesstring | null

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.

transportationReleaseNotesstring | null

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.

dispatchSourcestring | null

The source of the dispatch. Values: API, Web, ListingWeb.

Example:API

contractTermsstring | null

Terms of the legal contract between the shipper and the carrier.

Example:Nulla poena sine lege.

isCanceledBeforeAcceptboolean

Indicates that the dispatch was canceled before it was accepted.

Example:true

requiresDriverVerificationAtPickupboolean

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

get/api/fulfillments/id/{dispatchId}
 
application/json

Get Dispatches (Batch)

Get a collection of dispatches for the provided dispatch IDs or URLs

post
https://fulfillment-api.centraldispatch.com/api/fulfillments/batch

Query Parameters

includeChangesboolean

Indicates whether the response should include change records (dispatch status change and additional information records with the dispatch and dispatch vehicle status change and dispatch vehicle date change records with the dispatch vehicle).

Default:false

Example:true

Headers

Content-Typestringrequired

The major version of the API to make a request against. This is a custom MIME type that contains vnd.coxauto.v[#]+. For example, to request a resource from version 1.x.x of an API, the Content-Type header should be set to application/vnd.coxauto.v1+json.

Example:application/vnd.coxauto.v1+json

Body

application/json

An array of dispatch IDs and/or dispatch URLs.

array | null[string]

Response

application/json

OK. Successful request.

DispatchCollection

A collection of dispatches.

hrefstring

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

countinteger(int32)

The total count of resources in the collection.

Example:23

itemsarray[object]

Details of a dispatch.

Show Child Parameters
post/api/fulfillments/batch

Body

[ "d159acc0-e89b-12d3-a456-426614174000", "157a16f0-503d-4256-ba60-a4876e8eb9bb" ]
 
application/json

Search Dispatches

Get a collection of dispatch IDs based on the specified search criteria.

📝 Important Notes

  • If calling as a broker the X-Profile-Type header must be included to distinguish between calling as a dealer or carrier.
  • Possible values: carrier, dealer.
post
https://fulfillment-api.centraldispatch.com/api/fulfillments/search

Headers

X-Profile-Typestring

Required when calling as a broker, use to specify the caller’s role. The value must be either carrier or shipper. Default is shipper

Example:carrier

Content-Typestringrequired

The major version of the API to make a request against. This is a custom MIME type that contains vnd.coxauto.v[#]+. For example, to request a resource from version 1.x.x of an API, the Content-Type header should be set to application/vnd.coxauto.v1+json.

Example:application/vnd.coxauto.v1+json

Body

application/json

DispatchSearchRequest

DispatchSearchRequest

Details of the dispatch search.

searchFieldsobject

Details of search fields.

Show Child Parameters
offsetinteger

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

limitinteger | null

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

sortFieldsarray | null[object]

Details of search sort.

Show Child Parameters

Response

application/json

OK. Successful request.

SearchDispatchResult

Details of a dispatch search.

itemsarray | null[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

post/api/fulfillments/search

Body

{ "searchFields": { "dispatchStatus": [ "PENDING_PICKUP", "DELIVERED" ], "dispatchDate": { "op": "RANGE", "startDateTime": "2024-08-01T00:00:00Z", "endDateTime": "2024-09-10T00:00:00Z" } }, "sortFields": [ { "name": "actualPickUpDateTime", "direction": "ASCENDING" }, { "name": "estimatedDropOffDateTime", "direction": "ASCENDING" }, { "name": "needAction", "direction": "DESCENDING" } ], "limit": 10, "offset": 0 }
 
application/json

Update Dispatch

Update an existing dispatch.

📝 Important Notes

  • Every desired property must be sent, null properties will be deleted.
  • The If-Match header is required and its value can be found in the ETag response header of the resource’s GET by ID endpoint.
  • The ID of the resource is returned in resource’s create endpoint. The response will contain a Location header that contains the fully qualified URL of the newly created resource. The final segment of the URL will be the ID of the resource.
post
https://fulfillment-api.centraldispatch.com/api/fulfillments/update

Headers

If-Matchintegerrequired

This is a required field to ensure the update is being completed on an item that has not changed since it was last read. The value of this field will be the value of the ETag header that was received on the preceding get call.

Example:8675309

Content-Typestringrequired

The major version of the API to make a request against. This is a custom MIME type that contains vnd.coxauto.v[#]+. For example, to request a resource from version 1.x.x of an API, the Content-Type header should be set to application/vnd.coxauto.v1+json.

Example:application/vnd.coxauto.v1+json

Body

application/json

UpdateDispatchRequest

UpdateDispatchRequest

Details of a dispatch.

dispatchIdstring(uuid)

The ID of the dispatch.

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

externalOrderIdstring | null

The identifier of the order that created the dispatch in the shipper system managed by the user.

Example:ORD-2023-0001

externalIdstring | null

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

priceobject

Details of the dispatch price.

Show Child Parameters
stopsarray[object]

Details of a stop.

Show Child Parameters
vehiclesarray[object]

Details of a vehicle.

Show Child Parameters
additionalInformationarray | null[object]

Details of additional information.

Show Child Parameters
balanceAmountnumber(double)

The balance amount that will be due after the COD/COP payment is applied.

>= 0

Example:300

balanceAmountCurrencystring | null

The currency of balanceAmount.

Default:USD

Example:USD

balancePaymentMethodstring | null

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

balancePaymentTermsBeginOnstring | null

The terms for beginning balance payment. Required if balanceAmount is greater than 0.

Allowed values:PICKUPDELIVERYRECEIVING_SIGNED_BOL

Example:PICKUP

balancePaymentTimestring | null

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

codAmountnumber(double)

The cash on delivery (COD) or cash on pick up (COP) amount due.

>= 0

Example:200

codAmountCurrencystring | null

The currency of codAmount.

Default:USD

Example:USD

codPaymentLocationstring | null

The location that COD/COP payment is due. Required if codAmount is greater than 0.

Allowed values:PICKUPDELIVERY

Example:PICKUP

codPaymentMethodstring | null

The method for the COD/COP payment. Required if codAmount is greater than 0.

Allowed values:CHECKCASH_CERTIFIED_FUNDS

Example:CASH_CERTIFIED_FUNDS

instructionsstring | null

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.
Note: The original instructions value must be sent in any update request. If a different value is provided, the update will be rejected with status code 422 Unprocessable Entity.

Example:Charging cables need to be picked up with vehicles and if left behind a $200 fee will be applied.

preDispatchNotesstring | null

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.
Note: The original preDispatchNotes value must be sent in any update request. If a different value is provided, the update will be rejected with status code 422 Unprocessable Entity.

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.

transportationReleaseNotesstring | null

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.

requiresDriverVerificationAtPickUpboolean | null

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

Response

No Content. Successful request.

post/api/fulfillments/update

Body

{ "dispatchId": "d159acc0-e89b-12d3-a456-426614174000", "externalId": "RND10 CHEV", "externalOrderId": "ORD-2023-0001", "price": { "totalPrice": 500, "priceUnits": "USD" }, "codAmount": 200, "codAmountCurrency": "USD", "codPaymentMethod": "CASH_CERTIFIED_FUNDS", "codPaymentLocation": "PICKUP", "balanceAmount": 300, "balanceAmountCurrency": "USD", "balancePaymentTime": "IMMEDIATELY", "balancePaymentTermsBeginOn": "PICKUP", "balancePaymentMethod": "CASH", "preDispatchNotes": "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.", "transportationReleaseNotes": "You will need special clearance to get in the lot. Call Jean at 303-999-1212.", "stops": [ { "stopNumber": 1, "stopType": "DEALER", "name": "ABC Cars lot", "address": { "address1": "345 W Elm St.", "address2": "2nd Floor", "city": "Anaheim", "state": "CA", "zipCode": "92802", "countryCode": "US" }, "contact": { "name": "Mickey Smith", "phone": "949-555-0101", "phone1": "949-555-1323", "phone2": "949-555-2434", "phone3": "949-555-3545", "cellPhone": "949-555-1212", "email": "mickey@snoogle.com" }, "externalLocationId": "Loc123", "isTWIC": true, "siteId": "ABC", "latitude": "33.81228788622535", "longitude": "-117.91836265987132", "buyerNumber": "12345" }, { "stopNumber": 2, "stopType": "COMMERCIAL_BUSINESS", "name": "XYZ Inc.", "address": { "address1": "255 Sands Ave.", "city": "Las Vegas", "state": "NV", "zipCode": "89169", "countryCode": "US" }, "contact": { "name": "Dean Vega", "phone": "702-555-0101", "phone2": "702-555-0101", "cellPhone": "702-555-1212", "email": "dvega@doogle.com" }, "externalLocationId": "Loc777", "isTWIC": true, "siteId": "Spere", "latitude": "36.121343020081525", "longitude": "-115.16195281104913", "buyerNumber": "9876" } ], "vehicles": [ { "vehicleAttributes": [ { "type": "damage", "name": "hasKeys", "value": false } ], "vehicleId": "b331c130-e89b-12d3-a456-426614174000", "externalVehicleId": "EXT123456", "vin": "KL8CH6SA6NC001234", "distance": 267, "distanceUnits": "MILES", "pickUpLocationId": 1, "dropOffLocationId": 2, "carrierPrice": 500, "carrierPriceUnits": "USD", "type": "CAR", "size": "MEDIUM", "shipperRequestedPickupDate": "2025-09-30T00:00:00.000Z", "shipperRequestedDropOffDate": "2025-10-15T00:00:00.000Z", "color": "Red", "isInOperable": false, "isEnclosed": true, "year": 2022, "make": "Chevrolet", "model": "Spark", "subModel": "ACTIV", "weight": 2246, "weightUnits": "lbs", "inspectionType": "ART", "isDriveAway": false, "licensePlate": "B314PIE", "licensePlateState": "CA", "lotNumber": "LOT789", "additionalInformation": "The vehicle is in the back of the lot behind the big tree.", "pickUpDateType": "NO_EARLIER_THAN", "dropOffDateType": "ESTIMATED" } ], "additionalInformation": [ { "name": "1d1d1d1d-e89b-12d3-a456-426614174000", "value": "The number one" } ] }