PATCH /api/v1/packing_list_items/:reference_number.json

Supported Formats

json

Errors

Code Description
400 Bad Request.
404 Not Found.
422 Unprocessable Entity.
500 Internal Server Error.

Examples

curl "https://app.octopi.co/api/v1/packing_list_items/:reference_number.json'" -X PATCH -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=ADD TOKEN HERE -d '{ "packing_list_item": { "package_type": "box", "extra_attributes": { "foo": "bar" }, "quantity": 5 } }'"

Returned payload:
{
  "packing_list_item": {
    "reference_number": "01234",
    "destination_code": "BBB123",
    "items_at_terminal_destination_count": 0,
    "items_at_terminal_count": 0,
    "items_delivered_count": 0,
    "bill_of_lading": {
      "number": "TEST123"
    },
    "container": {
      "number": "BSIU1234567",
      "client_identifier": null,
      "status": "full",
      "delivery_type": null,
      "container_type": {
        "code": "40HC",
        "description": "",
        "iso_type_code": "45G1"
      }
    },
    "consignee": {
      "name": "DAN'S AUTO RECYCLING"
    },
    "agent": {
      "name": null
    },
    "vessel": {
      "name": null
    },
    "voyage": {
      "number": null
    },
    "quantity": 5,
    "weight": 45.359237,
    "volume": 45.0,
    "package_type": {
      "code": "4A",
      "description": "box"
    },
    "description": "Many things in here",
    "consignee_address": "123 St. 21122",
    "shipping_marks": "15155",
    "dock_receipt_number": "ABC12312",
    "extra_attributes": {
      "foo": "bar"
    },
    "has_been_stripped": false,
    "has_been_delivered": false,
    "stripped_quantity": 0,
    "cargoes": []
  }
}

Params

Param name Description
packing_list_item
required

Validations:

  • Must be a Hash
packing_list_item[reference_number]
required

The reference number for this packing list item.

Validations:

  • Must be a String
packing_list_item[consignee]
optional

The consignee for this packing list item.

Validations:

  • Must be a String
packing_list_item[description]
optional

The goods description for this packing list item.

Validations:

  • Must be a String
packing_list_item[extra_attributes]
optional

Extra attributes for this packing list item.

Validations:

  • Must be a Hash
packing_list_item[package_type]
optional

The package type or package type code (eg. “box” or “4A”) of this packing list item.

Validations:

  • Must be a String
packing_list_item[package_weight]
optional

The package weight of this packing list item.

Validations:

  • Must be a decimal number.
packing_list_item[quantity]
optional

The quantity of this packing list item.

Validations:

  • Must be a number.