GET /api/v1/voyages/:number/consignees.json
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/VOYAGE_NUMBER/consignees.json" -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=YOURTOKEN"

{
  "consignees" : [
    {
      "id": 123,
      "name" : "Consignee Name",
      "actions": {
        "bill_of_ladings": {
          "method": "GET",
          "url": "https://app.octopi.co/api/v1/consignees/123/bill_of_ladings?voyage_number=VOYAGE_NUMBER"
        },
        "packing_list_items": {
          "method": "GET",
          "url": "https://app.octopi.co/api/v1/consignees/123/packing_list_items?voyage_number=VOYAGE_NUMBER"
        }
      }
    },
    {
      "id": 124,
      "name" : "Consignee Name",
      "actions": {
        "bill_of_ladings": {
          "method": "GET",
          "url": "https://app.octopi.co/api/v1/consignees/124/bill_of_ladings?voyage_number=VOYAGE_NUMBER"
        },
        "packing_list_items": {
          "method": "GET",
          "url": "https://app.octopi.co/api/v1/consignees/124/packing_list_items?voyage_number=VOYAGE_NUMBER"
        }
      }
    }
   ]
}

Params

Param name	Description
number required	The voyage number of the consignees to fetch. Validations: Must be a String