GET /api/v1/containers.json
Returns information about containers.

Supported Formats

json

Errors

Code	Description
404	Not Found: one of the requested resources wasn't found.
422	Unprocessable Entity: unable to process request due to an input or validation error.
500	Internal Server Error.

Examples

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

{
  "containers": [
    "container": {
      "id": "123456",
      "number": "BMOU4286229",
      "bill_of_lading": "PEV1231231",
      "status": "full",
      "size": "20",
      "container_type": {
        "label": "20RF",
        "description": "This is a 20 ft. container",
        "iso_type_code": "22RF"
      },
      "is_high_cube": false,
      "is_reefer": true,
      "seals": [
        "G3117839",
        "DGAEXP"
      ],
      "return_temperature": 10,
      "supply_temperature": 10,
      "set_point_temperature": 10,
      "temperature_unit": "F",
      "arrival_voyage": {
        "number": "2345",
        "vessel": {
          "name": "Vega Luna",
          "estimated_time_of_anchorage": "2017-04-07T02:00:00.000Z"
        }
      },
      "commodity_type": {
        "name": "Fish"
      },
      "departure_voyage": {
        "number": "2345",
        "vessel": {
          "name": "Vega Luna",
          "estimated_time_of_anchorage": "2017-05-07T02:00:00.000Z"
        }
      },
      "weight": 100.0,
      "container_vgm": {
        "weight": 100.0,
        "created_at": "2017-04-07T02:00:00.000Z",
        "user": {
          "name": "John D."
        }
      },
      "usage": "import",
      "shipping_line": {
        "code": "MASL",
        "name": "Ma Shipping Line",
        "carrier_type": "Ocean",
        "agent": {
          "name": "John Doe"
        }
      },
      "consignees": [
        {
          "name": "SODIPAL SA"
        }
      ],
      "meets_iso_standards": true,
      "goods": "TOILET TISSUEHS CODE  481810",
      "current_location_type": "Terminal",
      "current_location": "Terminal: South Terminal",
      "yard_area": {
          "id": 2,
          "name": "GRID 3328",
          "description": "",
          "terminal_id": 1,
          "area_type": "grid"
      },
      "yard_slot": {
          "id": 6,
          "name": "GRID 3328",
          "description": "",
          "terminal_id": 1,
          "area_type": "grid",
          "custom_name": "GD1A2"
      },
      "iso_standards_errors": "",
      "hazmat_codes": [
        {
          "code": "12XV",
          "description": "hazmat",
          "name": "Hextol",
          "hazmat_class": {
            "name": "Explosives",
            "description": "Explosives that have a projection hazard but not a mass explosion hazard.",
            "class_number": 1,
            "division_number": 2
          }
        }
      ],
      "over_height": false,
      "over_length": false,
      "over_width": false,
      "is_out_of_gauge": false,
      "actions": {
        "show": {
          "url": "https://app.octopi.co/api/v1/containers/BMOU4286229.json",
          "method": "GET"
        },
        "flex_fields": [
          {
            "label": "Name",
            "value": "Octopi"
          }
        ]
      }
    }
  ],
  "actions": {
    "index": {
      "method": "GET",
      "url": "https://app.octopi.co/api/v1/containers.json"
    },
    "next": {
      "method": "GET",
      "url": "https://app.octopi.co/api/v1/containers.json?page=2"
    },
    "previous": {
      "method": "GET",
      "url": "https://app.octopi.co/api/v1/containers.json?page=0"
    },
    "last": {
      "method": "GET",
      "url": "https://app.octopi.co/api/v1/containers.json?page=304"
    }
  }
}

Params

Param name	Description
container_type_id optional	Filter for a specific container type. Can be the Octopi container type id or container type label. Validations: Must be a String
shipping_line_id optional	Filter for a specific shipping line. Can be the Octopi shipping line id or shipping line name. Validations: Must be a String
current_location_type optional	Filter for a specific current location type. Validations: Must be a String
current_location_id optional	Filter for a specific current location id. Validations: Must be a String
usage optional	Filter for a specific usage. Validations: Must be a String
booking_id optional	Filter for a specific booking. Can be the Octopi booking id or booking number. Validations: Must be a String
bill_of_lading_id optional	Filter for a specific bill of lading. Can be the Octopi bill of lading id or bill of lading number. Validations: Must be a String
status optional	Filter for container status (‘full’ or ‘empty’) Validations: Must be a String
tags optional	Filter for a list of pipe-separated tags (eg. ‘tag1|tag2|tag3’) Validations: Must be a String
arrival_voyage_id optional	Filter for a specific arrival voyage. Can be the Octopi voyage id or voyage number. Validations: Must be a String
departure_voyage_id optional	Filter for a specific departure voyage. Validations: Must be a String
page optional	Specify which page of results to fetch. This value defaults to 1. Validations: Must be a Integer
per optional	The number of items to be displayed. This value defaults to 10 and accepts a maximum of 100. Validations: Must be a Integer