VehicleAttributeResponse
objectDetails of a vehicle attribute.
The ID of the shipment description vehicle attribute.
Example:157a16f0-503d-4256-ba60-a4876e8eb9bb
The ID of the shipment description vehicle details.
Example:2539f4b4-d3d6-45db-8df3-7ba768caba9b
The type of the vehicle attribute.
Allowed values:featuredamage
Example:damage
The name of the vehicle attribute.
Allowed values:oversizedUnitconvertibleflatBedregularCabcrewCabextendedCabtoolBoxladderRackleftKitshortBedlongBedis4x4is4x2singleRearWheeldualRearWheelraisedRoofextendedLengthutilityBodycabAndChassisstandardLengthoversizeTireshasKeysnoTiresflatTireframeDamagedoesNotRundoesNotSteerdoesNotRollotherInopotherInopNotesisTWIC
Example:hasKeys
The value of the vehicle attribute.
Example:true
VehicleDateChangeResponse
objectDetails of a vehicle date change.
The type of date.
Allowed values:ESTIMATED_PICKUPACTUAL_PICKUPESTIMATED_DROPOFFACTUAL_DROPOFFSHIPPER_REQUESTED_PICKUPSHIPPER_REQUESTED_DROPOFFCARRIER_ESTIMATED_PICKUPCARRIER_ESTIMATED_DROPOFF
Example:ESTIMATED_PICKUP
The date before the change, in UTC/ISO 8601 format.
Example:2025-08-15T00:00:00.000Z
The date after the change, in UTC/ISO 8601 format.
Example:2025-09-30T00:00:00.000Z
The ID of the date change reason.
Example:da1e0000-e89b-12d3-a456-426614174000
Additional notes regarding the date change.
Example:Weather delay.
The date and time the change was made, in UTC/ISO 8601 format.
Example:2024-09-10T00:00:00Z
VehicleDetailResponse
objectDetails of a vehicle.
Details of a vehicle attribute.
Show Child Parameters
The ID of the shipment description.
Example:519e0000-e89b-12d3-a456-426614174000
The ID of the shipment description vehicle details.
Example:2539f4b4-d3d6-45db-8df3-7ba768caba9b
The vehicle identification number (VIN).
Example:KL8CH6SA6NC001234
The 4 digit year of the vehicle.
Example:2022
The manufacturer’s make of the vehicle.
Example:Chevrolet
The manufacturer’s model of the vehicle.
Example:Spark
The manufacturer’s sub-model of the vehicle.
Example:ACTIV
The manufacturer’s trim of the vehicle.
Example:LS
The type of vehicle e.g. CAR, TRUCK.
Example:CAR
The description of the vehicle type.
Example:CAR
The color of the vehicle.
Example:Red
The weight of the vehicle.
Example:2246
The units of weight
and decodedWeight
.
Example:lbs
The decoded weight of the vehicle.
Example:2246
The size of the vehicle.
Example:MEDIUM
The length of the vehicle.
Example:143
The units of length
.
Default:inches
Example:inches
The decoded length of the vehicle in inches.
Example:143
The width of the vehicle.
Example:62
The units of width
.
Default:inches
Example:62
The decoded width of the vehicle in inches.
Example:62
The height of the vehicle.
Example:58
The units of height
.
Default:inches
Example:inches
The decoded height of the vehicle in inches.
Example:58
The license plate of the vehicle.
Example:B314PIE
The two-letter state abbreviation of the vehicle’s license plate.
Example:CA
The tariff on the vehicle.
Example:1030.50
The lot number of the vehicle.
Example:LOT789
Additional information.
Example:The vehicle is in the back of the lot behind the big tree.
Indicates whether the vehicle is inoperable.
The person who reported the vehicle details.
Example:d71b5750-e89b-12d3-a456-426614174000
The decoded type of the vehicle.
Example:CAR
The type of fuel.
Example:Gas
VehicleLocationResponse
objectDetails of a vehicle’s location.
The fully qualified URL of the dispatch.
Example:https://fulfillment-api.centraldispatch.com/api/fulfillments/id/d159acc0-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
The Central Dispatch user ID.
Example:d71b5750-e89b-12d3-a456-426614174000
The vehicle tracking device ID.
Example:2539f4b4-d3d6-45db-8df3-7ba768caba9b
The event type.
Allowed values:PICKED_UPIN_TRANSITDELIVERED
Example:IN_TRANSIT
The location ID of the vehicle’s last location.
Example:3fde6068-5fa2-4ae4-af16-06d65fc87dc9
The latitude of the location.
Example:33.81228788622535
The longitude of the location.
Example:-117.91836265987132
The date and time of the vehicle’s last location, in UTC/ISO 8601 format.
Example:2024-10-15T00:00:00Z
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