PATCH /api/v1/vehicles/:id.json
Update a vehicle's data.

This API endpoint allows you to update data for a specific vehicle.

Supported Formats

json

Errors

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

Examples

curl -X PUT \
"https://app.octopi.co/api/v1/vehicles/:id.json" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Token token=YOUR_TOKEN" \
-d '{
  "vehicle": {
    "goods_description": "Toyota Mirai",
    "quantity": 1,
    "consignee_names": [
      "VEHICLE CONSOL"
    ],
    "extra_attributes": {
      "foo": "bar"
    }
  }
}'

{
  "vehicle": {
    "id": 1234,
    "reference_number": null,
    "quantity": 1,
    "goods": "Toyota Tacoma",
    "goods_description": "Toyota Mirai",
    "shipping_marks": null,
    "usage": "export",
    "active_bill_of_ladings": "",
    "vin_number": "5TFUU4ENXEX107511",
    "consignee": "Consignee: VEHICLE CONSOL",
    "current_location_type": "Terminal",
    "current_location": "South Terminal",
    "weight_unit": "kg",
    "weight": 1508.00,
    "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": {
      "foo": "bar"
    },
    "flex_fields": [{
      "label": "Color",
      "value": "Red"
    }, {
      "label": "Year", 
      "value": "2023"
    }]
  }
}

Params

Param name Description
id
required

The Octopi ID or VIN of the vehicle you would like to update.

Validations:

  • Must be a String
goods_description
optional

The vehicle’s description.

Validations:

  • Must be a String
consignee_names
optional

An array of consignee names.

Validations:

  • Must be an array of String
shipping_line
optional

The vehicle’s shipping line.

Validations:

  • Must be a String
usage
optional

The vehicle’s usage.

Validations:

  • Must be a String
weight
optional

The vehicle’s weight in your organization’s weight unit preference.

Validations:

  • Must be a Numeric
height
optional

The vehicle’s height in your organization’s dimension unit preference.

Validations:

  • Must be a Numeric
length
optional

The vehicle’s length in your organization’s dimension unit preference.

Validations:

  • Must be a Numeric
width
optional

The vehicle’s width in your organization’s dimension unit preference.

Validations:

  • Must be a Numeric
year
optional

The vehicle’s year.

Validations:

  • Must be a Numeric
make
optional

The vehicle’s make.

Validations:

  • Must be a String
model
optional

The vehicle’s model.

Validations:

  • Must be a String
color
optional

The vehicle’s color.

Validations:

  • Must be a String
quantity
optional

The vehicle’s quantity.

Validations:

  • Must be a Numeric
package_weight
optional

The vehicle’s package weight.

Validations:

  • Must be a Numeric
extra_attributes
optional

A key-value pair of extra attributes for the vehicle.

Validations:

  • Must be a Hash