Manifests::Bill_of_ladings
This resources allows you to create bill of ladings in Octopi.

Supported Formats

json
>>>

POST /api/v1/manifests/:manifest_client_identifier/bill_of_ladings.json

This API endpoint will allow you to create a bill of lading for a particular manifest. Please check the payload specification to make sure the required attributes are part of the payload and the optional attributes respect the specifications.

Supported Formats

json

Errors

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

Examples

curl "https://app.octopi.co/api/v1/manifests/123/bill_of_ladings.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"}, "consignee": "APPLE", "exporter": "ALIBABA", "usage": "import" }' -X POST -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[number]
required

This is a unique bill of lading number for a particular manifest. Sometimes known as reference number.

Validations:

  • Must be a String
bill_of_lading[weight]
optional

This parameter must be in kilograms.

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
port_of_loading_locode
optional

A port will be associated with a bill of lading only if the port locode exists in Octopi.

Validations:

  • Must be a String
port_of_discharge_locode
optional

A port will be associated with a bill of lading only if the port locode exists in Octopi.

Validations:

  • Must be a String
port_of_delivery_locode
optional

A port will be associated with a bill of lading only if the port locode exists in Octopi.

Validations:

  • Must be a String
consignee
optional

Name of consignee as stored in Octopi.

Validations:

  • Must be a String
exporter
optional

Name of exporter as stored in Octopi.

Validations:

  • Must be a String
>>>

GET /api/v1/manifests/:manifest_client_identifier/bill_of_ladings.json

This API endpoint will allow you to get a list of bill of ladings for a particular manifest. Please check the payload specification to make sure the required attributes are part of the payload and the optional attributes respect the specifications.

Supported Formats

json

Errors

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

Examples

curl "https://app.octopi.co/api/v1/manifests/123/bill_of_ladings.json" -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
>>>

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.
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

This parameter must be in kilograms.

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