PATCH /api/v1/manifests/:manifest_client_identifier/bill_of_ladings/:id.json

This API endpoint will allow you to update a bill of lading for a particular manifest. Updating Consignee, Shipper or Exporter is not allowed at the moment.

Supported Formats

json

Errors

Code Description
400 Bad Request.
404 Not Found.
422 Unprocessable Entity.
500 Internal Server Error.

Examples

curl "https://app.octopi.co/api/v1/manifests/123/bill_of_ladings/:id.json" -d '{ "bill_of_lading": { "number": "unique number", "weight": 500.01, "remarks": "The goods have been loaded early.", "goods_description": "misc", "consignee_address": "1 Park Ave, New York, NY 10016", "exporter_address": "1 Park Ave, New York, NY 10016", "shipping_marks": "shipping marks", "package_code": "51", "destination_code": "S4B4", "type_of_contract": "FAS"}}' -X PATCH -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=ADD TOKEN HERE"

Params

Param name Description
manifest_client_identifier
required

The same client_identifier provided on manifest creation.

Validations:

  • Must be a String
bill_of_lading
optional

Validations:

  • Must be a Hash
bill_of_lading[client_identifier]
required

This is a unique client identifier for bill of lading.

Validations:

  • Must be a String
bill_of_lading[weight]
optional

The weight stored in your organization’s weight unit preference.

Validations:

  • Must be a Float
bill_of_lading[remarks]
optional

Validations:

  • Must be a String
bill_of_lading[volume_in_cubic_meters]
optional

Validations:

  • Must be a String
bill_of_lading[goods_description]
optional

Validations:

  • Must be a String
bill_of_lading[shipping_marks]
optional

Validations:

  • Must be a String
bill_of_lading[package_code]
optional

Validations:

  • Must be a String
bill_of_lading[consignee_address]
optional

Validations:

  • Must be a String
bill_of_lading[exporter_address]
optional

Validations:

  • Must be a String
bill_of_lading[destination_code]
optional

Validations:

  • Must be a String
bill_of_lading[type_of_contract]
optional

Validations:

  • Must be a String
bill_of_lading[usage]
optional

Validations:

  • Must be a String
bill_of_lading[consignee_id]
optional

Validations:

  • Must be a Integer
bill_of_lading[exporter_id]
optional

Validations:

  • Must be a Integer
bill_of_lading[port_of_loading]
optional

Validations:

  • Must be a String
bill_of_lading[port_of_discharge]
optional

Validations:

  • Must be a String
bill_of_lading[port_of_delivery]
optional

Validations:

  • Must be a String