Voyages::Bill_of_ladings::Hold_types
This resource allows you to edit the holds on a bill of lading.

This resource allows you to lift and apply holds based on a hold type for all the cargo on a bill of lading.

Supported Formats

json
>>>

PUT /api/v1/voyages/:voyage_number/bill_of_ladings/:bill_of_lading_number/hold_types/:hold_type_id/lift.json
This endpoint can be used to lift all holds from 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/hold_types/:hold_type_id/lift.json" -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=YOURTOKEN" -d '{"hold": { "reference_number": "Your Reference Number", "notes": "Your notes" } }'

Params

Param name Description
voyage_number
required

The voyage number of the bill of lading.

Validations:

  • Must be a String
bill_of_lading_number
required

The bill of lading number.

Validations:

  • Must be a String
hold_type_id
required

The ID of the hold type to be lifted.

Validations:

  • Must be a String
>>>

PUT /api/v1/voyages/:voyage_number/bill_of_ladings/:bill_of_lading_number/hold_types/:hold_type_id/apply.json
This endpoint can be used to apply all holds to 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/hold_types/:hold_type_id/apply.json" -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=YOURTOKEN"

Params

Param name Description
voyage_number
required

The voyage number of the bill of lading.

Validations:

  • Must be a String
bill_of_lading_number
required

The bill of lading number.

Validations:

  • Must be a String
hold_type_id
required

The ID of the hold type to be applied.

Validations:

  • Must be a String