This API endpoint allows you to fetch information about a specific 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/:id.json" -X GET -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=YOUR_TOKEN"'
{
  "general_cargo": {
    "id": 123,
    "reference_number": "",
    "quantity": 1.0,
    "goods_description": "1.0 Bundles of wood",
    "shipping_marks": null,
    "usage": "export",
    "consignee": "Consignee: COOL DUDE",
   "current_location_type": "Terminal",
    "current_location": "Terminal: Sunny Beaches",
    "weight_unit": "lb",
    "weight": 2.0,
    "dimension_unit": "inches",
    "width": 48.0,
    "height": 13.0,
    "length": 168.0,
    "volume": "104,832.00",
    "pieces_per_package": null,
    "package_weight": 0,
    "yard_slot": null,
    "package_type_code": "",
    "package_type": null,
    "extra_attributes": null
  }
}

Params

Param name Description
id
required

The Octopi general cargo ID.

Validations:

  • Must be Integer