Stage - Listings API V2
Get Draft Listing
Get the draft listing for the provided draft listing ID.
👥 Customer Type
- Shipper
📝 Important Notes
- Only your own drafts can be retrieved. A draft belonging to another customer is reported as not found.
- The response will include an
ETagheader, which should be used for theIf-Matchheader in subsequent updates. - 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.
get
https://marketplace-api.centraldispatch.com/draft-listings/id/{id}
Path Parameters
idinteger(int64)required
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
Response
application/json
OK. Successful request.
DraftListingResponse
Details of a draft listing.
listingIdinteger(int64)
The ID of the listing.
Example:42220470
shipperIdstring(uuid)
The ID of the Central Dispatch customer who is the shipper.
Example:afd2fb59-b89d-4572-8f9a-e57f82a61c68
shipperOrderIdstring | null
The ID of the shipper order.
Example:123-abc 900
partnerReferenceIdstring | null
A user supplied ID used for reference.
Example:25-KL8CH6
externalIdstring | null
An identifier managed by the user. Shippers can use this field to map a record (e.g. order, shipment, dispatch) in their local TMS to a Central Dispatch record. This value is displayed as the load number on the Central Dispatch website.
Example:RND10 CHEV
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.
Example:Charging cables need to be picked up with vehicles and if left behind a $200 fee will be applied.
hrefstring
The fully qualified URL of the listing.
Example:https://marketplace-api.centraldispatch.com/listings/id/42220470
hasInOpVehicleboolean
Indicates whether the vehicle is inoperable.
Example:false
availableDatestring(date-time)
The available date of the listing, in UTC/ISO 8601 format.
Example:2025-11-05T00:00:00.000Z
createdOnstring(date-time)
The date and time the listing was created, in UTC/ISO 8601 format.
Example:2024-10-15T00:00:00Z
expirationDatestring(date-time)
The expiration date of the listing, in UTC/ISO 8601 format.
Example:2025-08-15T00:00:00.000Z
desiredDeliveryDatestring | null(date-time)
The desired delivery date of the listing, in UTC/ISO 8601 format.
Example:2025-03-04T00:00:00Z
sourcestring
The source of the listing. This list is not exhaustive and additional values may be added at any time.
Allowed values:APIUICSV
Example:API
trailerTypestring
The trailer type. This list is not exhaustive and additional values may be added at any time.
Allowed values:DRIVEAWAYENCLOSEDOPEN
Example:OPEN
listingStatusstring
The status of the listing.
- ACTIVE: The load is listed and shown in searches on Central Dispatch.
- ARCHIVED: The listing has been archived and is no longer active.
- DELETED: The listing has been removed.
- NOTLISTED: The load is not shown in searches on Central Dispatch. An
ACTIVEload automatically becomesNOTLISTEDwhen it passes its available-to-ship date by four days, reaches its expiration date, or hassearchableset tofalse. Available beginning 8/10/26.
This list is not exhaustive and additional values may be added at any time.
Allowed values:ACTIVEARCHIVEDDELETEDNOTLISTED
Example:ACTIVE
partnerIdstring | null
The Central Dispatch ID of the partner who created or last updated the transaction on behalf of the customer. Will be null if the customer made the API call directly.
Example:b6e8c9e4-989a-4b37-8dd7-99fd34882bd0
clientIdstring | null
The Central Dispatch ID of the user who created or last updated the resource.
Example:6e93ff07-6ea6-4239-b502-7bf4f68d2600
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.
Example:false
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).
Example:false
priceobject
Details of the price of a draft listing.
Show Child Parameters
slaobject
Details of the service level agreement of a draft listing.
Show Child Parameters
vehiclesarray[object]
Details of a vehicle on a draft listing.
Show Child Parameters
stopsarray[object]
Details of a stop on a draft listing.
Show Child Parameters
marketplacesarray[object]
Details of a marketplace on a draft listing.
Show Child Parameters
tagsarray | null[object]
Details of a listing tag.
Show Child Parameters
get/draft-listings/id/{id}
Authentication
Path Parameters
Headers
application/json
Update Draft Listing
Update a draft listing.
👥 Customer Type
- Shipper
📝 Important Notes
- This operation replaces the entire draft. Any field omitted from the request is cleared, so send the whole draft on every update.
- The draft remains a draft. Updating it does not publish it to the marketplace.
- The
If-Matchheader is required and its value can be found in theETagresponse header of the resource’s GET by ID endpoint. - A stale
If-Matchvalue is rejected with422, and the stored draft is left unchanged. Re-read the draft to obtain the currentETagbefore retrying.
put
https://marketplace-api.centraldispatch.com/draft-listings/id/{id}
Path Parameters
idinteger(int64)required
The ID of the listing.
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
Body
application/json
DraftListingRequest
DraftListingRequest
Details of a draft listing to be created or updated.
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 a record (e.g. order, shipment, dispatch) in their local TMS to a Central Dispatch record. This value is displayed as the load number on the Central Dispatch website.
<= 50 characters
Example:RND10 CHEV
trailerTypestring | null
The trailer type. This list is not exhaustive and additional values may be added at any time.
Allowed values:DRIVEAWAYENCLOSEDOPEN
Default:OPEN
Example:OPEN
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 of a draft listing.
Show Child Parameters
slaobject
Details of the service level agreement of a draft listing.
Show Child Parameters
stopsarray[object]
Details of a stop on a draft listing.
Show Child Parameters
vehiclesarray[object]
Details of a vehicle on a draft listing.
Show Child Parameters
marketplacesarray[object]
Details of a marketplace on a draft listing.
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
Response
No Content. Successful request.
put/draft-listings/id/{id}
Authentication
Path Parameters
Headers
Body
{
"shipperOrderId": "123-abc 900",
"availableDate": "2025-02-20T00:00:00Z",
"vehicles": [
{
"vin": "KL8CH6SA6NC001234",
"year": 2022,
"make": "Chevrolet",
"model": "Spark"
}
]
}
Delete Draft Listing
Delete a draft listing.
👥 Customer Type
- Shipper
📝 Important Notes
- The draft is removed permanently and cannot be recovered.
- Only your own drafts can be deleted. A draft belonging to another customer is reported as not found and is left untouched.
- Deleting a draft has no effect on any listing already published from it.
delete
https://marketplace-api.centraldispatch.com/draft-listings/id/{id}
Path Parameters
idinteger(int64)required
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
Response
No Content. Successful request.
delete/draft-listings/id/{id}
Authentication
Path Parameters
Headers
Publish Draft Listing
Publish a draft listing, turning it into an active listing on the marketplace.
👥 Customer Type
- Shipper
📝 Important Notes
- The created resource is a listing, not a draft. It is returned in the response body and its URL is in the
Locationheader. - The new listing keeps the draft’s ID, and the draft is consumed - a second publish of the same ID is reported as not found.
- Publishing enforces the complete set of Create Listing rules, so a draft that saved successfully can still be rejected here with
422. Correct the draft with Update Draft Listing and publish again. - The
If-Matchheader is required and its value can be found in theETagresponse header of the resource’s GET by ID endpoint. - A stale
If-Matchvalue is rejected with422, and the draft is left intact and unpublished.
post
https://marketplace-api.centraldispatch.com/listings/ref/draft-listings/id/{draftListingId}
Path Parameters
draftListingIdinteger(int64)required
The ID of the listing.
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
Response
application/json
Response
application/json
Created. Successful request.
ListingResponse
Details of a listing.
listingIdinteger(int64)
The ID of the listing.
Example:42220470
shipperIdstring(uuid)
The ID of the Central Dispatch customer who is the shipper.
Example:afd2fb59-b89d-4572-8f9a-e57f82a61c68
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.
Example:Charging cables need to be picked up with vehicles and if left behind a $200 fee will be applied.
archivedDatestring | null(date-time)
The date and time the listing was archived, in UTC/ISO 8601 format.
Example:2024-08-01T00:00:00Z
availableDatestring(date-time)
The available date of the listing, in UTC/ISO 8601 format.
Example:2025-11-05T00:00:00.000Z
createdOnstring(date-time)
The date and time the listing was created, in UTC/ISO 8601 format.
Example:2024-10-15T00:00:00Z
deletedDatestring | null(date-time)
The date and time the listing was deleted, in UTC/ISO 8601 format.
Example:2024-09-10T00:00:00Z
desiredDeliveryDatestring | null(date-time)
The desired delivery date of the listing, in UTC/ISO 8601 format.
Example:2025-03-04T00:00:00Z
expirationDatestring(date-time)
The expiration date of the listing, in UTC/ISO 8601 format.
Example:2025-08-15T00:00:00.000Z
externalIdstring | null
An identifier managed by the user. Shippers can use this field to map a record (e.g. order, shipment, dispatch) in their local TMS to a Central Dispatch record. This value is displayed as the load number on the Central Dispatch website.
Example:RND10 CHEV
hasInOpVehicleboolean
Indicates whether the vehicle is inoperable.
Example:false
hrefstring
The fully qualified URL of the listing.
Example:https://marketplace-api.centraldispatch.com/listings/id/42220470
listingStatusstring
The status of the listing.
- ACTIVE: The load is listed and shown in searches on Central Dispatch.
- ARCHIVED: The listing has been archived and is no longer active.
- DELETED: The listing has been removed.
- NOTLISTED: The load is not shown in searches on Central Dispatch. An
ACTIVEload automatically becomesNOTLISTEDwhen it passes its available-to-ship date by four days, reaches its expiration date, or hassearchableset tofalse. Available beginning 8/10/26.
This list is not exhaustive and additional values may be added at any time.
Allowed values:ACTIVEARCHIVEDDELETEDNOTLISTED
Example:ACTIVE
partnerIdstring | null
The Central Dispatch ID of the partner who created or last updated the transaction on behalf of the customer. Will be null if the customer made the API call directly.
Example:b6e8c9e4-989a-4b37-8dd7-99fd34882bd0
clientIdstring | null
The Central Dispatch ID of the user who created or last updated the resource.
Example:6e93ff07-6ea6-4239-b502-7bf4f68d2600
requiresInspectionboolean
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.
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
marketplacesarray[object]
Details of the marketplace.
Show Child Parameters
partnerReferenceIdstring | null
A user supplied ID used for reference.
Example:25-KL8CH6
priceobject
Details of the price.
Show Child Parameters
shipperOrderIdstring | null
The ID of the shipper order.
Example:123-abc 900
slaobject
Details of the service level agreement (SLA) for a listing.
Show Child Parameters
sourcestring
The source of the listing. This list is not exhaustive and additional values may be added at any time.
Allowed values:APIUICSV
Example:API
stopsarray[object]
Details of a stop.
Show Child Parameters
tagsarray | null[object]
Details of a listing tag.
Show Child Parameters
totalDistanceInMilesinteger(int32)
The total travel distance in miles.
Example:267
trailerTypestring
The trailer type. This list is not exhaustive and additional values may be added at any time.
Allowed values:DRIVEAWAYENCLOSEDOPEN
Example:OPEN
vehiclesarray[object]
Details of a vehicle.
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.
post/listings/ref/draft-listings/id/{draftListingId}
Authentication
Path Parameters
Headers
application/json
Get My Draft Listings
Get a collection of draft listings that belong to the calling customer, newest first.
👥 Customer Type
- Shipper
📝 Important Notes
- Results will be paginated. Navigate through the results using the
nextvalue. countis the total number of drafts you own, not the size of the current page, sonextis present exactly when more drafts remain.- Drafts cannot be filtered by field. A draft stores whatever the shipper has entered so far, so any search criterion would silently hide incomplete work. Unsupported query parameters are rejected with
400rather than ignored. To retrieve specific drafts by ID, use Get Draft Listings (Batch). - Be sure to URL encode any parameters that contain spaces or special characters.
get
https://marketplace-api.centraldispatch.com/draft-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)
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
Response
application/json
OK. Successful request.
DraftListingPaginatedCollection
A paginated collection of draft listings.
hrefstring
The URL used to query the current collection of the resource.
Example:https://marketplace-api.centraldispatch.com/draft-listings/mine?limit(5,1)
firststring | null
The URL to the first page of the collection.
Example:https://marketplace-api.centraldispatch.com/draft-listings/mine?limit(1,1)
previousstring | null
The URL to the previous page of the collection, if available.
Example:https://marketplace-api.centraldispatch.com/draft-listings/mine?limit(4,1)
nextstring | null
The URL to the next page of the collection, if available.
Example:https://marketplace-api.centraldispatch.com/draft-listings/mine?limit(6,1)
limitinteger(int32)
The maximum number of items to be returned in the response.
Example:1
countinteger(int32)
The total count of resources in the collection.
Example:23
itemsarray[object]
Details of a draft listing.
Show Child Parameters
get/draft-listings/mine
Authentication
Query Parameters
Headers
application/json