Container

Endpoints relating to Container objects

List all containers.

Returns a list of containers. The containers are sorted descending by creation date.

Request
query Parameters
page
integer >= 1
Default: 1

Page number of the page to retrieve

Example: page=1
per
integer [ 1 .. 100 ]
Default: 20

Count of items in each page. Should be between 1 and 100 (inclusive).

Example: per=20
f.shipment.id
integer

Only return containers associated with the shipment specified by this id.

f.container_number
string

Only return containers associated with the given container number.

f.reference_code
string

Only return containers associated with the given reference code.

f.metadata.YOUR_METADATA_KEY
string

Only return containers that have a specific metadata key-value pair. Multiple metadata filters can be added to a single query. If there are multiple metadata filters each with the same metadata key, then the filter will return containers matching any of the specified metadata values for that metadata key.

Responses
200

Success

Response Schema: application/json
_object
string
self
string
version
integer
object
_object
string
prev
string or null
next
string or null
Array of objects (ShipmentContainer)
400

error

get/ocean/shipment_containers
Response samples
application/json

Success

{
  • "_object": "/api/response",
  • "self": "https://api.flexport.com",
  • "version": 2,
  • "data": {
    • "_object": "/api/collections/paginated",
    • "prev": "https://api.flexport.com/ocean/shipment_containers?page=1",
    • "next": "https://api.flexport.com/ocean/shipment_containers?page=3",
    • "data": [
      • {
        }
      ]
    }
}

Retrieve a container.

Retrieves the details of a single container.

Request
path Parameters
id
required
string

The unique id for the shipment to be retrieved.

Responses
200

Success

Response Schema: application/json
_object
string
self
string
version
integer
object (ShipmentContainer)
_object
string

Type of the object

id
integer
metadata
object (Metadata)

Set of custom key-values specific to the object. The keys are strings and values are arrays of strings. The set of valid keys is always the consignee's list of keys, even if call was made by a different party.

container_type
string
Enum: "dry" "flat_rack" "headload" "open" "reefer" "lcl" "tank" "ventilated" "bulk" "special"
container_number
string
reference_code
string
container_size
string
Enum: "twenty_ft" "fourty_ft" "fourty_ft_hc" "fourty_five_ft_hc" "fifty_three_ft" "fifty_three_ft_hc"
seal_number
string or null
pickup_number
string or null
estimated_departure_date
string or null <date-time>
actual_departure_date
string or null <date-time>
estimated_arrival_date
string or null <date-time>
actual_arrival_date
string or null <date-time>
estimated_pickup_date
string or null <date-time>
actual_pickup_date
string or null <date-time>
estimated_delivery_date
string or null <date-time>
actual_delivery_date
string or null <date-time>
last_free_day_date
string or null <date-time>
empty_ready_date
string or null
empty_returned_date
string or null <date>
cargo_ready_date
string or null <date>
available_for_pickup_date
string or null <date-time>
estimated_available_for_pickup_date
string or null <date-time>
object (ShipmentRef)
object (ContainerLegCollectionRef)
Array of objects (ShipmentItem)
400

error

get/ocean/shipment_containers/{id}
Response samples
application/json

Success

{
  • "_object": "/api/response",
  • "self": "https://api.flexport.com/ocean/shipment_containers/1234",
  • "version": 2,
  • "data": {
    • "_object": "/ocean/shipment_container",
    • "metadata": { },
    • "id": 283910,
    • "container_type": "dry",
    • "container_number": "BWSE3982156",
    • "container_size": "fourty_ft",
    • "seal_number": "UE_WQ2934875",
    • "estimated_departure_date": "2019-02-06T19:28:25+00:00",
    • "actual_departure_date": "2019-02-06T19:28:25+00:00",
    • "estimated_arrival_date": "2019-02-06T19:28:25+00:00",
    • "actual_arrival_date": "2019-02-06T19:28:25+00:00",
    • "estimated_pickup_date": "2019-02-06T19:28:25+00:00",
    • "actual_pickup_date": "2019-02-06T19:28:25+00:00",
    • "estimated_delivery_date": "2019-02-06T19:28:25+00:00",
    • "actual_delivery_date": "2019-02-06T19:28:25+00:00",
    • "last_free_day_date": "2019-02-16T00:00:00.000Z",
    • "empty_ready_date": "2019-02-16T00:00:00.000Z",
    • "empty_returned_date": "2019-02-28",
    • "cargo_ready_date": "2019-02-06",
    • "available_for_pickup_date": "2019-02-16T00:00:00.000Z",
    • "estimated_available_for_pickup_date": "2019-02-16T00:00:00.000Z",
    • "shipment": {},
    • "container_legs": {},
    • "items": [
      • {
        }
      ]
    }
}
➔ Next to ContainerLeg