PUT /api/v1/cargoes/:cargo_id/holds/:id/lift.json

Supported Formats

json

Errors

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

Examples

This endpoint can be used to lift a hold from a cargo. If a bill of lading
number is provided, it will only lift the hold if the container is manifested on
the bill of lading identified by the provided id.

curl "https://app.octopi.co/api/v1/cargoes/CARGO_ID/holds/HOLD_ID/lift.json" -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=YOURTOKEN" -d '{"hold": { "reference_number": "ADD REFERENCE NUMBER HERE", "lift_until": "2025-10-10", "notes": "ADD LIFTED NOTE HERE"} }'

{
  "reference_number": "REF123",
  "actions": {
    "lift": {
      "method": "PUT",
      "url": "https://app.octopi.co/api/v1/cargoes/CARGO_ID/holds/HOLD_ID/apply.json"
    },
    "index": {
      "method": "GET",
      "url": "https://app.octopi.co/api/v1/cargoes/CARGO_ID/holds.json"
    }
  },
  "lifted_by": null,
  "applied_by": null,
  "hold_type_id": 13,
  "hold_type": "CUSTOMS HOLD",
  "lifted": true,
  "lifted_at": "2016-12-01T09:46:23.738-05:00",
  "applied_at": null,
  "notes": null
}

Params

Param name Description
cargo_id
required

Validations:

  • Must be a String
id
required

Validations:

  • Must be a Integer