Search
K
Listings API V2

VehicleAttributeResponse

object

Details of a vehicle attribute.

vehicleAttributeTypestring

The value of the vehicle attribute.

Allowed values:DAMAGEFEATURE

Example:DAMAGE

vehicleAttributeNamestring

The name of the vehicle attribute.

Allowed values:CAB_AND_CHASSISCONVERTIBLECREW_CABDOES_NOT_ROLLDOES_NOT_RUNDOES_NOT_STEERDUAL_REAR_WHEELEXTENDED_CABEXTENDED_LENGTHFLAT_BEDFLAT_TIREFRAME_DAMAGEIS_4X2IS_4X4LADDER_RACKLEFT_KITLONG_BEDNO_KEYSNO_TIRESOTHER_INOPOTHER_INOP_NOTESOVERSIZE_TIRESOVERSIZED_UNITRAISED_ROOFREGULAR_CABSHORT_BEDSINGLE_REAR_WHEELSTANDARD_LENGTHTOOLBOXUTILITY_BODY

Example:FLAT_BED

valuestring

The value of the vehicle attribute.

Example:true

Example
{
  "vehicleAttributeType": "DAMAGE",
  "vehicleAttributeName": "FLAT_BED",
  "value": "true"
}

VehicleCollection

object

A paginated collection of vehicles.

hrefstring

The URL used to query the current collection of the resource.

Example:https://marketplace-api.centraldispatch.com/listing-vehicles/mine?limit(5,1)

itemsarray[object]

Details of a vehicle.

Show Child Parameters
limitinteger(int32)

The maximum number of items to be returned in the response.

Example:1

nextstring

The URL to the next page of the collection, if available.

Example:https://marketplace-api.centraldispatch.com/listing-vehicles/mine?limit(5,1)

previousstring

The URL to the previous page of the collection, if available.

Example:https://marketplace-api.centraldispatch.com/listing-vehicles/mine?limit(6,1)

firststring

The URL to the first page of the collection.

Example:https://marketplace-api.centraldispatch.com/listing-vehicles/mine?limit(1,1)

countinteger(int32)

The total count of resources in the collection.

Example:23

Example
{
  "href": "https://marketplace-api.centraldispatch.com/listing-vehicles/mine?limit(5,1)",
  "items": [
    {
      "vehicleId": "b331c130-e89b-12d3-a456-426614174000",
      "listing": "https://marketplace-api.centraldispatch.com/listings/id/42220470",
      "externalVehicleId": "EXT123456",
      "pickupStopNumber": 1,
      "dropOffStopNumber": 2,
      "vin": "KL8CH6SA6NC001234",
      "year": 2022,
      "make": "Chevrolet",
      "model": "Spark",
      "trim": "LS",
      "vehicleType": "ATV",
      "vehicleTypeOther": "CAR",
      "color": "Red",
      "licensePlate": "B314PIE",
      "licensePlateState": "CA",
      "lotNumber": "LOT789",
      "isInoperable": false,
      "tariff": 1030.5,
      "tariffCurrency": "USD",
      "additionalInfo": "The vehicle is in the back of the lot behind the big tree.",
      "oversized": false,
      "shippingSpecs": {
        "height": 58,
        "width": 62,
        "length": 143,
        "weight": 2246
      },
      "vehicleAttributes": [
        {
          "vehicleAttributeType": "DAMAGE",
          "vehicleAttributeName": "FLAT_BED",
          "value": "true"
        }
      ],
      "noKeys": true,
      "noTires": false,
      "flatTire": true,
      "frameDamage": false,
      "doesNotRun": true,
      "doesNotSteer": false,
      "doesNotRoll": false,
      "inOpNotes": "Vehicle does not start."
    }
  ],
  "limit": 1,
  "next": "https://marketplace-api.centraldispatch.com/listing-vehicles/mine?limit(5,1)",
  "previous": "https://marketplace-api.centraldispatch.com/listing-vehicles/mine?limit(6,1)",
  "first": "https://marketplace-api.centraldispatch.com/listing-vehicles/mine?limit(1,1)",
  "count": 23
}

VehicleRequest

object

Details of a vehicle.

vehicleIdstring(uuid)

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

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.

<= 50 characters

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. Must be greater than pickupStopNumber.

Example:2

vinstring

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

<= 50 characters

Example:KL8CH6SA6NC001234

yearinteger(int32)

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

Example:2022

makestring

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

<= 50 characters

Example:Chevrolet

modelstring

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

<= 50 characters

Example:Spark

trimstring

The manufacturer’s trim of the vehicle.

<= 100 characters

Example:LS

vehicleTypestring

The type of vehicle e.g. CAR, TRUCK.

