GET /v1/shipments

Shipments of a deal

The container/bill of lading of the deal with tracking events. deal_id is required. Requires scope write:deals.

Authentication: header Authorization: Bearer rv_live_... (API keys and scopes)
Required scope: write:deals

Descriptions of the operation, parameters and fields come from the OpenAPI specification (openapi.json).

Parameters

Field	In	Type	Required	Description
`deal_id`	query	`string (uuid)`	yes	Deal whose shipment to return.

Shipments of the deal.

application/json · Schema: ShipmentList

Field	Type	Required	Description
`items`	`object[]`	yes
`items[].id`	`string (uuid)`	no
`items[].dealId`	`string (uuid)`	no
`items[].status`	`"planned" \| "booked" \| "loaded" \| "in_transit" \| "at_port" \| "discharged" \| "released" \| "delivered"`	no
`items[].containerNo`	`string \| null`	no
`items[].billOfLading`	`string \| null`	no
`items[].vessel`	`string \| null`	no
`items[].portFrom`	`string \| null`	no
`items[].portTo`	`string \| null`	no
`items[].etd`	`string \| null`	no	ISO 8601 date-time (UTC).
`items[].eta`	`string \| null`	no	ISO 8601 date-time (UTC).
`items[].ata`	`string \| null`	no	ISO 8601 date-time (UTC).
`items[].events`	`object[]`	no
`items[].lastTrackedAt`	`string \| null`	no	ISO 8601 date-time (UTC).
`items[].warnings`	`string[]`	no