idinteger(int64)required
Example:42220470
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
Locationheader 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
ETagheader, which should be used for theIf-Matchheader in subsequent updates.
get
https://marketplace-api.centraldispatch.com/listings/id/{id}
Path Parameters
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
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}
Authentication
Path Parameters
Headers
application/json
Update Listing
Update a listing.
👥 Customer Type
- Shipper
📝 Important Notes
- The
If-Matchheader is required and its value can be found in theETagresponse 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
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
Response
No Content. Successful request.
put/listings/id/{id}
Authentication
Path Parameters
Headers
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
Response
No Content. Successful request.
delete/listings/id/{id}
Authentication
Path Parameters
Headers
Get Listings (Batch)
Get a collection of listings for the provided listing IDs or URLs.
👥 Customer Type
- Shipper
post
https://marketplace-api.centraldispatch.com/listings/batch
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
Body
application/json
An array of listing URLs. Refer to the example Body for details.
array[string]
Response
application/json
Response
application/json
OK. Successful request.
ListingCollection
A paginated collection of listings.
hrefstring | null
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 | null[object]
Details of a listing.
Show Child Parameters
post/listings/batch
Authentication
Headers
Body
[
"https://marketplace-api.centraldispatch.com/listings/id/d159acc0-e89b-12d3-a456-426614174000",
"https://marketplace-api.centraldispatch.com/listings/id/2539f4b4-d3d6-45db-8df3-7ba768caba9b"
]
application/json
Get My Listings
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.
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 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
Response
application/json
OK. Successful request.
ListingCollection
A paginated collection of listings.
hrefstring | null
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 | null[object]
Details of a listing.
Show Child Parameters
get/listings/mine
Authentication
Query Parameters
Headers
application/json