POST /api/v1/packing_list_items.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.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

Param name Description
packing_list_item
optional

Validations:

  • Must be a Hash
packing_list_item[reference_number]
optional

Validations:

  • Must be a String
packing_list_item[quantity]
optional

Validations:

  • Must be a Integer
packing_list_item[weight]
optional

Validations:

  • Must be a Float
packing_list_item[volume]
optional

Validations:

  • Must be a Float
packing_list_item[description]
optional

Validations:

  • Must be a String
packing_list_item[consignee_address]
optional

Validations:

  • Must be a String
packing_list_item[shipping_marks]
optional

Validations:

  • Must be a String
packing_list_item[dock_receipt_number]
optional

Validations:

  • Must be a String
bill_of_lading_number
required

Validations:

  • Must be a String
consignee_name
required

Validations:

  • Must be a String
packing_list_id
optional

The packing list’s ID. If unavailable, please ensure you provide a client identifier.

Validations:

  • Must be a String
client_identifier
optional

The packing list’s client identifier. If unavailable, please ensure you provide a packing list ID.

Validations:

  • Must be a String
container_client_identifier
optional

Validations:

  • Must be a String