GET /api/v1/trucking_companies/:id
Returns information about a trucking company

This API endpoint will return the information for the trucking company, including allowed_until (Allowed Until) and allowed_shipping_lines (Pickup Allowed for Shipping Line entries).

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/trucking_companies/5.json" -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=YOUR TOKEN HERE"

{
   "trucking_company" : {
      "id" : 353388,
      "name" : "FC UNITED",
      "email" : "joe@example.com",
      "address" : "123 Main St",
      "code" : "SCAC",
      "general_ledger_id" : "SL1231",
      "vat_number" : "223",
      "contact_person" : "Joe Jones",
      "phone" : "786-111-1111",
      "active" : true,
      "allowed_until" : "2027-12-31",
      "allowed_shipping_lines" : [
         {
            "id" : 42,
            "shipping_line_id" : 1,
            "shipping_line_code" : "MAEU",
            "shipping_line_name" : "Maersk Line",
            "allowed_until" : "2027-12-31T23:59:59Z"
         }
      ],
      "created_at" : "2022-05-16T02:44:16Z",
      "updated_at" : "2025-04-09T12:33:57Z"
   }
}

Params

Param name Description
id
required

Validations:

  • Must be a Integer