Search
K
Listings API V1

Listings API

1.0.0OAS 3.0

Central Dispatch’s Listings API allows customers to create, retrieve, update, and manage vehicle shipment listings on the marketplace.
🔑 Scope: marketplace

🚨🚨🚨 If you are a new integator, please use Listings API V2. 🚨🚨🚨

API Base URL
  • Server 1:https://marketplace-api.centraldispatch.com

    Production server

Security
Bearer (http)

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123

Additional Information
Contact (datasyndicationsupport@centraldispatch.com)

Create Listing

Create a listing.

👥 Customer Type

  • Shipper

📝 Important Notes

  • 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://marketplace-api.centraldispatch.com/listings

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

Listing

Listing

Details of a listing.

originobject

Details of a location.

Show Child Parameters
destinationobject

Details of a location.

Show Child Parameters
distanceinteger | null(int32)

The total travel distance.

Example:267

additionalInfostring | null

Additional information.

<= 60 characters

Example:The vehicle is in the back of the lot behind the big tree.

shipperOrderIdstring | null

The ID of the shipper order.

<= 50 characters

Example:123-abc 900

trailerTypestring

The vehicle trailer type.

Allowed values:OPENENCLOSEDDRIVEWAY

Example:OPEN

hasInOpVehicleboolean

Indicates if listing includes a vehicle that is inoperable.

Default:false

Example:false

vehiclesarray[object]

Details of a vehicle.

Show Child Parameters
availableDatestring

The available date of the listing, in UTC/ISO 8601 format.

Example:2025-11-05T00:00:00.000Z

desiredDeliveryDatestring | null

The desired delivery date of the listing, in UTC/ISO 8601 format.

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

priceobject

Details of the price.

Show Child Parameters
partnerReferenceIdstring | null

A user supplied ID used for reference.

Example:3fde6068-5fa2-4ae4-af16-06d65fc87dc9

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

Response

Created. Successful request.

post/listings

Body

{ "trailerType": "OPEN", "availableDate": "2025-11-05T00:00:00.000Z", "price": { "total": 500, "cod": { "amount": 200, "paymentMethod": "CASH_CERTIFIED_FUNDS", "paymentLocation": "PICKUP" }, "balance": { "amount": 300, "balancePaymentMethod": "CASH", "paymentTime": "IMMEDIATELY", "balancePaymentTermsBeginOn": "PICKUP" } }, "origin": { "city": "Anaheim", "state": "CA", "zip": "92802" }, "destination": { "city": "Las Vegas", "state": "NV", "zip": "89169" }, "vehicles": [ { "vin": "KL8CH6SA6NC001234", "year": 2022, "make": "Chevrolet", "model": "Spark", "color": "Red", "licensePlate": "B314PIE", "licensePlateState": "CA", "lotNumber": "LOT789", "additionalInfo": "The vehicle is in the back of the lot behind the big tree.", "externalVehicleId": "RND10 CHEV" } ] }
 

Get Listing

Get the listing for the provided listing ID.

👥 Customer Type

  • Shipper

📝 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://marketplace-api.centraldispatch.com/listings/id/{id}

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 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.

Listing

Details of a listing.

idstringread-only

The ID of the listing. 🔒 Read-only, will be set when the listing is created.

Example:42220470

shipperIdstring(uuid)read-only

The ID of the Central Dispatch customer who is the shipper. 🔒 Read-only, will be set when the listing is created.

Example:afd2fb59-b89d-4572-8f9a-e57f82a61c68

hrefstring | nullread-only

The fully qualified URL of the listing. 🔒 Read-only.

Example:https://marketplace-api.centraldispatch.com/listings/id/42220470

listingStatusstringread-only

The status of the listing, not editable.

Allowed values:LISTEDEXPIREDDELETEDARCHIVEDPENDING

Example:LISTED

originobject

Details of a location.

Show Child Parameters
destinationobject

Details of a location.

Show Child Parameters
distanceinteger | null(int32)

The total travel distance.

Example:267

additionalInfostring | null

Additional information.

<= 60 characters

Example:The vehicle is in the back of the lot behind the big tree.

shipperOrderIdstring | null

The ID of the shipper order.

<= 50 characters

Example:123-abc 900

trailerTypestring

