Load_lists::Load_list_items
This resource allows you to create or delete dynamic load list items in Octopi.

Supported Formats

json
>>>

GET /api/v1/load_lists/:load_list_id/load_list_items.json
Retrieves the list of load list items for a specified load list.

Supported Formats

json

Errors

Code Description
404 Resource Not Found
422 Validation Error
500 Internal Server Error

Examples

curl 'https://app.octopi.co/api/v1/load_lists/LOAD_LIST_ID/load_list_items' \
  -X 'GET' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Token token=YOURTOKEN'

{
  "load_list_items": [
    {
      "id": 105,
      "shipping_line": {
        "id": 1,
        "name": "Octopi Shipping Company",
        "code": "OCTO"
      },
      "container_type": "20DV",
      "container_status": "Empty",
      "container": null,
      "loaded": false,
      "loaded_at": null,
      "overshipped": false,
      "notes": "sample notes 1",
      "created_at": "2025-12-08T07:12:27-05:00"
    },
    {
      "id": 106,
      "shipping_line": {
        "id": 1,
        "name": "Octopi Shipping Company",
        "code": "OCTO"
      },
      "container_type": "20DV",
      "container_status": "Empty",
      "container": null,
      "loaded": false,
      "loaded_at": null,
      "overshipped": false,
      "notes": "sample notes 1",
      "created_at": "2025-12-08T07:12:27-05:00"
    }
  ]
}

Params

Param name Description
load_list_id
required

Octopi ID of the load list.

Validations:

  • Must be a Integer
>>>

POST /api/v1/load_lists/:load_list_id/load_list_items.json
Creates load list item for the specified load list.

Supported Formats

json

Errors

Code Description
404 Resource Not Found
422 Validation Error
500 Internal Server Error

Examples

curl 'https://app.octopi.co/api/v1/load_lists/LOAD_LIST_ID/load_list_items' \
  -X 'POST' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Token token=YOURTOKEN' \
  -d '{
    "load_list_item_type": "empties",
    "load_list_item": {
      "quantity": 2,
      "container_type_id": 2,
      "shipping_line_id": 1,
      "notes": "sample notes 1"
    }
  }'

# Example when load_list_item_type is other than empties
curl 'https://app.octopi.co/api/v1/load_lists/LOAD_LIST_ID/load_list_items' \
  -X 'POST' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Token token=YOURTOKEN' \
  -d '{
    "load_list_item_type": "full",
    "load_list_item": {
      "container_id": "123141",
      "notes": "sample notes 1"
    }
  }'

{
  "load_list_items": [
    {
      "id": 105,
      "shipping_line": {
        "id": 1,
        "name": "Octopi Shipping Company",
        "code": "OCTO"
      },
      "container_type": "20DV",
      "container_status": "Empty",
      "container": null,
      "loaded": false,
      "loaded_at": null,
      "overshipped": false,
      "notes": "sample notes 1",
      "created_at": "2025-12-08T07:12:27-05:00"
    },
    {
      "id": 106,
      "shipping_line": {
        "id": 1,
        "name": "Octopi Shipping Company",
        "code": "OCTO"
      },
      "container_type": "20DV",
      "container_status": "Empty",
      "container": null,
      "loaded": false,
      "loaded_at": null,
      "overshipped": false,
      "notes": "sample notes 1",
      "created_at": "2025-12-08T07:12:27-05:00"
    }
  ]
}

Params

Param name Description
load_list_id
required

Octopi ID of the load list.

Validations:

  • Must be a Integer
load_list_item_type
required

The type of container for which you want to create a load list item

Validations:

  • Must be one of: full, empty, break_bulk, vehicle, empties.
load_list_item
optional

Validations:

  • Must be a Hash
load_list_item[container_id]
optional

Octopi ID of any container or breakbulk or vehicle. This is mandatory when load_list_item_type is anything other than ‘empties’.

Validations:

  • Must be a Integer
load_list_item[container_type_id]
optional

Octopi ID of any container type. This is mandatory when load_list_item_type is set to ‘empties’.

Validations:

  • Must be a Integer
load_list_item[shipping_line_id]
optional

Octopi ID of any shipping line. This is mandatory when load_list_item_type is set to ‘empties’.

Validations:

  • Must be a Integer
load_list_item[quantity]
optional

Number of empties you want to create

Validations:

  • Must be a Integer
>>>

DELETE /api/v1/load_lists/:load_list_id/load_list_items/:id.json
Deletes the specified load list item.

Supported Formats

json

Errors

Code Description
404 Resource Not Found
422 Validation Error
500 Internal Server Error

Examples

curl 'https://app.octopi.co/api/v1/load_lists/LOAD_LIST_ID/load_list_items/LOAD_LIST_ITEM_ID' \
  -X 'DELETE' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Token token=YOURTOKEN'

{
  "id": 106,
  "shipping_line": {
    "id": 1,
    "name": "Octopi Shipping Company",
    "code": "OCTO"
  },
  "container_type": "20DV",
  "container_status": "Empty",
  "container": null,
  "loaded": false,
  "loaded_at": null,
  "overshipped": false,
  "notes": "sample notes 1",
  "created_at": "2025-12-08T07:12:27-05:00"
}

Params

Param name Description
load_list_id
required

Octopi ID of the load list.

Validations:

  • Must be a Integer
id
required

Octopi ID of the load list item.

Validations:

  • Must be a Integer