Allowed values:ATVBOATCARHEAVY_EQUIPMENTLARGE_YACHTMOTORCYCLEOTHERPICKUPRVSUVTRAVEL_TRAILERVAN

Default:OTHER

Example:CAR

vehicleTypeOtherstring

The description of the vehicle type. Will default to Other when null and vehicleType is OTHER.

<= 100 characters

Example:Golf Cart

colorstring

The color of the vehicle.

<= 100 characters

Example:Red

licensePlatestring

The license plate of the vehicle.

<= 20 characters

Example:B314PIE

licensePlateStatestring

The two-letter state abbreviation of the vehicle’s license plate.

<= 2 characters

Example:CA

lotNumberstring

The lot number of the vehicle.

<= 50 characters

Example:LOT789

isInoperableboolean

Indicates whether the vehicle is inoperable.

Default:false

tariffnumber(double)

The tariff on the vehicle.

Example:1030.5

tariffCurrencystring

The currency of the monetary field.

Allowed values:USD

Default:USD

Example:USD

additionalInfostring

Additional information.

<= 500 characters

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

oversizedboolean

Indicates whether the load is oversized.

Default:false

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.

Default:false

Example:true

noTiresboolean

Indicates whether the vehicle has no tires.

Default:false

flatTireboolean

Indicates whether the vehicle has a flat tire.

Default:false

Example:true

frameDamageboolean

Indicates whether the vehicle has frame damage.

Default:false

doesNotRunboolean

Indicates whether the vehicle does not run.

Default:false

Example:true

doesNotSteerboolean

Indicates whether the vehicle does not steer.

Default:false

doesNotRollboolean

Indicates whether the vehicle does not roll.

Default:false

inOpNotesstring

Notes about the inoperable condition of the vehicle.

<= 200 characters

Example:Vehicle does not start.

Example
{
  "vehicleId": "vehicleId",
  "externalVehicleId": "EXT123456",
  "pickupStopNumber": 1,
  "dropoffStopNumber": 2,
  "vin": "KL8CH6SA6NC001234",
  "year": 2022,
  "make": "Chevrolet",
  "model": "Spark",
  "trim": "LS",
  "vehicleType": "CAR",
  "vehicleTypeOther": "Golf Cart",
  "color": "Red",
  "licensePlate": "B314PIE",
  "licensePlateState": "CA",
  "lotNumber": "LOT789",
  "isInoperable": false,
  "tariff": 1030.5,
  "tariffCurrency": "USD",
  "additionalInfo": "The vehicle is in the back of the lot behind the big tree.",
  "oversized": false,
  "shippingSpecs": {
    "height": 58,
    "width": 62,
    "length": 143,
    "weight": 2246
  },
  "vehicleAttributes": [
    {
      "vehicleAttributeType": "DAMAGE",
      "vehicleAttributeName": "FLAT_BED",
      "value": "true"
    }
  ],
  "noKeys": true,
  "noTires": false,
  "flatTire": true,
  "frameDamage": false,
  "doesNotRun": true,
  "doesNotSteer": false,
  "doesNotRoll": false,
  "inOpNotes": "Vehicle does not start."
}

VehicleResponse

object

Details of a vehicle.

vehicleIdstring(uuid)

The ID of the vehicle.

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

listingstring

The fully qualified URL of the listing.

Example:https://marketplace-api.centraldispatch.com/listings/id/42220470

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: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, TRUCK.

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.

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
{
  "vehicleId": "b331c130-e89b-12d3-a456-426614174000",
  "listing": "https://marketplace-api.centraldispatch.com/listings/id/42220470",
  "externalVehicleId": "EXT123456",
  "pickupStopNumber": 1,
  "dropOffStopNumber": 2,
  "vin": "KL8CH6SA6NC001234",
  "year": 2022,
  "make": "Chevrolet",
  "model": "Spark",
  "trim": "LS",
  "vehicleType": "ATV",
  "vehicleTypeOther": "CAR",
  "color": "Red",
  "licensePlate": "B314PIE",
  "licensePlateState": "CA",
  "lotNumber": "LOT789",
  "isInoperable": false,
  "tariff": 1030.5,
  "tariffCurrency": "USD",
  "additionalInfo": "The vehicle is in the back of the lot behind the big tree.",
  "oversized": false,
  "shippingSpecs": {
    "height": 58,
    "width": 62,
    "length": 143,
    "weight": 2246
  },
  "vehicleAttributes": [
    {
      "vehicleAttributeType": "DAMAGE",
      "vehicleAttributeName": "FLAT_BED",
      "value": "true"
    }
  ],
  "noKeys": true,
  "noTires": false,
  "flatTire": true,
  "frameDamage": false,
  "doesNotRun": true,
  "doesNotSteer": false,
  "doesNotRoll": false,
  "inOpNotes": "Vehicle does not start."
}