PUT /api/v1/cargoes/:id/holds/:hold_id/apply.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 apply a hold to general cargo.

curl "https://app.octopi.co/api/v1/cargoes/CARGO_ID/holds/HOLD_TYPE_ID/apply.json" -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=YOURTOKEN"

{
  "reference_number": "REF123",
  "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"
    }
  },
  "lifted_by": null,
  "applied_by": null,
  "hold_type_id": 13,
  "hold_type": "CUSTOMS HOLD",
  "lifted": false,
  "lifted_at": null,
  "lifted_until": null,
  "applied_at": "2016-12-01T09:46:23.738-05:00"
}

Params

Param name Description
id
required

Validations:

  • Must be a String
hold_id
required

Validations:

  • Must be a Integer