Search
K
Listings API V1

Delete Listing

Delete a listing.

👥 Customer Type

  • Shipper
delete
https://marketplace-api.centraldispatch.com/listings/id/{id}

Path Parameters

idinteger(int64)required

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 1.x.x of an API, the Accept header should be set to application/vnd.coxauto.v1+json.

Example:application/vnd.coxauto.v1+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 1.x.x of an API, the Content-Type header should be set to application/vnd.coxauto.v1+json.

Example:application/vnd.coxauto.v1+json

Body

application/json

An array of listing URLs. Refer to the example Body for details.

array[string]

Response

application/json

OK. Successful request.

ListingCollection

A paginated collection of listings.

hrefstring | null

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 | null[object]

Details of a listing.

Show Child Parameters
post/listings/batch

Body

[ "https://marketplace-api.centraldispatch.com/listings/id/d159acc0-e89b-12d3-a456-426614174000", "https://marketplace-api.centraldispatch.com/listings/id/2539f4b4-d3d6-45db-8df3-7ba768caba9b" ]
 
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 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.

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 1.x.x of an API, the Accept header should be set to application/vnd.coxauto.v1+json.

Example:application/vnd.coxauto.v1+json

Response

application/json

OK. Successful request.

ListingCollection

A paginated collection of listings.

hrefstring | null

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 | null[object]

Details of a listing.

Show Child Parameters
get/listings/mine
 
application/json

Balance

object

Details of the balance.

amountnumber(double)

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

Example:300

paymentTimestring

Balance due timeframe.

Allowed values:IMMEDIATELYTWO_BUSINESS_DAYSFIVE_BUSINESS_DAYSTEN_BUSINESS_DAYSFIFTEEN_BUSINESS_DAYSTHIRTY_BUSINESS_DAYS

Example:IMMEDIATELY

balancePaymentTermsBeginOnstring

Balance due term starts.

Allowed values:PICKUPDELIVERYRECEIVING_SIGNED_BOL

Example:PICKUP

balancePaymentMethodstring

Balance payment method.

Allowed values:CASHCERTIFIED_CHECK_COMPANY_CHECKCOMCHEKTCH

Example:CASH

Example

BalancePaymentMethod

string

Balance payment method.

Allowed values:CASHCERTIFIED_CHECK_COMPANY_CHECKCOMCHEKTCH

Example