Packing_list_items
This resources allows you to create a packing list item in Octopi.

Returns the packing list item

Supported Formats

Errors

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

Supported Formats

Errors

Examples

curl "https://app.octopi.co/api/v1/packing_list_items.json'" -d '{ "client_identifier": "Test 123", "bill_of_lading_number": "KODA123", "consignee_name": "1 DANS AUTO RECYCLING", "packing_list_item": { "reference_number": "GAF0012345", "quantity": 5, "weight": 100.00, "volume": 45.00, "description": "TEXT", "consignee_address": "123 St. 21122", "shipping_marks": "15155", "dock_receipt_number": "ABC12312", "package_type": "4A", "destination_code": "BBB-123", "extra_attributes": { "over_stripped": "6.0" } } }' -X POST -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=ADD TOKEN HERE"

Returned Payload:
{
  "packing_list_item": {
    "reference_number": "GAF0012345",
    "destination_code": "BBB-123",
    "bill_of_lading": {
      "number": "KODA123"
    },
    "container": {
      "number": "BSIU9792565",
      "client_identifier": "Test 123"
    },
    "consignee": {
      "name": "1 DANS AUTO RECYCLING"
    },
    "quantity": 5,
    "weight": 45.359237,
    "volume": 45.0,
    "package_type": {
      "code": "4A",
      "description": null
    },
    "description": "TEXT",
    "consignee_address": "123 St. 21122",
    "shipping_marks": "15155",
    "dock_receipt_number": "ABC12312",
    "extra_attributes": {
      "over_stripped": "6.0"
    }
  }
}

Params

Supported Formats

Errors

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

Supported Formats

Errors

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