DELETE /api/v1/manifests/:manifest_client_identifier/bill_of_ladings/:bill_of_lading_number/holds/:hold_id.json
This endpoint allows you to lift a hold on a bill of lading

Supported Formats

json

Errors

Code Description
404 Not found
500 Server crashed for some reason

Examples

curl "https://app.octopi.co/api/v1/manifests/:manifest_client_identifier/bill_of_ladings/:bill_of_lading_number/holds/:hold_id.json" -X DELETE -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=YOURTOKEN" -d '{"hold": { "reference_number": "Your Reference Number", "lift_until": "2019-10-10" } }'

Params

Param name Description
manifest_client_identifier
required

The same client_identifier provided on manifest creation.

Validations:

  • Must be a String
bill_of_lading_number
required

The number of the bill of lading that the hold is on.

Validations:

  • Must be a String
hold_id
required

The id of the hold that you want to lift. You can get this id from the GET /manifests/:manifest_client_identifier/bill_of_ladings/:bill_of_lading_number/holds.json endpoint.

Validations:

  • Must be a String
hold
required

Validations:

  • Must be a Hash
hold[reference_number]
required

The reference number for the hold that you want to lift. This is required to ensure that the correct hold is lifted, and to provide an audit trail for why the hold was lifted.

Validations:

  • Must be a String
hold[lift_until]
optional

The date until which the hold should be lifted. This should be in ISO8601 format (e.g. 2019-10-10T00:00:00Z). If this is not provided, the hold will be lifted indefinitely.

Validations:

  • Must be a String