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 PUT -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=YOURTOKEN"

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 apply. 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