GET /api/v1/vehicles/:id.json
Returns information about a specific vehicle

This API endpoint allows you to fetch information about a specific vehicle.

Supported Formats

json

Errors

Code	Description
404	Not found.
400	Bad request.
422	Unprocessable entity.
500	Internal server error.

Examples

curl "https://app.octopi.co/api/v1/vehicles/:id.json" -X GET -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=YOUR_TOKEN"'

{
  "vehicle": {
    "id": 12345,
    "reference_number": null,
    "quantity": 1,
    "goods": "Toyota Tacoma",
    "goods_description": "Toyota Tacoma",
    "shipping_marks": null,
    "usage": "export",
    "active_bill_of_ladings": "",
    "vin_number": "5TFUU4EN112",
    "consignee": "Consignee: CAPCOM AUTO SALES",
    "current_location_type": "Terminal",
    "current_location": "South Terminal",
    "weight_unit": "kg",
    "weight": 1508.19,
    "dimension_unit": "meter",
    "width": 1.83,
    "height": 1.68,
    "length": 4.83,
    "volume": "14.80",
    "pieces_per_package": null,
    "package_weight": 0,
    "yard_slot": null,
    "package_type_code": null,
    "package_type": null,
    "extra_attributes": null,
    "flex_fields": [
      {
        "label": "Color",
        "value": "Red"
      },
      {
        "label": "Year",
        "value": "2020"
      }
    ]
  }
}

Params

Param name	Description
id required	The Octopi ID or VIN of the vehicle. Validations: Must be a String