This API endpoint allows you to create a new consignee.

Supported Formats

json

Errors

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

Examples

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