Filtering shipments
Pass filter parameters to narrow results:
Available shipment filters:
| Filter | Type | Description |
|---|
status | string | Shipment status (for example in_transit or delivered) |
port | string | UN/LOCODE for port of discharge |
carrier | string | SCAC code (for example MAEU, HLCU) |
updatedAfter | ISO 8601 | Only shipments updated after this timestamp |
includeContainers | boolean | Set to false to omit containers from the included relationships |
Filtering containers
Available container filters:
| Filter | Type | Description |
|---|
status | string | Container status |
port | string | UN/LOCODE for port of discharge |
carrier | string | SCAC code |
updatedAfter | ISO 8601 | Only containers updated after this timestamp |
include | string | Comma-delimited list of related resources to include |
For list endpoints, avoid heavy include usage for performance. When you need deep relationships, prefer single-resource endpoints like containers.get or shipments.get.
List methods accept pagination options with page and pageSize (page numbers are 1-based):
When using format: 'mapped', list results include items, links, and meta. When using format: 'raw', these live in the JSON:API response.
Common patterns
Recently updated shipments
In-transit containers at a specific port