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

Returns the packing list item

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" -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=YOURTOKEN"

Returned payload:

{
   "packing_list_item" : {
      "shipping_marks" : "123123 1231 312",
      "destination_code": "WOHO",
      "items_at_terminal_destination_count": 2,
      "items_at_terminal_count": 2,
      "items_delivered_count": 0,
      "reference_number" : "DO1231",
      "weight" : 100,
      "consignee_address" : "123 Rue due centre",
      "dock_receipt_number" : "DR1",
      "description" : "10 Drum of Rum",
      "quantity" : 10,
      "stripped_quantity": "9",
      "container" : {
         "number" : "KOSU2200161"
      },
      "consignee" : {
         "name" : "MARENCO LTD"
      },
      "bill_of_lading" : {
         "number" : "TEST123"
      },
      "volume" : 100,
      "package_type" : {
         "code" : "1A",
         "description" : "drum"
      },
      "has_been_stripped": true,
      "has_been_delivered": false,
      "cargoes": [
        {
          ....,
          "description": "Wood",
          "current_location_arrived_at": "2018-01-26T02:08:00Z",
          "current_location_type": "YardArea",
          "current_location": "SHED4",
          "current_location_code": "WOHO",
          ...
        },
        {
          ....,
          "description": "More Wood",
          "current_location_arrived_at": "2018-01-26T02:08:00Z",
          "current_location_type": "YardArea",
          "current_location": "SHED4",
          "current_location_code": "WOHO",
          ...
        }
      ]
   }
}

Params

Param name Description
reference_number
required

Validations:

  • Must be a String