GET /api/v1/packing_list_items/:reference_number/cargoes.json

This endpoint returns a list of cargoes associated to the packing list item.

Supported Formats

json

Errors

Code	Description
404	Not found
500	Server crashed for some reason

Examples

curl "https://app.octopi.co/api/v1/packing_list_items/REFERENCE_NUMBER/cargoes.json" -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=YOURTOKEN"

{
   "cargoes" : [
      {
         "actions" : {
            "movements" : {
               "method" : "GET",
               "url" : "https://app.octopi.co/api/v1/containers/123/movements.json"
            },
            "show" : {
               "url" : "https://app.octopi.co/api/v1/containers/123.json",
               "method" : "GET"
            },
            "list_holds" : {
               "url" : "https://app.octopi.co/api/v1/containers/123/holds.json",
               "method" : "GET"
            }
         },
         "id" : 123,
         "current_location" : "Warehouse 1",
         "current_location_code" : "BBB-123",
         "shipping_line" : {
            "agent" : {
               "name" : "GREAT AGENCIES INC"
            },
            "synonyms" : [],
            "name" : "MAERSK",
            "carrier_type" : "ocean",
            "code" : "MAEU"
         },
         "departure_voyage" : {
            "number" : "445N",
            "vessel" : {
               "name" : "BLUE VESSEL"
            },
            "estimated_time_of_departure" : "2017-04-07T02:00:00.000Z"
         },
         "weight" : 200,
         "goods" : "SOCCER BALLS",
         "hazmat_codes" : [],
         "current_location_type" : "YardArea",
         "description" : "SOCCER BALLS",
         "consignees" : [],
         "arrival_voyage" : {
            "estimated_time_of_anchorage" : "2017-04-07T02:00:00.000Z",
            "number" : "446S",
            "vessel" : {
               "name" : "BLUE VESSEL"
            }
         }
      }
      ,
      {
         "id" : 125,
         "current_location" : "Warehouse 2",
         "actions" : {
            "movements" : {
               "method" : "GET",
               "url" : "https://app.octopi.co/api/v1/containers/125/movements.json"
            },
            "show" : {
               "url" : "https://app.octopi.co/api/v1/containers/125.json",
               "method" : "GET"
            },
            "list_holds" : {
               "method" : "GET",
               "url" : "https://app.octopi.co/api/v1/containers/125/holds.json"
            }
         },
         "hazmat_codes" : [],
         "description" : "BASEBALLS",
         "current_location_type" : "YardArea",
         "goods" : "BASEBALLS",
         "weight" : 100,
         "arrival_voyage" : {
            "vessel" : {
               "name" : "RED VESSEL"
            },
            "estimated_time_of_anchorage" : "2017-04-07T02:00:00.000Z",
            "number" : "43S"
         },
         "consignees" : [],
         "shipping_line" : {
            "carrier_type" : "ocean",
            "code" : "MAEU",
            "name" : "MAERSK",
            "synonyms" : [],
            "agent" : {
               "name" : "GREAT AGENCIES INC"
            }
         },
         "departure_voyage" : {
            "number" : "45N",
            "estimated_time_of_departure" : "2017-04-07T02:00:00.000Z",
            "vessel" : {
               "name" : "RED VESSEL"
            }
         }
      }
   ]
}

Params

Param name	Description
reference_number required	Validations: Must be a String