Supported Formats

json

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.
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 String


POST /api/v1/bill_of_ladings/:bill_of_lading_number/packing_list_items.json

Supported Formats

json

Errors

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

Examples

curl "https://app.octopi.co/api/v1/bill_of_ladings/:bill_of_lading_number/packing_list_items.json'" -d '{ "client_identifier": "packing_list_client_indetifier", "container_client_identifier": "CONTAINER_IDENTIFIER", "consignee_name": "Consignee Name", "packing_list_item": { "reference_number": "GAF001234","quantity": 5, "weight": 100.00, "volume": 45.00, "description": "TEXT", "consignee_address": "123 St. 21122", "package_type": "PK", "destination_code": "BBB-123" }}' -X POST -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=ADD TOKEN HERE"
Example Payload:

{
    "container_client_identifier": "CONTAINER_IDENTIFIER",
    "consignee_name": "Consignee Name",
    "client_indentifier": "Packing List Client Identifier",
    "packing_list_item": {
        "reference_number": "GAF001234",
        "quantity": 5,
        "weight": 100.00,
        "volume": 45.00,
        "description": "TEXT",
        "consignee_address": "123 St. 21122",
        "shipping_marks": "15155",
        "dock_receipt_number": "ABC12312",
        "package_type": "STRING",
        "destination_code": "BBB-123"
    }
}

Params

Param name Description
packing_list_item
optional

Validations:

  • Must be a Hash

packing_list_item[reference_number]
optional

Validations:

  • Must be String

packing_list_item[quantity]
optional

Validations:

  • Must be Integer

packing_list_item[weight]
optional

Validations:

  • Must be Float

packing_list_item[volume]
optional

Validations:

  • Must be Float

packing_list_item[description]
optional

Validations:

  • Must be String

packing_list_item[consignee_address]
optional

Validations:

  • Must be String

packing_list_item[shipping_marks]
optional

Validations:

  • Must be String

packing_list_item[dock_receipt_number]
optional

Validations:

  • Must be String

bill_of_lading_number
required

Validations:

  • Must be String

container_number
optional

Validations:

  • Must be String

container_client_identifier
optional

Validations:

  • Must be String

consignee_name
required

Validations:

  • Must be String

client_identifier
required

Validations:

  • Must be String


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

Supported Formats

json

Errors

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

Examples

curl "https://app.octopi.co/api/v1/packing_list_items/:reference_number.json'" -X DELETE -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=ADD TOKEN HERE"

Params

Param name Description
reference_number
required

Validations:

  • Must be String