ContainerLeg

Endpoints relating to ContainerLeg objects

List all container legs

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.leg.id	integer Only return containers legs associated with the shipment leg specified by this id.
f.shipment_container.id	integer Only return containers legs associated with the shipment container specified by this id.
f.shipment_container.container_number	string Only return containers legs associated with the given container number.

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 (OceanShipmentContainerLeg)

400

error

get/ocean/shipment_container_legs

Response samples

application/json

Success

{"_object": "/api/response",
"self": "https://api.flexport.com/ocean/shipment_container_legs",
"version": 2,
"data": {"_object": "/api/collections/paginated",
"prev": "https://api.flexport.com/ocean/shipment_container_legs?page=1",
"next": "https://api.flexport.com/ocean/shipment_container_legs?page=3",
"data": [{"_object": "/ocean/shipment_container_leg",
"shipment_container": {"_object": "/api/refs/object",
"ref_type": "/ocean/shipment_container",
"link": "https://api.flexport.com/ocean/shipment_containers/123",
"id": 123
},
"leg": {"_object": "/api/refs/object",
"ref_type": "/shipment_leg",
"link": "https://api.flexport.com/shipment_legs/123",
"id": 123
},
"dates": [{"actual_loaded_on_board_date": "2019-01-18T22:08:38.599Z"
}
]
}
]
}
}

Retrieve a container leg on an Ocean shipment

Request

path Parameters

required

integer

The unique id for the ContainerLeg to be retrieved

Responses

200

Success

Response Schema: application/json

_object

string

self

string

version

integer

object (OceanShipmentContainerLeg)

_object	string Type of the object
	object (ContainerRef) Expandable API link.
	object (LegRef) Expandable API link.
dates	Array of objects

400

error

get/ocean/shipment_container_legs/{id}

Response samples

application/json

Success

{"_object": "/api/response",
"self": "https://api.flexport.com/ocean/shipment_container_legs/1234",
"version": 2,
"data": {"_object": "/ocean/shipment_container_leg",
"shipment_container": {"_object": "/api/refs/object",
"ref_type": "/ocean/shipment_container",
"link": "https://api.flexport.com/ocean/shipment_containers/123",
"id": 123
},
"leg": {"_object": "/api/refs/object",
"ref_type": "/shipment_leg",
"link": "https://api.flexport.com/shipment_legs/123",
"id": 123
},
"dates": [{"actual_loaded_on_board_date": "2019-01-18T22:08:38.599Z"
}
]
}
}

➔ Next to Shipment