/shipments
List shipments
Returns a paginated list of shipments, newest business key last — sorted by shipmentNumber so paging is deterministic. ?modifiedSince= returns both created and modified shipments, so it can be used for delta sync; deletions are reported by GET /preview/deletions.
Show the full description
Each shipment carries all of its lines, including lines belonging to other orders on a consolidated shipment — use GET /preview/orders/{orderNumber}/shipments for the order-scoped view.
Query parameters
| Field | Type | Description |
|---|---|---|
search
|
string | Matches shipment number and tracking number, case-insensitively and on partial words. |
orderNumber
|
string | Returns only the shipments fulfilling this sales order number. |
status
|
enum |
Filters on where the shipment stands in the pick-pack-ship flow.
Hold
Released
Picking
Picked
ReadyForPickup
Packing
Packed
Booked
PickedUp
InTransit
Delivered
Failed
Cancelled
|
modifiedSince
|
string(date-time) | Returns only records created or changed at or after this instant (ISO 8601 UTC datetime). A change anywhere inside the record counts, including on its lines. |
page
|
integer | Page to return, 1-based. Default 1. |
pageSize
|
integer | Number of records per page. Default 50, max 200. |
Responses
PagedResult_PublicShipmentResponse
Paginated response: the fields below sit in items[], wrapped in totalCount, page, pageSize, totalPages, hasPreviousPage and hasNextPage. Paginated
| Field | Type | Description |
|---|---|---|
createdDate
|
string(date-time) | UTC timestamp when the shipment was created. |
deliveredDate
|
string(date-time) · nullable | UTC timestamp when the shipment was delivered. Null if not yet delivered. |
lines
|
ShipmentLine[] · nullable | Shipment lines. Scoped to the addressed order when read through an order. |
links
|
Links | Hypermedia links for a public API resource. Exposed as a computed `links` property on the public response DTOs so that create and read responses carry the same self-reference — the canonical URL is derived from the business key already present on the DTO and can never drift from the route it points at. |
plannedShipDate
|
string(date) · nullable | Planned ship date (ISO 8601 date). Null if not yet planned. |
shipmentNumber
|
string · nullable | Unique shipment number, e.g. `SHIP-2026-00128`. |
shippedDate
|
string(date-time) · nullable | UTC timestamp when the shipment was handed over to the carrier. Null if not yet shipped. |
shippingMethodName
|
string · nullable | Name of the shipping method / carrier. Null if not set. |
status
|
enum |
Shipment status values exposed via the Public API.
Mirrors the internal shipment lifecycle from warehouse release to delivery.
Hold
Released
Picking
Picked
ReadyForPickup
Packing
Packed
Booked
PickedUp
InTransit
Delivered
Failed
Cancelled
|
totalWeightKg
|
decimal · nullable | Total weight in kilograms. Serialised as a decimal string. Null if not weighed. |
trackingNumber
|
string · nullable | Carrier tracking number. Null until the shipment is booked with a carrier. |
ProblemDetails
?status= got a value outside its list.
| Field | Type |
|---|---|
detail
|
string · nullable |
instance
|
string · nullable |
status
|
integer · nullable |
title
|
string · nullable |
type
|
string · nullable |
Standard errors:
401
403
Errors
Examples
curl "https://api.erp.fluit.cloud/preview/shipments" \
-H "X-Api-Key: fluit_live_sk_..."{
"hasNextPage": true,
"hasPreviousPage": true,
"items": [
{
"createdDate": "2026-06-11T09:24:13.418",
"deliveredDate": "2026-06-11T09:24:13.418",
"lines": [
{
"itemName": "Widget A",
"itemNumber": "WIDGET-A",
"orderLineNumber": 42,
"orderNumber": "SO-2026-1041",
"pickedQuantity": "10",
"quantity": "10",
"unit": "st"
}
],
"links": {
"self": "string"
},
"plannedShipDate": "2026-06-11",
"shipmentNumber": "SH-2026-0455",
"shippedDate": "2026-06-11T09:24:13.418",
"shippingMethodName": "Parcel, next day",
"status": "Hold",
"totalWeightKg": "1.250",
"trackingNumber": "ABC-001"
}
],
"page": 1,
"pageSize": 50,
"totalCount": 137,
"totalPages": 3
}Base URL https://api.erp.fluit.cloud/preview. The response example is generated from the schema: the shape is right, the values are made up.