Listings API V2
DraftVehicleResponse
objectDetails of a vehicle on a draft listing.
vehicleIdstring(uuid)
The ID of the vehicle.
Example:b331c130-e89b-12d3-a456-426614174000
externalVehicleIdstring
A vehicle identifier managed by the user. Shippers can use this field to map a vehicle record in their local TMS to a Central Dispatch record.
Example:EXT123456
pickupStopNumberinteger(int32)
The stop number where the vehicle will be picked up.
Example:1
dropOffStopNumberinteger(int32)
The sequential stop number where the vehicle will be delivered.
Example:2
vinstring
The vehicle identification number (VIN).
Example:KL8CH6SA6NC001234
yearinteger(int32)
The 4 digit year of the vehicle.
Example:2022
makestring
The manufacturer’s make of the vehicle.
Example:Chevrolet
modelstring
The manufacturer’s model of the vehicle.
Example:Spark
trimstring
The manufacturer’s trim of the vehicle.
Example:LS
vehicleTypestring
The type of vehicle e.g. CAR, PICKUP, SUV. This list is not exhaustive and additional values may be added at any time.
Allowed values:ATVBOATCARHEAVY_EQUIPMENTLARGE_YACHTMOTORCYCLEOTHERPICKUPRVSUVTRAVEL_TRAILERVAN
vehicleTypeOtherstring
The description of the vehicle type.
Example:CAR
colorstring
The color of the vehicle.
Example:Red
licensePlatestring
The license plate of the vehicle.
Example:B314PIE
licensePlateStatestring
The two-letter state abbreviation of the vehicle’s license plate.
Example:CA
lotNumberstring
The lot number of the vehicle.
Example:LOT789
isInoperableboolean
Indicates whether the vehicle is inoperable.
tariffnumber(double)
The tariff on the vehicle.
Example:1030.5
tariffCurrencystring
The currency of the monetary field. This list is not exhaustive and additional values may be added at any time.
Allowed values:USD
Default:USD
Example:USD
additionalInfostring
Additional information.
Example:The vehicle is in the back of the lot behind the big tree.
oversizedboolean
Indicates whether the load is oversized.
shippingSpecsobject
Details of the shipping specifications of a vehicle.
Show Child Parameters
vehicleAttributesarray[object]
Details of a vehicle attribute.
Show Child Parameters
noKeysboolean
Indicates whether the vehicle has no keys.
Example:true
noTiresboolean
Indicates whether the vehicle has no tires.
flatTireboolean
Indicates whether the vehicle has a flat tire.
Example:true
frameDamageboolean
Indicates whether the vehicle has frame damage.
doesNotRunboolean
Indicates whether the vehicle does not run.
Example:true
doesNotSteerboolean
Indicates whether the vehicle does not steer.
doesNotRollboolean
Indicates whether the vehicle does not roll.
inOpNotesstring
Notes about the inoperable condition of the vehicle.
Example:Vehicle does not start.
Example
Error
objectDetails of an error or issue.
codestring
The code used for the issue.
Example:resource.issue_type
messagestring
A detailed message.
Example:The issue happened because something is wrong.
propertystring
The property to which the issue is associated.
Example:person
propertiesobject
Additional properties related to the issue.
Example:{"firstName":"D0nn@","lastName":"Sm!th"}
Example
ErrorAlt
objectDetails of an error or issue.
errorIDstring
The ID of the error.
Example:157a16f0-503d-4256-ba60-a4876e8eb9bb
codestring
The code used for the issue.
Example:resource.issue_type
descriptionstring
A detailed message.
Example:The issue happened because something is wrong.
propertiesarray[object]
Details of an error’s property.
Show Child Parameters
Example
ErrorAltProperty
objectDetails of an error’s property.
propertystring
The name of the property.
Example:person
valuestring
The value of the property.
Example:J0hn D03
Example
Errors
objectAn error occurred, and the request could not be completed.
errorsarray[object]
Details of an error or issue.
Show Child Parameters
Example