List shipments

Operation ID: shipments

Group: Inventory › Shipments

GET /inventory/shipments

Read-only: Reads and returns; changes nothing.

Lists shipments. The response has each shipment's main fields, without its lines. lineCount is the number of lines. To get the lines, or to filter by customer, item, warehouse, reference number, or tracking number, use POST inventory/shipments/search.

Parameters

Name	In	Type	Required	Description
`Api-Version`	header	string · v1	yes	The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version `v1`.

Query surface

id — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
documentNumber — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
documentStatus — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
documentDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between
deliveryDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between
entityId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
shipmentCarrierId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
returnStatus — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
lastModifiedDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between
Orderable: id, documentNumber, documentDate, deliveryDate, documentStatus, totalAmount, createdDate, lastModifiedDate
Selectable: id, documentNumber, documentStatus, documentDate, deliveryDate, entityId, entityName, businessPartnerId, businessPartnerName, shipmentCarrierId, shipmentCarrierName, returnStatus, referenceNumber, trackingNumber, currency, totalAmount, lineCount, notes, createdDate, lastModifiedDate
page[size] — Page size
page[cursor] — Opaque continuation cursor

Response

200 Success

Under data, an array of shipmentsRow:

Field	Type	Required	Filter	Sort	Description
`id`	string	no	Exact (`eq`, `ne`), Range (`gt`, `gte`, `lt`, `lte`, `between`), Any of (`in`, `notIn`), Pattern (`like`)	yes	The unique identifier for the shipment. Example: `"2f7c9b31-8a05-4d16-b47e-903c5f1a86d2"`.
`documentNumber`	string \| null	no	Exact (`eq`, `ne`), Range (`gt`, `gte`, `lt`, `lte`, `between`), Any of (`in`, `notIn`), Pattern (`like`)	yes	The shipment's document number, for example 'SD-8841'. Absent while none has been assigned. Example: `"SD-8841"`.
`documentStatus`	string	no	Exact (`eq`, `ne`), Range (`gt`, `gte`, `lt`, `lte`, `between`), Any of (`in`, `notIn`), Pattern (`like`)	yes	The status of the shipment. Possible values: 'DRAFT', 'PACKED', 'PARTIALLY_SHIPPED', 'SHIPPED', 'COMMITTED', 'DELIVERED', 'COMPLETED', 'CANCELLED', 'INVOICED', 'PARTIALLY_INVOICED', 'RETURNED', 'PARTIALLY_RETURNED'. Example: `"DRAFT"`.
`documentDate`	date	no	Exact (`eq`, `ne`), Range (`gt`, `gte`, `lt`, `lte`, `between`), Any of (`in`, `notIn`)	yes	The date the shipment is dated. Format YYYY-MM-DD. Example: `"2026-08-14"`.
`deliveryDate`	date \| null	no	Exact (`eq`, `ne`), Range (`gt`, `gte`, `lt`, `lte`, `between`), Any of (`in`, `notIn`)	yes	The planned or actual delivery date. Format YYYY-MM-DD. Example: `"2026-08-19"`.
`entityId`	string	no	Exact (`eq`, `ne`), Range (`gt`, `gte`, `lt`, `lte`, `between`), Any of (`in`, `notIn`), Pattern (`like`)	no	The unique identifier for the legal entity the shipment belongs to. See id on GET base/entities. Example: `"1a9c4e70-38b5-4d26-9f01-7c2e5b8a6d43"`.
`entityName`	string \| null	no	no	no	The display name of that legal entity. Example: `"Acme Netherlands B.V."`.
`businessPartnerId`	string	no	no	no	The unique identifier for the customer the goods go to. Despite the name, this is a customer id. See id on GET accounting/customers/:id. Example: `"c73f2b81-5d94-4e60-a812-0f9b6d3e45c7"`.
`businessPartnerName`	string \| null	no	no	no	The display name of that customer. Example: `"Bakker Retail B.V."`.
`shipmentCarrierId`	string \| null	no	Exact (`eq`, `ne`), Range (`gt`, `gte`, `lt`, `lte`, `between`), Any of (`in`, `notIn`), Pattern (`like`)	no	The unique identifier for the carrier taking the goods. See id on GET inventory/shipment-carriers/:id. Example: `"9d0a5e26-b183-4c47-92f5-6a4e17b0c853"`.
`shipmentCarrierName`	string \| null	no	no	no	The name of that carrier. Example: `"PostNL"`.
`returnStatus`	string \| null	no	Exact (`eq`, `ne`), Range (`gt`, `gte`, `lt`, `lte`, `between`), Any of (`in`, `notIn`), Pattern (`like`)	no	How much of the shipment has come back on sales returns. Possible values: 'OPEN', 'PARTIALLY_RETURNED', 'FULLY_RETURNED'. The return process maintains it. Example: `"OPEN"`.
`referenceNumber`	string \| null	no	no	no	The customer's own reference for the shipment. Example: `"SO-4471"`.
`trackingNumber`	string \| null	no	no	no	The carrier's tracking number for the goods. Example: `"3STBJG7291043"`.
`currency`	string \| null	no	no	no	The currency of every amount on the shipment. Format ISO 4217, for example 'EUR'. Example: `"EUR"`.
`totalAmount`	decimal \| null	no	no	yes	The total value of the shipment, in the shipment's currency. Example: `"960.00"`.
`lineCount`	number \| null	no	no	no	The number of lines the shipment has. The collection does not return the lines themselves. Example: `1`.
`notes`	string \| null	no	no	no	Free text on the shipment. Example: `"Palletised"`.
`createdDate`	date-time \| null	no	no	yes	The date and time the shipment was created, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. Example: `"2026-08-14T08:30:00.000Z"`.
`lastModifiedDate`	date-time \| null	no	Exact (`eq`, `ne`), Range (`gt`, `gte`, `lt`, `lte`, `between`), Any of (`in`, `notIn`)	yes	The date and time the shipment record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. Example: `"2026-08-14T08:30:00.000Z"`.

{
  "data": [
    {
      "id": "2f7c9b31-8a05-4d16-b47e-903c5f1a86d2",
      "documentNumber": "SD-8841",
      "documentStatus": "DRAFT",
      "documentDate": "2026-08-14",
      "deliveryDate": "2026-08-19",
      "entityId": "1a9c4e70-38b5-4d26-9f01-7c2e5b8a6d43",
      "entityName": "Acme Netherlands B.V.",
      "businessPartnerId": "c73f2b81-5d94-4e60-a812-0f9b6d3e45c7",
      "businessPartnerName": "Bakker Retail B.V.",
      "shipmentCarrierId": "9d0a5e26-b183-4c47-92f5-6a4e17b0c853",
      "shipmentCarrierName": "PostNL",
      "returnStatus": "OPEN",
      "referenceNumber": "SO-4471",
      "trackingNumber": "3STBJG7291043",
      "currency": "EUR",
      "totalAmount": "960.00",
      "lineCount": 1,
      "notes": "Palletised",
      "createdDate": "2026-08-14T08:30:00.000Z",
      "lastModifiedDate": "2026-08-14T08:30:00.000Z"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "<nextCursor>"
  }
}

Statuses

400 — Invalid request or business failure
401 — The request carries no valid access token.
403 — Not authorized
404 — Not found
429 — Too many requests from this client address. The response has no body and no Retry-After header.
500 — Internal server error