Supported Formats

json

GET /api/v1/container_types.json
Returns a list of container types.

Supported Formats

json

Errors

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

Examples

curl "https://app.octopi.co/api/v1/container_types.json" -X GET -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=ADD TOKEN HERE"
{
  "container_types": [
    {
      "id": 123,
      "label": "40RF",
      "description": "40ft Reefer",
      "iso_type_code": "45R2",
      "length_in_ft": 40,
      "teu": 2.0,
      "category": "Reefer",
      "synonyms": [
          "40RF",
          "40RH",
          "4330",
          "4331",
          "4332",
          "4536",
          "4230",
          "42R0",
          "42R1",
          "42R9",
          "42RE",
          "42RS",
          "42RT"
      ]
    }
  ],
  "actions" : {
    "next_page" : {
        "method" : "GET",
        "url" : "https://app.octopi.co/api/v1/container_types.json?page=2&per=10"
    }
  }
}

Params

Param name Description
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