PRproject44
TL: Available Vehicles

Get a list of available vehicles within the radius.

Use this POST call to get ETA of all vehicles that are terminating their route within the radius. Search can be enhanced with the type of truck, radius size from the given location and a termination time window.

<br/><h4><b>Required Fields</h4></b>

<ul><li><b> timeRange: </b></li><ul><li><b> startDateTime </b></li></ul><li><b> location: </b></li><ul><li><b> address: </b>(if no geoCoordinates provided)</li><ul><li> postalCode </li><li> addressLines </li><li> city </li><li> state (for USA, Mexico and Canada) </li></ul><li><b> geoCoordinates </b>(if no address provided)</li><ul><li> latitude </li><li> longitude </li></ul></ul></ul>
post/api/v4/tl/available-vehicles/query

Request

Query parameters

pageinteger

Page number valid range: [1, 1000]

sizeinteger

Page size valid range: [1, 1000]

sortstring

Sortable Fields [distance, carrierContact, estimatedArrivalDateTime, truckType]

Request body

includeMyShipmentsboolean

Allows users to exclude shipments belonging to their tenant.

radiusinteger

Search radius for capacity. Default is 25 miles or 40 km if no value is submitted. Valid values are any integer between 10-50 for miles and 16-80 for km.

radiusUnit'FT' | 'M' | 'MI' | 'KM'

Unit of the search radius for capacity. Default is miles.

sharingPoolstring

Optional parameter that will only return results from a specified pool. This will only apply to customers in more than 1 pool.

truckType'AUTO_CARRIER' | 'B_TRAIN' | 'CONESTOGA' | 'CONTAINER' | 'CONTAINER_INSULATED' | 'CONTAINER_REFRIGERATED' | 'CONVEYOR' | 'DOUBLE_DROP' | 'DROP_DECK_LANDOLL' | 'DUMP_TRAILER' | 'FLAT_BED' | 'FLATBED_AIR_RIDE' | 'FLATBED_CONESTOGA' | 'FLATBED_DOUBLE' | 'FLATBED_HAZMAT' | 'FLATBED_HOTSHOT' | 'FLATBED_MAXI' | 'FLATBED_STEP_DECK' | 'FLATBED_OVERDOMENSION' | 'FLATBED_OVERDIMENSION' | 'FLATBED_CHAINS' | 'FLATBED_SIDES' | 'FLATBED_TARPS' | 'FLATBED_TEAM' | 'FLATBED_VAN_REEFER' | 'HOPPER_BOTTOM' | 'INSULATED_VAN_REEFER' | 'LOWBOY' | 'LOWBOY_REM_GOOSENECK' | 'LOWBOY_OVERDIMENSION' | 'MOVING_VAN' | 'PNEUMATIC' | 'POWER_ONLY' | 'REEFER' | 'REEFER_AIR_RIDE' | 'REEFER_DOUBLE' | 'REEFER_HAZMAT' | 'REEFER_INTERMODAL' | 'REEFER_LOGISTICS' | 'REEFER_VENTED_VAN' | 'REEFER_PALLET_EXCHANGE' | 'REEFER_TEAM' | 'REMOVABLE_GOOSENECK' | 'STEP_DECK' | 'STEP_DECK_REM_GOOSENECK' | 'STEP_DECK_CONESTOGA' | 'STRAIGHT_BOX_TRUCK' | 'STRETCH_TRAILER' | 'TANKER_ALUMINUM' | 'TANKER_INTERMODAL' | 'TANKER_STEEL' | 'TRUCK_AND_TRAILER' | 'DRY_VAN' | 'VAN' | 'VAN_AIR_RIDE' | 'VAN_BLANKET_WRAP' | 'VAN_CONESTOGA' | 'VAN_DOUBLE' | 'VAN_HAZMAT' | 'VAN_HOTSHOT' | 'VAN_INSULATED' | 'VAN_INTERMODAL' | 'VAN_LIFT_GATE' | 'VAN_LOGISTICS' | 'VAN_OPEN_TOP' | 'VAN_FLATBED' | 'VAN_FLATBED_TARPS' | 'VAN_FLATBET' | 'VAN_FLATBET_TARPS' | 'VAN_REEFER' | 'VAN_PALLET_EXCHANGE' | 'VAN_ROLLER_BED' | 'VAN_TRIPLE' | 'VAN_VENTED' | 'VAN_CURTAINS' | 'VAN_TEAM'

Optional parameter that will return available capacity specific to the type of truck requested.

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.