Error
objectDetails of an error or issue.
The code used for the issue.
Example:resource.issue_type
A detailed message.
Example:The issue happened because something is wrong.
The property to which the issue is associated.
Example:person
Additional properties related to the issue.
Example:{"firstName":"D0nn@","lastName":"Sm!th"}
Errors
objectAn error occurred, and the request could not be completed.
Details of an error or issue.
Show Child Parameters
ListingPriceRequest
objectDetails of listing prices.
Details of a stop.
Show Child Parameters
Details of a vehicle.
Show Child Parameters
Limit search to enclosed trailers.
Default:false
Example:true
When true, strictly limits search results to fully enclosed items only. By default, the search relaxes enclosed requirements to improve match rates, but enabling this flag ensures no non-enclosed results are returned.
Default:false
Example:true
The maximum number of items to be returned in the response.
Default:5
>= 1<= 5
Example:1
The earliest creation date for comparable listings to include in results. Accepts any date between today and the last 365 days. If not provided, defaults to 365 days ago, in UTC/ISO 8601 format.
Example:2026-03-20T00:00:00Z
ListingPriceResponse
objectDetails of the listing price.
The lowest price found.
Example:100
The currency of lowPrice.
Example:USD
The highest price found.
Example:200
The currency of highPrice.
Example:USD
The mean predicted price.
Example:150
The currency of meanPredictedPrice.
Example:USD
The pick up city.
Example:Anaheim
The pick up state.
Example:CA
The pick up ZIP code. Must be a valid United States ZIP code or Canadian postal code.
Example:92802
The delivery city.
Example:Las Vegas
The delivery state.
Example:NV
The delivery ZIP code.
Example:89169
The type of vehicle e.g. CAR, TRUCK.
Example:CAR
The size of the vehicle.
Example:MEDIUM
The listing price.
Example:120
The currency of listingPrice.
Example:USD
The listing price per mile.
Example:1.5
The currency of listingPricePerMile.
Example:USD
The date and time the listing was created, in UTC/ISO 8601 format.
Example:2024-08-01T00:00:00Z
The total travel distance.
Example:267
The units of dispatchDistance.
Example:MILES
The total travel distance.
Example:267
The units of listingDistance.
Example:MILES
The status of the dispatch.
Example:DELIVERED
The total amount to be paid for completing the dispatch.
Example:180
The currency of dispatchPrice.
Example:USD
The per mile price of the dispatch.
Example:0.55
The currency of dispatchPricePerMile.
Example:USD
The actual pick up date and time, in UTC/ISO 8601 format.
Example:2024-09-10T00:00:00Z
The shortest estimated time it will take for your dispatch to be accepted by a carrier, if listed at the predicted price.
Example:2
The unit of time for the minTimeToDispatchForMeanPredictedPrice value (e.g., HOURS).
Example:HOURS
The longest estimated time it will take for your dispatch to be accepted by a carrier, if listed at the predicted price.
Example:8
The unit of time for the maxTimeToDispatchForMeanPredictedPrice value (e.g., HOURS).
Example:HOURS
ListingPriceResponseCollection
objectA collection of listing price responses.
The URL used to query the current collection of the resource.
Example:https://api.centraldispatch.com/list-prices
The total count of resources in the collection.
Example:1
The maximum number of items to be returned in the response.
Example:1
Details of the listing price.