GET /api/v1/pre_advices/:advice_number

Returns information about a specific pre-advice.

Supported Formats

json

Errors

Code	Description
404	Not found.
422	Unprocessable Entity.
500	Internal Server Error.

Examples

curl "https://app.octopi.co/api/v1/pre_advices/OCTO231234.json" -X GET -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=ADD TOKEN HERE"'

{
  "advice_number": "OCTO231234",
  "truck": "TRA123",
  "truck_driver": {
    "id": 1234,
    "fullname": "John Doe",
    "license_number": "JNA321",
    "twic": "",
    "number": "633353",
    "active": true,
    "date_of_birth": null,
    "telephone_number": null,
    "email": null,
    "remarks": null,
    "trucking_company": "FAST TRUCKS, INC.",
    "allowed_until": null,
    "created_at": "2017-09-15T15:47:12Z",
    "updated_at": "2023-09-15T15:47:12Z"
  },
  "purposes": [
    {
      "purpose_type": "drop_off",
      "cargo": "NYKU438609",
      "booking": "BOOK123",
      "bill_of_lading": "BOL123"
    },
    {
      "purpose_type": "pick_up",
      "cargo": "TEMU714171",
      "booking": "BOOK321",
      "bill_of_lading": "BOL321"
    }
  ]
}

Params

Param name	Description
advice_number required	The pre-advice’s number. Validations: Must be a String