Stage - Listings API V2

Listing API

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

BalanceRequest

object

Details of the balance.

amountnumber(double)

The balance amount that will be due after the COD/COP payment is applied.

Default:0

>= 0

Example:300

amountCurrencystring

The currency of the monetary field. This list is not exhaustive and additional values may be added at any time.

Allowed values:USD

Default:USD

Example:USD

paymentTimestring

The time frame when the balance payment is due. This list is not exhaustive and additional values may be added at any time.

Allowed values:FIFTEEN_BUSINESS_DAYSFIVE_BUSINESS_DAYSIMMEDIATELYTEN_BUSINESS_DAYSTHIRTY_BUSINESS_DAYSTWO_BUSINESS_DAYS

Default:IMMEDIATELY

Example:IMMEDIATELY

balancePaymentTermsBeginOnstring

The terms for beginning balance payment. This list is not exhaustive and additional values may be added at any time.

Allowed values:DELIVERYPICKUPRECEIVING_SIGNED_BOL

Default:PICKUP

Example:PICKUP

balancePaymentMethodstring

The payment method with which the balance due payment will be paid. This list is not exhaustive and additional values may be added at any time.

Allowed values:CASHCERTIFIED_FUNDSCOMCHEKCOMPANY_CHECKTCH

Default:CASH

Example:CASH

Example

BalanceResponse

object

Details of the balance.

amountnumber(double)

The balance amount that will be due after the COD/COP payment is applied.

Example:300

amountCurrencystring

The currency of the monetary field. This list is not exhaustive and additional values may be added at any time.

Allowed values:USD

Default:USD

Example:USD

paymentTimestring

The time frame when the balance payment is due. This list is not exhaustive and additional values may be added at any time.

Allowed values:FIFTEEN_BUSINESS_DAYSFIVE_BUSINESS_DAYSIMMEDIATELYTEN_BUSINESS_DAYSTHIRTY_BUSINESS_DAYSTWO_BUSINESS_DAYS

Example:IMMEDIATELY

balancePaymentTermsBeginOnstring

The terms for beginning balance payment. This list is not exhaustive and additional values may be added at any time.

Allowed values:DELIVERYPICKUPRECEIVING_SIGNED_BOL

Example:PICKUP

balancePaymentMethodstring

The payment method with which the balance due payment will be paid. This list is not exhaustive and additional values may be added at any time.

Allowed values:CASHCERTIFIED_FUNDSCOMCHEKCOMPANY_CHECKTCH

Example:CASH

Example