Stage - Listings API V2

Listing API

Delete Listing

Delete a listing.

👥 Customer Type

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

No Content. Successful request.

delete/listings/id/{id}
 

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

Body

[ "42220470", "300040271" ]
 
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 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.
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 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

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

Draft-Listings

Create Draft Listing

Create a draft listing.

👥 Customer Type

  • Shipper

📝 Important Notes

  • A draft is private work-in-progress. It is not published to the marketplace, is not searchable by carriers, and cannot receive offers or be dispatched until it is published.
  • Every field except one is optional, so a partially complete vehicle shipment can be stored and finished later. At least one user-entered field must be supplied.
  • Only stored values are validated. The full set of listing rules is enforced when the draft is published, so a draft that saves successfully can still be rejected at publish time.
  • The draft’s listingStatus is always DRAFT.
  • 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.
post
https://marketplace-api.centraldispatch.com/draft-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 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

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

Created. Successful request.

post/draft-listings

Body

{ "shipperOrderId": "123-abc 900", "availableDate": "2025-02-20T00:00:00Z", "vehicles": [ { "vin": "KL8CH6SA6NC001234", "year": 2022, "make": "Chevrolet", "model": "Spark" } ] }