Search
K
Listings API V2

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.

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

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

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)

externalVehicleIdstring

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

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

BalancePaymentMethod

string

The payment method with which the balance due payment will be paid.

Allowed values:CASHCERTIFIED_FUNDSCOMCHEKCOMPANY_CHECKTCH

Default:CASH

Example

BalancePaymentTermsBeginOnType

string

The terms for beginning balance payment.

Allowed values:DELIVERYPICKUPRECEIVING_SIGNED_BOL

Default:PICKUP

Example

BalancePaymentTime

string

The time frame when the balance payment is due.

Allowed values:FIFTEEN_BUSINESS_DAYSFIVE_BUSINESS_DAYSIMMEDIATELYTEN_BUSINESS_DAYSTHIRTY_BUSINESS_DAYSTWO_BUSINESS_DAYS

Default:IMMEDIATELY

Example