Supported Formats

json

Errors

Code Description
404 Not found
409 Conflict
500 Server crashed for some reason

Examples

This endpoint returns a list of holds that have been placed on the cargo.
curl "https://app.octopi.co/api/v1/cargoes/ID/holds.json" -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=YOURTOKEN"
{
  "holds": [
    {
      "lifted": false,
      "applied_at": null,
      "lifted_at": null,
      "lifted_until": null,
      "lifted_by": null,
      "hold_type": "DETENTION HOLD",
      "actions": {
        "lift": {
          "method": "PUT",
          "url": "https://app.octopi.co/api/v1/cargoes/CARGO_ID/holds/HOLD_ID/lift.json"
        },
        "index": {
          "method": "GET",
          "url": "https://app.octopi.co/api/v1/cargoes/CARGO_ID/holds.json"
        }
      },
      "id": 51359,
      "reference_number": null,
      "applied_by": null
    },
    {
      "lifted_at": null,
      "lifted_until": null,
      "lifted_by": null,
      "lifted": false,
      "applied_at": null,
      "applied_by": null,
      "actions": {
        "index": {
          "method": "GET",
          "url": "https://app.octopi.co/api/v1/cargoes/CARGO_ID/holds.json"
        },
        "lift": {
          "method": "PUT",
          "url": "https://app.octopi.co/api/v1/cargoes/CARGO_ID/holds/HOLD_ID/lift.json"
        }
      },
      "hold_type": "GATE MOVE INVOICE FEE",
      "reference_number": null,
      "id": 51360
    }
  ]
}

Params

Param name Description
id
required

Validations:

  • Must be String