POST /api/v1/freight_forwarders
Create a new freight forwarder

This API endpoint allows you to create a new freight forwarder.

Supported Formats

json

Errors

Code Description
400 Bad Request.
404 Not Found.
500 Internal Server Error.

Examples

curl "https://app.octopi.co/api/v1/freight_forwarders.json" -X POST -d '{ "name" : "FC UNITED", "general_ledger_id": "SL1231", "contact_person": "Joe Jones", "address": "123 Main St", "email": "joe@example.com", "vat_number": "222" }' -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=YOUR TOKEN HERE"

{
   "freight_forwarder" : {
      "id" : 353388,
      "name" : "FC UNITED",
      "email" : "joe@example.com",
      "address" : "123 Main St",
      "vat_number" : "222",
      "general_ledger_id" : "SL1231",
      "contact_person" : "Joe Jones",
      "phone" : "786-111-1111",
      "active" : true,
      "created_at" : "2025-02-27T05:19:17.874-05:00",
      "updated_at" : "2025-02-27T05:19:17.874-05:00"
   }
}

Params

Param name Description
name
required

Validations:

  • Must be a String
contact_person
optional

Validations:

  • Must be a String
phone
optional

Validations:

  • Must be a String
address
optional

Validations:

  • Must be a String
email
optional

Validations:

  • Must be a String
general_ledger_id
optional

Validations:

  • Must be a String
vat_number
optional

Validations:

  • Must be a String