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
The maximum number of items to be returned in the response.
Default:5
>= 1<= 5
Example:1
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
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.
Show Child Parameters
Stop
objectDetails of a stop.
The sequential number of the stop along the route e.g. 1 is the pick up stop and 2 is the delivery stop.
Example:1
The street address.
Example:345 W Elm St.
Additional street address line.
Example:2nd Floor
The city. Required if valid latitude and longitude are not provided.
Example:Anaheim
The state. Required if valid latitude and longitude are not provided.
Example:CA
The country code. US or CA.
Example:US
The ZIP code. Must be a valid United States ZIP code or Canadian postal code.
Example:92802
The latitude of the location. Required if valid city and state are not provided.
Example:33.81228788622535
The longitude of the location. Required if valid city and state are not provided.
Example:-117.91836265987132
Vehicle
objectDetails of a vehicle.
The vehicle identification number (VIN). Required if valid year, make and model are not provided.
Example:KL8CH6SA6NC001234
The 4 digit year of the vehicle. Required if valid vin is not provided.
Example:2022
The manufacturer’s make of the vehicle. Required if valid vin is not provided.
Example:Chevrolet
The manufacturer’s model of the vehicle. Required if valid vin is not provided.
Example:Spark
Limit search to operable vehicles.
Default:false
Example:true
The stop number where the vehicle will be picked up. Origin stop number from the stops array.
Example:1
The sequential stop number where the vehicle will be delivered. Destination stop number from the stops array.
Example:2
The type of vehicle e.g. CAR, TRUCK.
Example:CAR