GET /api/v1/voyages/:number/consignees.json

This endpoint returns a list of consignees for a voyage.

Supported Formats

json

Errors

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

Examples

curl "https://app.octopi.co/api/v1/voyages/ADD NUMBER HERE/consignees.json" -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=YOURTOKEN"

{
  "consignees" : [
    {
      "id": 123,
      "name" : "Consignee Name"
    },
    {
      "id": 124,
      "name" : "Consignee Name"
    }
   ]
}

Params

Param name Description
number
required

Validations:

  • Must be a String