Manifests::Bill_of_ladings::Holds
This resource allows you to view the holds on bill of ladings.

This endpoint returns a list of all the holds that have been placed on the cargo for a bill of lading.

Supported Formats

Errors

Examples

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",
      "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"
          }
        }
      }
    ]
  }
}

This endpoint can be used to lift specified holds from a bill of lading.“

Supported Formats

Errors

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" } }'

This endpoint can be used to apply holds to a bill of lading.“

Supported Formats

Errors

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"