This API endpoint will allow you to get a list of consignees. You can filter using a search query parameter passed in q.

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?q=Octopi" -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=YOUR TOKEN HERE"
{
   "consignees" : [
      {
         "phone" : null,
         "name" : "FC OCTOPI",
         "customs_code" : null,
         "general_ledger_id" : null,
         "vat_number" : "111",
         "email" : null,
         "billing_contact_email" : null,
         "id" : 337395,
         "address" : null,
         "contact_person" : null
      },
      {
         "address" : null,
         "contact_person" : null,
         "id" : 337386,
         "email" : null,
         "billing_contact_email" : null,
         "general_ledger_id" : null,
         "vat_number" : "222",
         "phone" : null,
         "customs_code" : null,
         "name" : "INTER OCTOPI"
      },
      {
         "email" : null,
         "billing_contact_email" : null,
         "general_ledger_id" : null,
         "vat_number" : "333",
         "phone" : null,
         "customs_code" : null,
         "name" : "OCTOPI UNITED FC",
         "address" : null,
         "contact_person" : null,
         "id" : 337385
      }
   ]
}

Params

Param name Description
name
optional

Allows you to filter/search consignees by name

Validations:

  • Must be String

general_ledger_id
optional

Allows you to filter/search consignees by general ledger ID

Validations:

  • Must be String

page
optional

Specify which page of results to fetch. This value defaults to 1.

Validations:

  • Must be Integer

per
optional

The number of items to be displayed. This value defaults to 10 and accepts a maximum of 100.

Validations:

  • Must be Integer