This endpoint returns a list of bill of ladings associated to a consignee.

Supported Formats

json

Errors

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

Examples

curl "https://app.octopi.co/api/v1/consignees/ID/bill_of_ladings.json?voyage_number=100SB" -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=YOURTOKEN"
{
   "bill_of_ladings" : [
      {
         "weight" : 115825,
         "port_of_discharge" : {
            "locode" : "USMIA"
         },
         "exporter_address" : null,
         "remarks" : null,
         "number" : "EEA0120461A",
         "goods_description" : "BLUE BOTTLES OF SAND",
         "port_of_loading" : {
            "locode" : "HTPAP"
         },
         "package_type" : {
            "description" : "PACKAGE",
            "code" : "PK"
         },
         "shipping_marks" : ".",
         "manifest" : {
            "client_identifier" : null
         },
         "cargo" : [
            {
               "number" : "CMAU8393439",
               "storage_days" : 0,
               "reefer_plugged_in_time_in_hours" : 0,
               "container_type" : "40DV",
               "cargo_type" : "Container",
               "display_name" : "CMAU8393439",
               "id" : 487595
            },
            {
               "id" : 487596,
               "display_name" : "ECMU4520712",
               "reefer_plugged_in_time_in_hours" : 0,
               "container_type" : "40DV",
               "cargo_type" : "Container",
               "number" : "ECMU4520712",
               "storage_days" : 0
            },
            {
               "reefer_plugged_in_time_in_hours" : 0,
               "container_type" : "40DV",
               "cargo_type" : "Container",
               "display_name" : "TGHU4745107",
               "id" : 487597,
               "storage_days" : 0,
               "number" : "TGHU4745107"
            }
         ],
         "packing_list_items" : [
            {
               "has_been_stripped" : false,
               "weight" : 123,
               "quantity" : 1,
               "id" : 28018,
               "consignee_address" : "2 Main St.",
               "stripped_quantity" : 0,
               "package_type" : {
                  "code" : "1D",
                  "description" : "drum"
               },
               "dock_receipt_number" : "10120310231231",
               "reference_number" : "TEST1231",
               "volume" : 123,
               "container" : {
                  "number" : "FSCU4574900"
               },
               "description" : "USED CLOTHES",
               "bill_of_lading" : {
                  "number" : "NAM2943417"
               },
               "has_been_delivered" : false,
               "shipping_marks" : "BE CAREFUL . FRAGILE.",
               "consignee" : {
                  "name" : "BLUE AZUL S.A."
               }
            }
         ],
         "exporter" : {
            "name" : "BLUE INDUSTRIES LIMITED"
         },
         "volume_in_cubic_meters" : "0",
         "consignee" : {
            "name" : "LES ENTERPRISES S.A."
         },
         "consignee_address" : null
      },
      {
         "number" : "EEA0120461C",
         "goods_description" : "RUM BOTTLES",
         "port_of_discharge" : {
            "locode" : "USMIA"
         },
         "weight" : 115825,
         "remarks" : null,
         "exporter_address" : null,
         "consignee" : {
            "name" : "LES ENTERPRISES S.A."
         },
         "volume_in_cubic_meters" : "0",
         "exporter" : {
            "name" : "BLUE INDUSTRIES LIMITED"
         },
         "consignee_address" : null,
         "package_type" : {
            "code" : "PK",
            "description" : "PACKAGE"
         },
         "port_of_loading" : {
            "locode" : "HTPAP"
         },
         "shipping_marks" : ".",
         "cargo" : [
            {
               "number" : "CAIU3702912",
               "storage_days" : 0,
               "id" : 487474,
               "display_name" : "CAIU3702912",
               "reefer_plugged_in_time_in_hours" : 0,
               "container_type" : "40DV",
               "cargo_type" : "Container"
            },
            {
               "id" : 487475,
               "reefer_plugged_in_time_in_hours" : 10,
               "container_type" : "40RF",
               "cargo_type" : "Container",
               "display_name" : "CMAU0553470",
               "storage_days" : 4,
               "number" : "CMAU0553470"
            }
         ],
         "packing_list_items" : [],
         "manifest" : {
            "client_identifier" : null
         }
      },
      {
         "number" : "EEA0120461B",
         "goods_description" : "12 Barrels of wine",
         "port_of_discharge" : {
            "locode" : "USMIA"
         },
         "weight" : 115825,
         "remarks" : null,
         "exporter_address" : null,
         "consignee" : {
            "name" : "LES ENTERPRISES S.A."
         },
         "volume_in_cubic_meters" : "0",
         "exporter" : {
            "name" : "BLUE INDUSTRIES LIMITED"
         },
         "consignee_address" : null,
         "shipping_marks" : ".",
         "package_type" : {
            "code" : "PK",
            "description" : "PACKAGE"
         },
         "port_of_loading" : {
            "locode" : "USPEF"
         },
         "cargo" : [
            {
               "cargo_type" : "Container",
               "reefer_plugged_in_time_in_hours" : 0,
               "container_type" : "40DV",
               "display_name" : "FSCU4574900",
               "id" : 487593,
               "storage_days" : 2,
               "number" : "FSCU4574900"
            },
            {
               "id" : 487594,
               "cargo_type" : "Container",
               "reefer_plugged_in_time_in_hours" : 0,
               "container_type" : "40DV",
               "display_name" : "TTNU4887798",
               "storage_days" : 2,
               "number" : "TTNU4887798"
            }
         ],
         "packing_list_items" : [],
         "manifest" : {
            "client_identifier" : null
         }
      }
   ]
}

Params

Param name Description
consignee_id
required

Validations:

  • Must be Integer

voyage_number
optional

Validations:

  • Must be String