Get Listings (Batch)

Path Parameters

idinteger(int64)required

Example:42220470

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 2.x.x of an API, the Content-Type header should be set to application/vnd.coxauto.v2+json.

Example:application/vnd.coxauto.v2+json

Body

application/json

ListingRequest

ListingRequest

Details of a listing.

shipperOrderIdstring | null

The ID of the shipper order.

<= 50 characters

Example:123-abc 900

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.

<= 50 characters

Example:RND10 CHEV

trailerTypestring

The trailer type.

Allowed values:DRIVEAWAYENCLOSEDOPEN

Default:OPEN

Example:OPEN

hasInOpVehicleboolean

Indicates whether the vehicle is inoperable.

Default:true

Example:false

loadSpecificTermsstring | null

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.

<= 500 characters

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

requiresInspectionboolean | null

Indicates the shipper requests for the carrier to use the Central Dispatch Mobile App to perform vehicle inspection at pickup and delivery. If true, the carrier will be asked to acknowledge the request before accepting the load.

Default:false

Example:true

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

availableDatestring(date-time)

The available date of the listing, in UTC/ISO 8601 format. Must not be before today or later than 30 days from today.

Example:2025-02-20T00:00:00Z

expirationDatestring | null(date-time)

The expiration date of the listing, in UTC/ISO 8601 format. Must not be before today or later than 30 days from today. Will default to after creation date if not supplied.

Example:2025-03-10T00:00:00Z

desiredDeliveryDatestring | null(date-time)

The desired delivery date of the listing, in UTC/ISO 8601 format. Must be equal or greater than availableDate and not before today or later than 30 days from today (optional).

Example:2025-03-04T00:00:00Z

partnerReferenceIdstring | null

A user supplied ID used for reference.

<= 50 characters

Example:969175d4-a3f8-4e43-b64f-a95d77475aa0

priceobject

Details of the price.

Show Child Parameters

slaobject

Details of the service level agreement (SLA) for a listing. Only required for listings in marketplaces allowing digital offers. Currently only applicable to private marketplaces.

Show Child Parameters

stopsarray[object]

Details of a stop.

Show Child Parameters

vehiclesarray[object]

Details of a vehicle.

Show Child Parameters

marketplacesarray[object]

Details of a marketplace.

Show Child Parameters

tagsarray | null[object]

Details of a tag.

Show Child Parameters

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.

Response

No Content. Successful request.

put/listings/id/{id}

Authentication

Path Parameters

Query Parameters

Headers

Body

{ "shipperOrderId": "123-abc 900", "externalId": "RND10 CHEV", "trailerType": "OPEN", "loadSpecificTerms": "Charging cables need to be picked up with vehicles and if left behind a $200 fee will be applied.", "availableDate": "2025-02-20T00:00:00Z", "expirationDate": "2025-03-10T00:00:00Z", "desiredDeliveryDate": "2025-03-10T00:00:00Z", "partnerReferenceId": "ORD-2023-0001", "price": { "total": 500, "cod": { "amount": 200, "paymentMethod": "CASH_CERTIFIED_FUNDS", "paymentLocation": "PICKUP" }, "balance": { "amount": 300, "paymentTime": "IMMEDIATELY", "balancePaymentMethod": "CASH", "balancePaymentTermsBeginOn": "PICKUP" } }, "sla": { "duration": "P2D", "timeZoneOffset": "-7:00", "rolloverTime": "19:00:00", "includeCurrentDayAfterRollOver": true }, "stops": [ { "stopId": "4e2efc84-6add-435c-9f12-8b19e3e5ba21", "stopNumber": 1, "locationName": "ABC Cars lot", "address": "345 W Elm St.", "city": "Anaheim", "state": "CA", "postalCode": "92802", "country": "US", "phone": "949-555-1323", "contactName": "Mickey Smith", "contactPhone": "949-555-2434", "geoCode": { "longitude": -117.91836265987132, "latitude": 33.81228788622535 }, "locationType": "Dealership" }, { "stopId": "9b6e0fad-8722-4da1-907c-f9522c04ef12", "stopNumber": 2, "locationName": "XYZ Inc.", "address": "255 Sands Ave.", "city": "Las Vegas", "state": "NV", "postalCode": "89169", "country": "US", "phone": "702-555-0101", "contactName": "Dean Vega", "contactPhone": "702-555-1212", "geoCode": { "longitude": -115.16195281104913, "latitude": 36.121343020081525 }, "locationType": "Dealership" } ], "vehicles": [ { "pickupStopNumber": 1, "dropoffStopNumber": 2, "vehicleId": "b331c130-e89b-12d3-a456-426614174000", "externalVehicleId": "EXT123456", "vin": "KL8CH6SA6NC001234", "year": 2022, "make": "Chevrolet", "model": "Spark", "trim": "LS", "vehicleType": "CAR", "color": "Red", "licensePlate": "B314PIE", "lotNumber": "LOT789", "isInoperable": false, "tariff": 1030.5, "additionalInfo": "The vehicle is in the back of the lot behind the big tree.", "shippingSpecs": { "height": 58, "width": 62, "length": 143, "weight": 2246 } } ], "marketplaces": [ { "priorityId": 1, "marketplaceId": 10000, "digitalOffersEnabled": true, "searchable": true, "offersAutoAcceptEnabled": true, "autoDispatchOnOfferAccepted": true, "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.", "customersExcludedFromOffers": [ "157a16f0-503d-4256-ba60-a4876e8eb9bb" ] } ], "tags": [ { "name": "The number one", "value": "1d1d1d1d-e89b-12d3-a456-426614174000" } ], "transportationReleaseNotes": "You will need special clearance to get in the lot. Call Jean at 303-999-1212." }

