Listings API V1

GeoCode

object

Details of the geographical coordinates for a location.

longitudenumber(double)

The longitude of the location.

Example:-117.91836265987132

latitudenumber(double)

The latitude of the location.

Example:33.81228788622535

Example

Listing

object

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

hrefstringread-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(int32)

The total travel distance.

Example:267

additionalInfostring

Additional information.

<= 60 characters

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

shipperOrderIdstring

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

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

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

A user supplied ID used for reference.

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

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

Example

ListingCollection

object

A paginated 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
Example

ListingStatus

string

The status of the listing, not editable.

Allowed values:LISTEDEXPIREDDELETEDARCHIVEDPENDING

Example

Location

object

Details of a location.

citystring

The city.

Example:Anaheim

statestring

The state.

Example:CA

zipstring

The ZIP code. Must be a valid United States ZIP code or Canadian postal code.

<= 5 characters

Example:92802

geoCodeobject

Details of the geographical coordinates for a location.

Show Child Parameters
metroAreastring

The metro area of the stop.

Example:Orange County

Example