Listings API V1

TrailerType

string

The vehicle trailer type.

Allowed values:OPENENCLOSEDDRIVEWAY

Example

Vehicle

object

Details of a vehicle.

idstring

The ID of the vehicle. Read-only on create (POST). Required on update (PUT).

Example:b331c130-e89b-12d3-a456-426614174000

vinstring

The vehicle identification number (VIN). Required if year, make, model, and vehicleType are null.

<= 17 characters

Example:KL8CH6SA6NC001234

vehicleTypestring

The vehicle type.

Allowed values:ATVBOATCARHEAVY_EQUIPMENTLARGE_YATCHMOTORCYCLEPICKUPRVSUVTRAVEL_TRAILERVANOTHER

Example:CAR

vehicleTypeOtherstring

The description of the vehicle type. Required when vehicle type is OTHER.

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

yearinteger(int32)

The 4 digit year of the vehicle. Required if vin is null.

<= 4 characters

Example:2022

makestring

The manufacturer’s make of the vehicle. Required if vin is null.

Example:Chevrolet

modelstring

The manufacturer’s model of the vehicle. Required if vin is null.

Example:Spark

qtyinteger(int32)

The quantity of vehicles. Required if vin is null.

Example:23

additionalInfostring

Additional information.

<= 200 characters

Example:The vehicle is in the back of the lot behind the big tree.

wideLoadboolean

Indicates whether the load is a wide load.

shippingSpecsobject

Details of the shipping specifications of a vehicle.

Show Child Parameters
externalVehicleIdstring

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:RND10 CHEV

Example

VehicleType

string

The vehicle type.

Allowed values:ATVBOATCARHEAVY_EQUIPMENTLARGE_YATCHMOTORCYCLEPICKUPRVSUVTRAVEL_TRAILERVANOTHER

Example