VehicleAttributeType
stringThe value of the vehicle attribute.
Allowed values:DAMAGEFEATURE
Default:FEATURE
VehicleCollection
objectA paginated collection of vehicles.
The URL used to query the current collection of the resource.
Example:https://marketplace-api.centraldispatch.com/listing-vehicles/mine?limit(5,1)
Details of a vehicle.
Show Child Parameters
The maximum number of items to be returned in the response.
Example:1
The URL to the next page of the collection, if available.
Example:https://marketplace-api.centraldispatch.com/listing-vehicles/mine?limit(5,1)
The URL to the previous page of the collection, if available.
Example:https://marketplace-api.centraldispatch.com/listing-vehicles/mine?limit(6,1)
The URL to the first page of the collection.
Example:https://marketplace-api.centraldispatch.com/listing-vehicles/mine?limit(1,1)
The total count of resources in the collection.
Example:23
VehicleRequest
objectDetails of a vehicle.
The system assigned UUID of the vehicle. Read-only on create (POST). Required on update (PUT).
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.
<= 50 characters
Example:EXT123456
The stop number where the vehicle will be picked up.
Example:1
The sequential stop number where the vehicle will be delivered. Must be greater than pickupStopNumber.
Example:2
The vehicle identification number (VIN). Required if year, make and model are null.
<= 50 characters
Example:KL8CH6SA6NC001234
The 4 digit year of the vehicle. Required if vin is null.
Example:2022
The manufacturer’s make of the vehicle. Required if vin is null.
<= 50 characters
Example:Chevrolet
The manufacturer’s model of the vehicle. Required if vin is null.
<= 50 characters
Example:Spark
The manufacturer’s trim of the vehicle.
<= 100 characters
Example:LS
The type of vehicle e.g. CAR, TRUCK.
Allowed values:ATVBOATCARHEAVY_EQUIPMENTLARGE_YACHTMOTORCYCLEOTHERPICKUPRVSUVTRAVEL_TRAILERVAN
Default:OTHER
Example:CAR
The description of the vehicle type. Will default to Other when null and vehicleType is OTHER.
<= 100 characters
Example:Golf Cart
The color of the vehicle.
<= 100 characters
Example:Red
The license plate of the vehicle.
<= 20 characters
Example:B314PIE
The two-letter state abbreviation of the vehicle’s license plate.
<= 2 characters
Example:CA
The lot number of the vehicle.
<= 50 characters
Example:LOT789
Indicates whether the vehicle is inoperable.
Default:false
The tariff on the vehicle.
Example:1030.5
The currency of the monetary field.
Allowed values:USD
Default:USD
Example:USD
Additional information.
<= 500 characters
Example:The vehicle is in the back of the lot behind the big tree.
Indicates whether the load is a wide load.
Default:false
Details of the shipping specifications of a vehicle.
Show Child Parameters
Details of a vehicle attribute.
Show Child Parameters
Indicates whether the vehicle has no keys.
Default:false
Example:true
Indicates whether the vehicle has no tires.
Default:false
Indicates whether the vehicle has a flat tire.
Default:false
Example:true
Indicates whether the vehicle has frame damage.
Default:false
Indicates whether the vehicle does not run.
Default:false
Example:true
Indicates whether the vehicle does not steer.
Default:false
Indicates whether the vehicle does not roll.
Default:false
Notes about the inoperable condition of the vehicle.
<= 200 characters
Example:Vehicle does not start.
VehicleResponse
objectDetails of a vehicle.
The ID of the vehicle.
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 stop number where the vehicle will be picked up.
Example:1
The sequential stop number where the vehicle will be delivered.
Example:2
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 trim of the vehicle.
Example:LS
The type of vehicle e.g. CAR, TRUCK.
Allowed values:ATVBOATCARHEAVY_EQUIPMENTLARGE_YACHTMOTORCYCLEOTHERPICKUPRVSUVTRAVEL_TRAILERVAN
Default:OTHER
Example:CAR
The description of the vehicle type.
Example:CAR
The color of the vehicle.
Example:Red
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
Indicates whether the vehicle is inoperable.
The tariff on the vehicle.
Example:1030.5
The currency of the monetary field.
Allowed values:USD
Default:USD
Example:USD
Additional information.
Example:The vehicle is in the back of the lot behind the big tree.
Indicates whether the load is a wide load.
Details of the shipping specifications of a vehicle.
Show Child Parameters
Details of a vehicle attribute.
Show Child Parameters
Indicates whether the vehicle has no keys.
Example:true
Indicates whether the vehicle has no tires.
Indicates whether the vehicle has a flat tire.
Example:true
Indicates whether the vehicle has frame damage.
Indicates whether the vehicle does not run.
Example:true
Indicates whether the vehicle does not steer.
Indicates whether the vehicle does not roll.
Notes about the inoperable condition of the vehicle.
Example:Vehicle does not start.
VehicleType
stringThe type of vehicle e.g. CAR, TRUCK.
Allowed values:ATVBOATCARHEAVY_EQUIPMENTLARGE_YACHTMOTORCYCLEOTHERPICKUPRVSUVTRAVEL_TRAILERVAN
Default:OTHER