This API endpoint allows you to fetch information about general cargo.

Supported Formats

json

Errors

Code Description
404 Not found.
400 Bad request.
500 Internal server error.

Examples

curl "https://app.octopi.co/api/v1/general_cargoes.json" -X GET -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=YOUR_TOKEN" -d '{ "consignee_id": "ABC DIRECT" }'
{
  "general_cargoes" : [
    {
      "id": 12345,
      "goods_description": "1.0 kilogram of wood",
      "arrival_voyage": "",
      "commodity_type": null,
      "consignees": [
        'ABC DIRECT'
      ],
      "current_location_type": "Voyage",
      "current_location": "Voyage: PLANET EARTH",
      "dock_receipt": null,
      "reference_number": null,
      "tags": [
        'quality wood'
      ],
      "usage": "unknown"
    },
  ],
  "actions": {
    "index": {
      "method": "GET",
      "url": "https://app.octopi.co/api/v1/general_cargoes.json"
    },
    "next": {
      "method": "GET",
      "url": "https://app.octopi.co/api/v1/general_cargoes.json?page=2"
    },
    "previous": {
      "method": "GET",
      "url": "https://app.octopi.co/api/v1/general_cargoes.json?page=0"
    },
    "last": {
      "method": "GET",
      "url": "https://app.octopi.co/api/v1/general_cargoes.json?page=304"
    }
  }
}

Params

Param name Description
arrival_voyage_id
optional

Filter for a specific arrival voyage. Can be the Octopi voyage id or voyage number.

Validations:

  • Must be String

booking_id
optional

Filter for a specific booking. Can be the Octopi booking id or booking number.

Validations:

  • Must be String

commodity_type
optional

Filter for a specific commodity type.

Validations:

  • Must be String

consignee_id
optional

Filter for a specific consignee. Can be the Octopi consignee id or consignee name.

Validations:

  • Must be String

current_location_type
optional

Filter for a specific current location type.

Validations:

  • Must be String

departure_voyage_id
optional

Filter for a specific departure voyage.

Validations:

  • Must be String

dock_receipt_id
optional

Filter for a specific dock receipt. Can be the Octopi dock receipt id or dock receipt number.

Validations:

  • Must be String

reference_number
optional

Filter for a specific reference number.

Validations:

  • Must be String

stripped_from_container_id
optional

Filter by the container the cargo was stripped from. Can be the Octopi container id or container number.

Validations:

  • Must be String

tags
optional

Filter for a list of pipe-separated tags (eg. ‘tag1|tag2|tag3’)

Validations:

  • Must be String

usage
optional

Filter for a specific usage.

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