Get a collection of draft listings for the provided draft listing IDs or URLs.
count is the number of items returned.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
An array of draft listing IDs and/or draft listing URLs.
OK. Successful request.
A collection of draft listings.
The URL used to query the current collection of the resource.
Example:https://marketplace-api.centraldispatch.com/draft-listings/batch
The total count of resources in the collection.
Example:23
Details of a draft listing.
Get the vehicles in listings that belong to the calling customer.
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.
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.
curl -X GET https://api.centraldispatch.com/listing-vehicles/mine?limit(1,10)%listingId=400000000
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
The ID of the listing.
Example:42220470
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
OK. Successful request.
A paginated collection of vehicles.
The URL used to query the current collection of the resource.
Example:https://marketplace-api.centraldispatch.com/listing-vehicles/mine?limit(5,1)
Details of a vehicle.
The maximum number of items to be returned in the response.
Example:1
The URL to the next page of the collection, if available.
Example:https://marketplace-api.centraldispatch.com/listing-vehicles/mine?limit(5,1)
The URL to the previous page of the collection, if available.
Example:https://marketplace-api.centraldispatch.com/listing-vehicles/mine?limit(6,1)
The URL to the first page of the collection.
Example:https://marketplace-api.centraldispatch.com/listing-vehicles/mine?limit(1,1)
The total count of resources in the collection.
Example:23
Details of the balance.
The balance amount that will be due after the COD/COP payment is applied.
Default:0
>= 0
Example:300
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
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
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
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
Details of the balance.
The balance amount that will be due after the COD/COP payment is applied.
Example:300
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
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
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
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