VehicleRequest
objectDetails of a vehicle.
Details of a vehicle attribute.
Show Child Parameters
The ID of the vehicle. A UUID will be assigned if not sent.
Example:b331c130-e89b-12d3-a456-426614174000
A vehicle identifier managed by the user. Shippers can use this field to map Central Dispatch dispatch ID to a vehicle record in their local TMS.
Example:EXT123456
The vehicle identification number (VIN). Required if year, make, model values are not supplied.
Example:KL8CH6SA6NC001234
The total travel distance.
Example:267
The units of distance.
Default:MILES
Example:MILES
The stop number (the sequential number of the stop along the route) of the pick up location.
Example:1
The stop number (the sequential number of the stop along the route) of the delivery location.
Example:2
The price to be paid to the carrier for completing the delivery of this vehicle (reference only).
Example:500
The currency of carrierPrice.
Default:USD
Example:USD
The type of vehicle e.g. CAR, TRUCK.
Allowed values:ATVBOATCARHEAVY_EQUIPMENTLARGE_YACHTMOTORCYCLEPICKUPRVSUVTRAVEL_TRAILERVANOTHER
Example:CAR
The size of the vehicle.
Allowed values:SMALLMEDIUMLARGEXLARGEWIDELOADOVERSIZEOTHER
Example:MEDIUM
The date the shipper would like the vehicle to be picked up, in UTC/ISO 8601 format.
Example:2025-07-15T00:00:00.000Z
The date the shipper would like the vehicle to be picked up, in UTC/ISO 8601 format.
Example:2025-08-15T00:00:00.000Z
The color of the vehicle.
Example:Red
Indicates whether the vehicle is inoperable.
Indicates whether the transport is enclosed.
Default:false
Example:true
The 4 digit year of the vehicle. Required if vin is not supplied.
Example:2022
The manufacturer’s make of the vehicle. Required if vin is not supplied.
Example:Chevrolet
The manufacturer’s model of the vehicle. Required if vin is not supplied.
Example:Spark
The manufacturer’s sub-model of the vehicle.
Example:ACTIV
The weight of the vehicle.
Example:2246
The units of weight.
Default:LBS
Example:lbs
The type of inspection the vehicle requires.
Allowed values:STANDARDART
Example:ART
Indicates whether the vehicle is a drive-away.
Default:false
Example:true
The license plate of the vehicle.
Example:B314PIE
The two-letter state abbreviation of the vehicle’s license plate.
Example:CA
The lot number of the vehicle.
Example:LOT789
Additional information.
Example:The vehicle is in the back of the lot behind the big tree.
The type of pick up date.
Allowed values:ESTIMATEDEXACTLYNO_EARLIER_THANNO_LATER_THAN
Default:ESTIMATED
Example:NO_EARLIER_THAN
The type of delivery date.
Allowed values:ESTIMATEDEXACTLYNO_EARLIER_THANNO_LATER_THAN
Default:ESTIMATED
Example:ESTIMATED
The tariff on the vehicle.
Example:1030.5
The manufacturer’s trim of the vehicle.
Example:LS
The type of fuel.
Example:Gas
The height of the vehicle.
Example:58
The width of the vehicle.
Example:62
The length of the vehicle.
Example:143
The units of length.
Default:inches
Example:inches
The units of width.
Default:inches
Example:62
The units of height.
Default:inches
Example:inches
Indicates the shipper requests for the carrier to use the Central Dispatch Mobile App to perform vehicle inspection at pickup and delivery. If true, the carrier will be asked to acknowledge the request before accepting the load.
Default:false
Example:true
Indicates whether the require inspection requirement was acknoowledged.
Default:false
Example:true
VehicleResponse
objectDispatch vehicle details.
Details of a vehicle.
Show Child Parameters
Details of a vehicle date change.
Show Child Parameters
Details of a vehicle status change.
Show Child Parameters
The ID of the shipment description.
Example:b331c130-e89b-12d3-a456-426614174000
The system assigned UUID of the stop.
Example:4e2efc84-6add-435c-9f12-8b19e3e5ba21
The stop number (the sequential number of the stop along the route) of the delivery location.
Example:fa110000-e89b-12d3-a456-426614174000
Indicates whether the transport is enclosed.
Example:true
The date and time the dispatch was created, in UTC/ISO 8601 format.
Example:2024-10-31T00:00:00Z
The date and time the dispatch was last updated, in UTC/ISO 8601 format.
Example:2024-10-15T00:00:00Z
The Central Dispatch user ID of the user who last updated the dispatch.
Example:d71b5750-e89b-12d3-a456-426614174000
The ID of the vehicle.
Example:b331c130-e89b-12d3-a456-426614174000
The ID of the dispatch.
Example:d159acc0-e89b-12d3-a456-426614174000
An identifier managed by the user. Shippers can use this field to map Central Dispatch dispatch ID to a record (e.g. order, shipment, dispatch) in their local TMS.
Example:RND10 CHEV
The ID of the vehicle.
Example:b331c130-e89b-12d3-a456-426614174000
The vehicle identification number (VIN).
Example:KL8CH6SA6NC001234
The estimated pick up date, in UTC/ISO 8601 format.
Example:2025-11-05T00:00:00.000Z
The estimated delivery date, in UTC/ISO 8601 format.
Example:2025-07-15T00:00:00.000Z
The actual pick up date and time, in UTC/ISO 8601 format.
Example:2025-11-05T00:00:00.000Z
The actual delivery date and time, in UTC/ISO 8601 format.
Example:2025-08-15T00:00:00.000Z
The date the carrier estimates the vehicle will be picked up, in UTC/ISO 8601 format.
Example:2025-11-05T00:00:00.000Z
The date the carrier estimates the vehicle will be dropped off, in UTC/ISO 8601 format.
Example:2025-07-15T00:00:00.000Z
The date the shipper would like the vehicle to be picked up, in UTC/ISO 8601 format.
Example:2025-11-05T00:00:00.000Z
The date the shipper would like the vehicle to be dropped off, in UTC/ISO 8601 format.
Example:2025-07-15T00:00:00.000Z
The status of the vehicle.
Example:PENDING_PICKUP
The price to be paid to the carrier for completing the delivery of this vehicle (reference only).
The currency of carrierPrice.
Example:USD
The total travel distance.
Example:267
The units of distance.
Example:MILES
A vehicle identifier managed by the user. Shippers can use this field to map Central Dispatch dispatch ID to a vehicle record in their local TMS.
Example:EXT123456
Indicates whether action is needed.
Default:false
The type of inspection the vehicle requires.
Example:ART
Indicates whether the vehicle is a drive-away.
Default:false
Example:true
Indicates whether the load is oversized.
Default:false
Indicates whether the load is a wide load.
Default:false
The type of pick up date.
Example:NO_EARLIER_THAN
The type of delivery date.
Example:ESTIMATED
Indicates the shipper requests for the carrier to use the Central Dispatch Mobile App to perform vehicle inspection at pickup and delivery. If true, the carrier will be asked to acknowledge the request before accepting the load.
Default:false
Example:true
Indicates whether the require inspection requirement was acknoowledged.
Default:false
Example:true
VehicleStatusChangeResponse
objectDetails of a vehicle status change.
The date and time of the status change, in UTC/ISO 8601 format.
Example:2024-10-31T00:00:00Z
The status of the vehicle.
Example:PENDING_PICKUP