Voyages::Bill_of_ladings::Holds
This resource allows you to view and edit the holds on cargo.

This endpoint returns a list of all the holds that have been placed on the cargo for 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/voyages/VOYAGE_NUMBER/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",
    "unlifted_hold_types":[
      {
        "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":"PUT",
            "url":"http://app.octopi.co/api/v1/voyages/2018010126/bill_of_ladings/TSCW12924362/hold_types/36/lift.json"
          }
        }
      }
    ],
    "hold_types":[
      {
        "id":34,
        "name":"Agent Hold",
        "description":"",
        "actions":{
          "apply":{
            "method":"PUT",
            "url":"http://app.octopi.co/api/v1/voyages/2018010126/bill_of_ladings/TSCW12924362/hold_types/34/apply.json"
          }
        }
      },
      {
        "id":54,
        "name":"Transshipment Hold",
        "description":"Calendar Days",
        "actions":{
          "apply":{
            "method":"PUT",
            "url":"http://app.octopi.co/api/v1/voyages/2018010126/bill_of_ladings/TSCW12924362/hold_types/54/apply.json"
          }
        }
      }
    ],
    "holds":[
      {
        "id":449765,
        "hold_type_id":36,
        "hold_type":"FAS",
        "applied_at":"2018-01-29T15:02:46Z",
        "applied_by":null,
        "lifted":false,
        "lifted_by":null,
        "lifted_at":null,
        "reference_number":null
      }
    ]
  }
}