Search
K
Stage - Listings API V2

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 Location header.
  • 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-Match header is required and its value can be found in the ETag response header of the resource’s GET by ID endpoint.
  • A stale If-Match value is rejected with 422, 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

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 ACTIVE load automatically becomes NOTLISTED when it passes its available-to-ship date by four days, reaches its expiration date, or has searchable set to false. 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}
 
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 next value.
  • count is the total number of drafts you own, not the size of the current page, so next is 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 400 rather 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

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
 
application/json

Get Draft Listings (Batch)

Get a collection of draft listings for the provided draft listing IDs or URLs.

👥 Customer Type

  • Shipper

📝 Important Notes

  • Each entry may be either a bare numeric draft listing ID or the full URL of a draft listing.
  • A maximum of 50 IDs may be requested at once.
  • Only your own drafts are returned. An ID that does not exist, has been published, or belongs to another customer is omitted from the response rather than reported as an error, so the response may contain fewer items than IDs requested.
  • The response is not paginated - count is the number of items returned.
post
https://marketplace-api.centraldispatch.com/draft-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 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 draft listing IDs and/or draft listing URLs.

array[string]

Response

application/json

OK. Successful request.

DraftListingCollection

A collection of draft listings.

hrefstring

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

Example:https://marketplace-api.centraldispatch.com/draft-listings/batch

countinteger(int32)

The total count of resources in the collection.

Example:23

itemsarray[object]

Details of a draft listing.

Show Child Parameters
post/draft-listings/batch

Body

[ "42220470", "43000470" ]
 
application/json

Listing-Vehicles

Get My Vehicles

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 a vehicle record in their local TMS to a Central Dispatch record.
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

externalVehicleIdstring

A vehicle identifier managed by the user. Shippers can use this field to map a vehicle record in their local TMS to a Central Dispatch record.

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
 
application/json