This resource allows you to view holds that are associated to a specific bill of lading.
This endpoint returns a list of all the holds that have been placed on the cargo for a bill of lading. This includes holds that have been applied and not yet lifted, as well as holds that are applicable but have not yet been applied.
| Code | Description |
|---|---|
| 404 | Not found |
| 500 | Server crashed for some reason |
curl "https://app.octopi.co/api/v1/manifests/MANIFEST_CLIENT_IDENTIFIER/bill_of_ladings/BILL_OF_LADING_NUMBER/holds.json" -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=YOURTOKEN"
{
"bill_of_lading": {
"number": "TSCW12924362",
"manifest": {
"client_identifier": "2018010126"
},
"unlifted_holds":[
{
"id":36,
"name":"FAS",
"description":"The port handles cargo under two types of shipping terms- FAS and LINER. Liner cargo would be transshipment and vehicle carriers. This fee would be paid for the agent and as such would not require a FAS hold. All other cargo is FAS and these fees must be paid before the cargo can be delivered. ",
"actions":{
"lift":{
"method":"DELETE",
"url":"http://app.octopi.co/api/v1/manifests/2018010126/bill_of_ladings/TSCW12924362/holds/36.json"
}
}
}
],
"applicable_holds":[
{
"id":34,
"name":"Agent Hold",
"description":"",
"actions":{
"apply":{
"method":"PUT",
"url":"http://app.octopi.co/api/v1/manifests/2018010126/bill_of_ladings/TSCW12924362/holds/34.json"
}
}
},
{
"id":54,
"name":"Transshipment Hold",
"description":"Calendar Days",
"actions":{
"apply":{
"method":"PUT",
"url":"http://app.octopi.co/api/v1/manifests/2018010126/bill_of_ladings/TSCW12924362/holds/54.json"
}
}
}
]
}
}
| Param name | Description |
|---|---|
|
manifest_client_identifier required |
The same client_identifier provided on manifest creation. Validations:
|
|
bill_of_lading_number required |
The number of the bill of lading that the hold is on. Validations:
|
| Code | Description |
|---|---|
| 404 | Not found |
| 500 | Server crashed for some reason |
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" } }'
| Param name | Description |
|---|---|
|
manifest_client_identifier required |
The same client_identifier provided on manifest creation. Validations:
|
|
bill_of_lading_number required |
The number of the bill of lading that the hold is on. Validations:
|
|
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:
|
|
hold required |
Validations:
|
|
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:
|
|
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:
|
| Code | Description |
|---|---|
| 404 | Not found |
| 500 | Server crashed for some reason |
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"
| Param name | Description |
|---|---|
|
manifest_client_identifier required |
The same client_identifier provided on manifest creation. Validations:
|
|
bill_of_lading_number required |
The number of the bill of lading that the hold is on. Validations:
|
|
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:
|