GET /api/v1/bill_of_ladings/:id.json
Returns the given 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/123.json" -X GET -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=ADD TOKEN HERE"

{
  "bill_of_lading": {
    "id": 123,
    "bl_number": "BL_123",
    "manifest": {
      "client_identifier": "2d7fe4c0-529a-4732-9927-7eadd9ea7879",
      "manifest_id": 76015
    },
    "voyage": {
      "voyage_id": 227966,
      "voyage_number": "20210801",
      "vessel_name": "TEST"
    }
  }
}

Params

Param name Description
id
required

The bill of lading ID.

Validations:

  • Must be a number.