Path Parameters

idinteger(int64)required

Example:42220470

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 2.x.x of an API, the Accept header should be set to application/vnd.coxauto.v2+json.

Example:application/vnd.coxauto.v2+json

Response

No Content. Successful request.

delete/listings/id/{id}

Authentication

Path Parameters

Query Parameters

Headers

Body

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 2.x.x of an API, the Content-Type header should be set to application/vnd.coxauto.v2+json.

Example:application/vnd.coxauto.v2+json

Body

application/json

An array of listing IDs and/or listing URLs.

array[string]

Response

application/json

OK. Successful request.

ListingCollection

A collection of listings.

hrefstring

The URL used to query the current collection of the resource.

Example:https://marketplace-api.centraldispatch.com/listings?limit(5,1)

countinteger(int32)

The total count of resources in the collection.

Example:23

itemsarray[object]

Details of a listing.

Show Child Parameters

post/listings/batch

Authentication

Path Parameters

Query Parameters

Headers

Body

[ "42220470", "300040271" ]

application/json

Get a collection of listings that belong to the calling customer.

👥 Customer Type

Shipper

🔍 Allowed Search Criteria

partnerReferenceId: A user supplied ID used for reference.
externalId: 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.
shipperOrderId: The ID of the shipper order.

📝 Important Notes

Be sure to URL encode any parameters that contain spaces or special characters.
Results will be paginated. Navigate through the results using the next value.

</> Example

curl -X GET https://api.centraldispatch.com/listings/mine?limit(1,10)%partnerReferenceId=12345

get

https://marketplace-api.centraldispatch.com/listings/mine

Query Parameters

limit(1,2)string

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

1 = The record number to start with, 1-based integer, default 1.
2 = number of results to return, integer, default 25, maximum 500.

Example:limit(1,10)

partnerReferenceIdstring

A user supplied ID used for reference.

<= 50 characters

Example:25-KL8CH6

externalIdstring

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.

<= 50 characters

Example:RND10 CHEV

shipperOrderIdstring

The ID of the shipper order.

<= 50 characters

Example:123-abc 900

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 2.x.x of an API, the Accept header should be set to application/vnd.coxauto.v2+json.

Example:application/vnd.coxauto.v2+json

Response

application/json

OK. Successful request.

ListingCollection

A collection of listings.

hrefstring

The URL used to query the current collection of the resource.

Example:https://marketplace-api.centraldispatch.com/listings?limit(5,1)

countinteger(int32)

The total count of resources in the collection.

Example:23

itemsarray[object]

Details of a listing.

Show Child Parameters

get/listings/mine

Authentication

Path Parameters

Query Parameters

Headers

Body

application/json

Get the vehicles in listings that belong to the calling customer.

👥 Customer Type

Shipper

🔍 Allowed Search Criteria

externalVehicleId: 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.
listingId: The ID of the listing.

📝 Important Notes

Be sure to URL encode any parameters that contain spaces or special characters.
Results will be paginated. Navigate through the results using the next value.

</> Example

curl -X GET https://api.centraldispatch.com/listing-vehicles/mine?limit(1,10)%listingId=400000000

get

https://marketplace-api.centraldispatch.com/listing-vehicles/mine

Query Parameters

limit(1,2)string

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

1 = The record number to start with, 1-based integer, default 1.
2 = number of results to return, integer, default 25, maximum 500.

Example:limit(1,10)

externalVehicleIdstring

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.

Example:EXT123456

listingIdstring

The ID of the listing.

Example:42220470

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 2.x.x of an API, the Accept header should be set to application/vnd.coxauto.v2+json.

Example:application/vnd.coxauto.v2+json

Response

application/json

OK. Successful request.

VehicleCollection

A paginated collection of vehicles.

hrefstring

The URL used to query the current collection of the resource.

Example:https://marketplace-api.centraldispatch.com/listing-vehicles/mine?limit(5,1)

itemsarray[object]

Details of a vehicle.

Show Child Parameters

limitinteger(int32)

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

Example:1

nextstring | null

The URL to the next page of the collection, if available.

Example:https://marketplace-api.centraldispatch.com/listing-vehicles/mine?limit(5,1)

previousstring | null

The URL to the previous page of the collection, if available.

Example:https://marketplace-api.centraldispatch.com/listing-vehicles/mine?limit(6,1)

firststring | null

The URL to the first page of the collection.

Example:https://marketplace-api.centraldispatch.com/listing-vehicles/mine?limit(1,1)

countinteger(int32)

The total count of resources in the collection.

Example:23

get/listing-vehicles/mine

Authentication

Path Parameters

Query Parameters

Headers

Body

application/json

Update Listing

👥 Customer Type

📝 Important Notes

Path Parameters

Headers

Body

ListingRequest

Response

Authentication

Path Parameters

Query Parameters

Headers

Body

Delete Listing

👥 Customer Type

Path Parameters

Headers

Response

Authentication

Path Parameters

Query Parameters

Headers

Body

👥 Customer Type

Headers

Body

Response

ListingCollection

Authentication

Path Parameters

Query Parameters

Headers

Body

Get My Listings

👥 Customer Type

🔍 Allowed Search Criteria

📝 Important Notes

</> Example

Query Parameters

Headers

Response

ListingCollection

Authentication

Path Parameters

Query Parameters

Headers

Body

Get My Vehicles

👥 Customer Type

🔍 Allowed Search Criteria

📝 Important Notes

</> Example

Query Parameters

Headers

Response

VehicleCollection

Authentication

Path Parameters

Query Parameters

Headers

Body