Skip to main content

VehicleObject

an object containing the vehicle details

iduuid

the unique identifier for the vehicle

Example: ee6a7af7-650d-499b-8e32-58a52ffdb7bc
vinstring

Vehicle Identification Number

Example: 1G8AL52F03Z157046
yearinteger

Production year of the vehicle

Example: 2020
makestring

Manufacturer of the vehicle

Example: Dodge
modelstring

The model of the vehicle produced bt the manufacturer

Example: RAM ProMaster
trimstring

The specific trim level of this vehicle model

Example: Cargo Van
typeVehicleType (string)

The type of vehicle for this shipment

Possible values: [car, suv, van, truck, truck_ext, work_van, service_body]

Example: van
is_modifiedboolean

A flag determining if the vehicle has modifications

Example: false
is_inoperableboolean

A flag determining if the vehicle is in operable

Example: false
notesstring

Notes about any modifications, issues or warnings about the vehicle

Example: Vehicle is rusting underneath
weightnumber

The curb weight of the vehicle in lbs

Example: 6600
heightnumber

the height of the vehicle

Example: 72.3
widthnumber

the width of the vehicle

Example: 64.5
lengthnumber

the length of the vehicle

Example: 90.8
photos object[]

An arroy of vehicle photos

  • Array [
  • iduuid

    A unique identifier for the photo

    Example: 74c1f768-b78a-497e-916b-8fb62be13ef2
    typestring

    defines the type of photo based on how it was added

    Possible values: [sample, pickup, delivery]

    Example: pickup
    urlurl

    the download url for the photo

    Example: https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae.png
    latitudenumber

    the latitude of the photo when it was taken (only if taken by the carrier)

    Example: 32.9248531
    longitudenumber

    the longitude of the photo when it was taken (only if taken by tge carrier)

    Example: -96.8881391
    created_dttmdate

    the date time the photo was created

    Example: 2024-08-10T08:00:00.000+0000
  • ]
  • VehicleObject
    {
    "id": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
    "vin": "1G8AL52F03Z157046",
    "year": 2020,
    "make": "Dodge",
    "model": "RAM ProMaster",
    "trim": "Cargo Van",
    "type": "van",
    "is_modified": false,
    "is_inoperable": false,
    "notes": "Vehicle is rusting underneath",
    "weight": 6600,
    "height": 72.3,
    "width": 64.5,
    "length": 90.8,
    "photos": [
    {
    "id": "74c1f768-b78a-497e-916b-8fb62be13ef2",
    "type": "pickup",
    "url": "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae.png",
    "latitude": 32.9248531,
    "longitude": -96.8881391,
    "created_dttm": "2024-08-10T08:00:00.000+0000"
    }
    ]
    }