Listings API V1

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

Price

object

Details of the price.

totalnumber(double)

The total amount to be paid for completing the dispatch.

Example:500

codobject

Details of the cash on delivery or cash on pick-up (COD/COP).

Show Child Parameters
balanceobject

Details of the balance.

Show Child Parameters
Example

ShippingSpecs

object

Details of the shipping specifications of a vehicle.

heightinteger(int32)

The height of the vehicle.

Example:58

widthinteger(int32)

The width of the vehicle.

Example:62

lengthinteger(int32)

The length of the vehicle.

Example:143

weightinteger(int32)

The weight of the vehicle.

Example:2246

Example