GET /api/v1/bill_of_ladings/:id/line_items.json
Returns a list of line items on a Bill of Lading.

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/:id/line_items.json" -X GET -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=ADD TOKEN HERE"

{
  "line_items": [
    {
      "id": 1211,
      "container_id": 1902,
      "quantity": 1.0,
      "container_number": "ABC123",
      "cargo_type": "container",
      "container_type_label": "20DV",
      "container_weight": 4000,
      "container_weight_unit": "kg"
      "flex_fields": [
        {
          "label": "flex_field_label",
          "value": "flex_field_value"
        }
      ]
    }
  ],
  "actions" : {
    "next_page" : {
        "method" : "GET",
        "url" : "https://app.octopi.co/api/v1/bill_of_ladings/:id/line_items.json?page=2&per=10"
    }
  }
}

Params

Param name Description
page
optional

Indicates which page of results to fetch. The default is 1.

Validations:

  • Must be a number.
per
optional

The number of items to be displayed per page. This default is 10 and the maximum allowed value is 100.

Validations:

  • Must be a number.