POST /api/v1/trucking_companies
Create a new trucking company

This API endpoint allows you to create a new trucking company.

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.json" -X POST -d '{ "trucking_company": { "name" : "FC UNITED", "general_ledger_id": "SL1231", "contact_person": "Joe Jones", "address": "123 Main St", "email": "joe@example.com", "code": "111", "vat_number": "223", "allowed_until": "2027-12-31", "allowed_shipping_lines": [{ "shipping_line_id": 1, "allowed_until": "2027-12-31T23:59:59Z" }] } }' -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
trucking_company
required

Validations:

  • Must be a Hash
trucking_company[name]
required

Trucking company name (required).

Validations:

  • Must be a String
trucking_company[contact_person]
optional

Validations:

  • Must be a String
trucking_company[phone]
optional

Validations:

  • Must be a String
trucking_company[address]
optional

Validations:

  • Must be a String
trucking_company[email]
optional

Validations:

  • Must be a String
trucking_company[code]
optional

SCAC or other company code (unique per organization when present).

Validations:

  • Must be a String
trucking_company[general_ledger_id]
optional

Validations:

  • Must be a String
trucking_company[vat_number]
optional

Validations:

  • Must be a String
trucking_company[allowed_until]
optional

Allowed Until for the trucking company (date, YYYY-MM-DD).

Validations:

  • Must be a String
trucking_company[allowed_shipping_lines]
optional

Optional. New Pickup Allowed for Shipping Lines

Validations:

  • Must be an Array of nested elements
trucking_company[allowed_shipping_lines][shipping_line_id]
required

Shipping line ID (required for each new entry).

Validations:

  • Must be a Integer
trucking_company[allowed_shipping_lines][allowed_until]
optional

Allowed until for this shipping line (ISO 8601 date-time).

Validations:

  • Must be a String