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)
get/ocean/shipment_container_legs
Response samples
application/json

Success

{}

Retrieve a container leg on an Ocean shipment

Request
path Parameters
id
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)
object (LegRef)
dates
Array of objects
get/ocean/shipment_container_legs/{id}
Response samples
application/json

Success

{}