| 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. |
curl "https://app.octopi.co/api/v1/containers.json" \
-X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Token token=YOUR TOKEN HERE" \
-d '{ \
"container": {
"container_type_id": 256,
"current_location_id": 35,
"current_location_type": "Terminal",
"number": "BHCU4942000",
"shipping_line_id": 78,
"usage": "unknown",
"status": "full",
"cargo_type": "container",
"pin": "999999",
"flex_fields": [
{ "container_flex_field_1": "ABC123" },
{ "container_flex_field_2": "XYZ456" }
]
}
}'
{
"container": {
"meets_iso_standards": true,
"id": 2262336,
"number": "BHCU4942000",
"container_type": {
"code": "40CT",
"description": "",
"iso_type_code": "42G1"
},
"size": 40,
"is_high_cube": false,
"is_reefer": false,
"seals": [],
"return_temperature": null,
"supply_temperature": null,
"set_point_temperature": null,
"temperature_unit": "F",
"arrival_voyage": {
"number": null,
"estimated_time_of_anchorage": null,
"vessel": {
"name": null
}
},
"commodity_type": {
"name": null
},
"departure_voyage": {
"number": null,
"estimated_time_of_departure": null,
"vessel": {
"name": null
}
},
"shipping_line": {
"code": "MSK",
"name": "MAERSK LINE",
"synonyms": [],
"carrier_type": "ocean",
"agent": {
"name": null
}
},
"weight": 0.0,
"container_vgm": {
"weight": null,
"created_at": null,
"user": {
"name": null
}
},
"iso_standards_errors": null,
"current_location_type": "Terminal",
"current_location": "Terminal: North Terminal",
"status": "full",
"usage": "unknown",
"goods": null,
"consignees": [],
"hazmat_codes": [],
"flex_fields": [
{
"label": "Flex Field 1",
"value": "ABC123"
},
{
"label": "Flex Field 2",
"value": "XYZ456"
}
],
"extra_attributes": null,
"tags": [],
"over_height": false,
"over_length": false,
"over_width": false,
"is_out_of_gauge": false,
"actions": {
"show": {
"method": "GET",
"url": "https://app.octopi.co/api/v1/containers/BHCU4942000.json"
},
"update": {
"method": "PATCH",
"url": "https://app.octopi.co/api/v1/containers/BHCU4942000.json"
},
"movements": {
"method": "GET",
"url": "https://app.octopi.co/api/v1/containers/BHCU4942000/movements.json"
}
}
}
}
| Param name | Description |
|---|---|
|
container required |
Validations:
|
|
container[consignee_ids] optional |
an array of consignee ids for this container. Available consignee ids can be retrieved through /api/v1/consignees Validations:
|
|
container[container_type_id] required |
an id of ISO container type. Available container types can be retrieved through /api/v1/container_types Validations:
|
|
container[current_location_id] required |
the container current location id. Validations:
|
|
container[current_location_type] required |
the type of current location Validations:
|
|
container[number] required |
the container number Validations:
|
|
container[shipping_line_id] required |
the shipping line id of the container Validations:
|
|
container[cargo_type] optional |
The cargo type of the container Validations:
|
|
container[usage] optional |
Type usage of the container Validations:
|
|
container[status] optional |
the current status of the container Validations:
|
|
container[pin] optional |
Container release PIN. If the shipping line is configured to verify this specific PIN, a truck’s entry (Gate In) and interchange departure (Interchange Out) will only be permitted if the value provided in the request matches this one. Validations:
|
|
container[hazmat_codes] optional |
hazmat codes on a container using this list of codes. Validations:
|
|
container[operating_reefer] optional |
indicate if the reefer is in operational status or not (OR or NOR). Note that set_point_temperature cannot be changed on non operational refer and an error will be return in that case. Validations:
|
|
container[return_temperature] optional |
the current temperature measured by the sensor at the air return of the reefer. Validations:
|
|
container[supply_temperature] optional |
the current temperature inside of the reefer measured by the sensor placed close to the source of cool air. Validations:
|
|
container[set_point_temperature] optional |
the desired temperature that the reefer operator sets for the system to maintain. Validations:
|
|
container[temperature_unit] optional |
The measurement unit for any of temperature params. Accepted values are C, F, celsius, fahrenheit. This params is required if any of temperature params are given. Validations:
|
|
container[reefer_humidity] optional |
the % of humidity inside of the reefer setting. Validations:
|
|
container[reefer_ventilation] optional |
the % of opening the Fresh Air Makeup Vent. The % is used as a setting on that Vent. Validations:
|
|
container[seals] optional |
Seals on a container using this list of seals. A maximum of 4 seals are accepted. Validations:
|
|
container[over_height] optional |
indicate if the container is over height. Validations:
|
|
container[over_length] optional |
indicate if the container is over length. Validations:
|
|
container[over_width] optional |
indicate if the container is over width. Validations:
|
|
container[flex_fields] optional |
An array of hashes, where each hash contains a flex field’s canonical name and the corresponding value to be set on the container. Validations:
|