The vehicle trailer type.

Allowed values:OPENENCLOSEDDRIVEWAY

Example:OPEN

hasInOpVehicleboolean

Indicates if listing includes a vehicle that is inoperable.

Default:false

Example:false

vehicleCountinteger(int32)read-only

The number of vehicles in the listing. 🔒 Read-only.

Example:2

vehiclesarray[object]

Details of a vehicle.

Show Child Parameters
availableDatestring

The available date of the listing, in UTC/ISO 8601 format.

Example:2025-11-05T00:00:00.000Z

createdDatestring | null(date-time)read-only

The date and time the listing was created, in UTC/ISO 8601 format. 🔒 Read-only, will be set when the listing is created.

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

deletedDatestring | null(date-time)read-only

The date and time the listing was deleted, in UTC/ISO 8601 format. 🔒 Read-only, will be set when the listing is deleted.

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

archivedDatestring | null(date-time)read-only

The date and time the listing was archived, in UTC/ISO 8601 format. 🔒 Read-only, will be set when the listing is archived.

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

expirationDatestring | null(date-time)read-only

The expiration date of the listing, in UTC/ISO 8601 format. 🔒 Read-only, will be set when the listing is created or updated.

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

desiredDeliveryDatestring | null

The desired delivery date of the listing, in UTC/ISO 8601 format.

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

priceobject

Details of the price.

Show Child Parameters
partnerReferenceIdstring | null

A user supplied ID used for reference.

Example:3fde6068-5fa2-4ae4-af16-06d65fc87dc9

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

get/listings/id/{id}
 
application/json

Update Listing

Update a listing.

👥 Customer Type

  • Shipper

📝 Important Notes

  • 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.
put
https://marketplace-api.centraldispatch.com/listings/id/{id}

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 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

Listing

Listing

Details of a listing.

originobject

Details of a location.

Show Child Parameters
destinationobject

Details of a location.

Show Child Parameters
distanceinteger | null(int32)

The total travel distance.

Example:267

additionalInfostring | null

Additional information.

<= 60 characters

Example:The vehicle is in the back of the lot behind the big tree.

shipperOrderIdstring | null

The ID of the shipper order.

<= 50 characters

Example:123-abc 900

trailerTypestring

The vehicle trailer type.

Allowed values:OPENENCLOSEDDRIVEWAY

Example:OPEN

hasInOpVehicleboolean

Indicates if listing includes a vehicle that is inoperable.

Default:false

Example:false

vehiclesarray[object]

Details of a vehicle.

Show Child Parameters
availableDatestring

The available date of the listing, in UTC/ISO 8601 format.

Example:2025-11-05T00:00:00.000Z

desiredDeliveryDatestring | null

The desired delivery date of the listing, in UTC/ISO 8601 format.

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

priceobject

Details of the price.

Show Child Parameters
partnerReferenceIdstring | null

A user supplied ID used for reference.

Example:3fde6068-5fa2-4ae4-af16-06d65fc87dc9

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

Response

No Content. Successful request.

put/listings/id/{id}

Body

{ "trailerType": "OPEN", "availableDate": "2025-11-05T00:00:00.000Z", "price": { "total": 500, "cod": { "amount": 200, "paymentMethod": "CASH_CERTIFIED_FUNDS", "paymentLocation": "PICKUP" }, "balance": { "amount": 300, "balancePaymentMethod": "CASH", "paymentTime": "IMMEDIATELY", "balancePaymentTermsBeginOn": "PICKUP" } }, "origin": { "city": "Anaheim", "state": "CA", "zip": "92802" }, "destination": { "city": "Las Vegas", "state": "NV", "zip": "89169" }, "vehicles": [ { "vin": "KL8CH6SA6NC001234", "year": 2022, "make": "Chevrolet", "model": "Spark", "color": "Red", "licensePlate": "B314PIE", "licensePlateState": "CA", "lotNumber": "LOT789", "additionalInfo": "The vehicle is in the back of the lot behind the big tree.", "externalVehicleId": "RND10 CHEV" } ] }
 

Delete Listing

Delete a listing.

👥 Customer Type

  • Shipper
delete
https://marketplace-api.centraldispatch.com/listings/id/{id}

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 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

No Content. Successful request.

delete/listings/id/{id}