List shipment rows
Logistics module
GET/shipmentsshipments.list
A shipment into or out of a venue. Returns a cursor page of shipment rows the caller may see. The default order is `ships_at` ascending. Supports sparse fieldsets and the filter grammar.
- Requires the capability logistics.shipment.read.
- OAuth scopes: logistics.
- Cursor-paginated: limit, cursor, fields, sort and filter apply.
- Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| limit | Limit | No | Page size. Default 50, maximum 200.Constraints: range 1 to 200 |
| cursor | Cursor | No | Opaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
| sort | Sort | No | Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Constraints: pattern ^-?[a-z_][a-z0-9_]*(,-?[a-z_][a-z0-9_]*)*$ |
| filter | Filter | No | Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND. |
Response 200: a page of Shipment
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the shipment. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| project_id | string (uuid) | Yes | Identifier of the project. |
| tracking_identifier | string | null | Yes | Carrier tracking identifier.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| direction | string | Yes | Inbound or outbound.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| ships_at | string (date-time) | null | Yes | Expected arrival or departure. |
| carrier_counterparty_id | string (uuid) | null | Yes | Identifier of the carrier, as a counterparty of the org. |
| freight_type_enum_id | string | null | Yes | Canon freight type, from xpms.std_enumeration.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| arrives_at | string (date-time) | null | Yes | When the shipment is due to arrive. |
| shipment_number | integer | Yes | Number within the project; the display key is {project_key}-{shipment_number}.Constraints: range 1 to any |
| urid | Urid | null | Yes | |
| description | string | null | Yes | What the shipment carries, in a sentence.Constraints: length 1 to 2000 |
| origin | string | null | Yes | Where the freight ships from, as a locality.Constraints: length 1 to 200 |
| sender_counterparty_id | string (uuid) | null | Yes | Identifier of the vendor sending the freight; the carrier is carrier_counterparty_id. |
| pallet_count | integer | null | Yes | Number of pallets.Constraints: range 0 to any |
| piece_count | integer | null | Yes | Number of pieces.Constraints: range 0 to any |
| length_ft | number | null | Yes | Length of the load in feet. |
| width_ft | number | null | Yes | Width of the load in feet. |
| height_ft | number | null | Yes | Height of the load in feet. |
| weight_lb | number | null | Yes | Weight of the load in pounds. |
| trailer_license | string | null | Yes | License plate of the trailer.Constraints: length 1 to 100 |
| seal_identifier | string | null | Yes | Number of the seal applied to the trailer.Constraints: length 1 to 100 |
| bill_of_lading_identifier | string | null | Yes | Bill of lading number issued by the carrier.Constraints: length 1 to 100 |
{
"data": [
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"tracking_identifier": "CF123456789",
"direction": "inbound",
"ships_at": "2026-10-08T14:30:00Z",
"carrier_counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"freight_type_enum_id": "ENM-041",
"arrives_at": "2026-10-08T14:30:00Z",
"shipment_number": 7,
"urid": "4000.01.01",
"description": "Two pallets of truss and motors.",
"origin": "Orlando, FL",
"sender_counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"pallet_count": 2,
"piece_count": 14,
"length_ft": 48,
"width_ft": 8.5,
"height_ft": 9,
"weight_lb": 12000,
"trailer_license": "FL TRL-4410",
"seal_identifier": "SL-778120",
"bill_of_lading_identifier": "BOL-2027-0611"
}
],
"next_cursor": null
}Code samples
curl -X GET "$XOS_BASE_URL/shipments" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.shipments.listAll()) {
console.log(row);
}for row in xos.shipments.list_all():
print(row)xos shipments list --all