GET /api/v1/consignees/:id
Returns information about a consignee

This API endpoint will return the information for the 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/5.json" -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=YOUR TOKEN HERE"

{
   "consignee" : {
      "phone" : null,
      "name" : "FC OCTOPI",
      "id" : 337395,
      "vat_number" : null,
      "general_ledger_id" : null,
      "address" : null,
      "contact_person" : null,
      "customs_code" : null,
      "email" : null,
      "billing_contact_email" : null
   }
}

Params

Param name Description
id
required

Validations:

  • Must be a Integer