Market Intelligence API

Get Listing Prices

Gets predicted pricing and historical data about listings, dispatches and pricing given a load with similar vehicle, origin and destination.

πŸ‘₯ Applicable Roles

  • Enterprise Package Customers

πŸ“ Important Notes

  • Stops array must include two valid stops.
  • Stop numbers must increment sequentially starting from one.
  • Each stop requires either valid latitude and longitude coordinates (most accurate) or city and state. Try to include street address and country if latitude and longitude coordinates are not available. The more information provided the more accurate the results will be.
  • Origin and destination stops cannot be the same.
  • The vehicles array must include one valid vehicle entry.
  • Both pickUpStopNumber and dropOffStopNumber are required and must correspond to stop numbers in the stops array (typically 1 and 2).
post
https://api.centraldispatch.com/market-intelligence/list-prices

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

ListingPriceRequest

ListingPriceRequest

Details of listing prices.

stopsarray[object]

Details of a stop.

Show Child Parameters
vehiclesarray[object]

Details of a vehicle.

Show Child Parameters
isEnclosedboolean

Limit search to enclosed trailers.

Default:false

Example:true

limitinteger | null(int32)

The maximum number of items to be returned in the response.

Default:5

>= 1<= 5

Example:1

Response

application/json

OK. Successful request.

ListingPriceResponseCollection

A collection of listing price responses.

hrefstring | null

The URL used to query the current collection of the resource.

Example:https://api.centraldispatch.com/list-prices

countinteger(int32)

The total count of resources in the collection.

Example:1

limitinteger(int32)

The maximum number of items to be returned in the response.

Example:1

itemsarray | null[object]

Details of the listing price.

Show Child Parameters
post/market-intelligence/list-prices

Body

{ "stops": [ { "stopNumber": 1, "streetAddress1": "345 W Elm St.", "city": "Anaheim", "state": "CA", "postalCode": "92802", "country": "US", "latitude": 33.81228788622535, "longitude": -117.91836265987132 }, { "stopNumber": 2, "streetAddress1": "255 Sands Ave.", "city": "Las Vegas", "state": "NV", "postalCode": "89169", "country": "US", "latitude": 36.121343020081525, "longitude": -115.16195281104913 } ], "vehicles": [ { "vin": "KL8CH6SA6NC001234", "year": "2022", "make": "Chevrolet", "model": "Spark", "isOperable": false, "pickupStopNumber": 1, "dropOffStopNumber": 2, "vehicleType": "CAR" } ], "isEnclosed": true, "limit": 1 }
Β 
application/json

Error

object

Details of an error or issue.

codestring

The code used for the issue.

Example:resource.issue_type

descriptionstring

A detailed message.

Example:The issue happened because something is wrong.

propertystring

The property to which the issue is associated.

Example:person

propertiesobject

Additional properties related to the issue.

Example:{"firstName":"D0nn@","lastName":"Sm!th"}

Example

Errors

object

An error occurred, and the request could not be completed.

errorsarray[object]

Details of an error or issue.

Show Child Parameters
Example

ListingPriceRequest

object

Details of listing prices.

stopsarray[object]

Details of a stop.

Show Child Parameters
vehiclesarray[object]

Details of a vehicle.

Show Child Parameters
isEnclosedboolean

Limit search to enclosed trailers.

Default:false

Example:true

limitinteger(int32)

The maximum number of items to be returned in the response.

Default:5

>= 1<= 5

Example:1

Example

ListingPriceResponse

object

Details of the listing price.

lowPricenumber(double)

The lowest price found.

Example:100

lowPriceCurrencystring

The currency of lowPrice.

Example:USD

highPricenumber(double)

The highest price found.

Example:200

highPriceCurrencystring

The currency of highPrice.

Example:USD

meanPredictedPricenumber(double)

The mean predicted price.

Example:150

meanPredictedPriceCurrencystring

The currency of meanPredictedPrice.

Example:USD

originCitystring

The pick up city.

Example:Anaheim

originStatestring

The pick up state.

Example:CA

originZipCodestring

The pick up ZIP code. Must be a valid United States ZIP code or Canadian postal code.

Example:92802

destinationCitystring

The delivery city.

Example:Las Vegas

destinationStatestring

The delivery state.

Example:NV

destinationZipCodestring

The delivery ZIP code.

Example:89169

vehicleTypestring

The type of vehicle e.g. CAR, TRUCK.

Example:CAR

vehicleSizestring

The size of the vehicle.

Example:MEDIUM

listingPricenumber(double)

The listing price.

Example:120

listingPriceCurrencystring

The currency of listingPrice.

Example:USD

listingPricePerMilenumber(double)

The listing price per mile.

Example:1.5

listingPricePerMileCurrencystring

The currency of listingPricePerMile.

Example:USD

listingCreationDatestring(date-time)

The date and time the listing was created, in UTC/ISO 8601 format.

Example:2024-08-01T00:00:00Z

dispatchDistancenumber(double)

The total travel distance.

Example:267

dispatchDistanceUnitsstring

The units of dispatchDistance.

Example:MILES

listingDistancenumber(double)

The total travel distance.

Example:267

listingDistanceUnitsstring

The units of listingDistance.

Example:MILES

dispatchStatusstring

The status of the dispatch.

Example:DELIVERED

dispatchPricenumber(double)

The total amount to be paid for completing the dispatch.

Example:180

dispatchPriceCurrencystring

The currency of dispatchPrice.

Example:USD

dispatchPricePerMilenumber(double)

The per mile price of the dispatch.

Example:0.55

dispatchPricePerMileCurrencystring

The currency of dispatchPricePerMile.

Example:USD

dispatchDatestring(date-time)

The actual pick up date and time, in UTC/ISO 8601 format.

Example:2024-09-10T00:00:00Z

Example