Paginate, sort and filter the results of list endpoints.
The list endpoints — List quotations, List orders and List invoices — support pagination, sorting and filtering via query parameters.
Pagination
| Parameter | Description |
|---|---|
take | Number of results per page, max. 50. Required for orders and invoices — always set it. |
cursor | sequence of the item to continue after. You normally don't build it yourself — see below. |
total | Set to true to include the total number of results (total) in the response |
The response contains a links array. If there are more results, it includes an entry with rel: "next" (and, when you paged forward, rel: "previous"). Call its href to get the next page — it already contains take, cursor, orderBy and your filters. An empty links array means there are no further results.
GET /v1/orders?take=50&cursor=150
GET /v1/orders?take=50&total=trueSorting
orderBy sorts by sequence (creation order). Use sequence for ascending (default) or -sequence for descending order. sequence is the only sortable field — any other value returns 422.
GET /v1/orders?take=50&orderBy=sequence
GET /v1/orders?take=50&orderBy=-sequenceFiltering
filter takes an expression in the form <field><operator><value>:
| Operator | Meaning |
|---|---|
= | Equals |
!= | Not equals |
< | Less than |
<= | Less than or equals |
> | Greater than |
>= | Greater than or equals |
~ | Contains |
Which operators are available depends on the type of the field:
| Field type | Operators | Example |
|---|---|---|
| Text | = != < <= > >= ~ | consignee.address.city=Berlin |
| Number | = != < <= > >= | lines.unitWeight>100 |
| Date | = != < <= > >= | createdAt>=2026-01-01 (ISO 8601) |
| Enum | = != < <= > >= | product=EXPRESS |
| Boolean | = != | consignee.isPrivateCustomer=true |
- To apply several filters, repeat the
filterparameter.filterOperator=AND(default) orfilterOperator=ORcontrols how they are combined. - To match several values of the same field, separate them with
|. - Put text values that look like numbers, dates or booleans in double quotes, e.g.
documentNumber="2026000001". - List invoices always combines filters with AND —
filterOperatorisn't available there.
GET /v1/orders?take=50&filter=product=STANDARD
GET /v1/orders?take=50&filter=product=STANDARD&filter=createdAt>=2026-01-01
GET /v1/orders?take=50&filter=status=INITIALIZED|CREATEDFilterable fields
Only the fields below can be used in filter. Any other field returns 422.
List orders
| Area | Fields |
|---|---|
| Order | id, reference, status, product, transportType, shipmentStatus, incoterm, customerOrderCode, couponCode, wantsInsurance, wantsExportDeclaration, wantsClimateContribution, palletExchangeStatus, uitCode, easybillInvoice.documentNumber (invoice number), createdAt, updatedAt |
| Consignee | consignee.name, consignee.deliveryOn, consignee.isPrivateCustomer, consignee.wantsTailLiftTruck, consignee.wantsPremiumDelivery, consignee.wantsContactBeforeDelivery, consignee.wantsPhoneCallFromDriverBeforeDelivery, consignee.wantsDeliveryWithoutConsigneePresence, consignee.address.city / .street / .postCode / .countryCode, consignee.contactPerson.name / .phone / .email, consignee.neutralData.name / .city / .street / .postCode / .countryCode |
| Shipper | shipper.name, shipper.wantsTailLiftTruck, shipper.wantsContactBeforePickup, shipper.wantsPhoneCallFromDriverBeforePickup, shipper.address.city / .street / .postCode / .countryCode, shipper.contactPerson.name / .phone / .email, shipper.neutralData.name / .city / .street / .postCode / .countryCode |
| Lines | lines.unitPackageType, lines.unitQuantity, lines.unitLength, lines.unitWidth, lines.unitHeight, lines.unitWeight, lines.content, lines.combinedNomenclatureCode, lines.isStackable, lines.wantsPalletExchange |
List quotations
| Area | Fields |
|---|---|
| Quotation | id, status, product, transportType, incoterm, customerOrderCode, couponCode, wantsInsurance, wantsExportDeclaration, wantsClimateContribution, isSupplyingCompanyOrReceivingCustomer, createdAt, updatedAt, placedAt |
| Consignee | same as for orders, plus consignee.deliveryAtFrom, consignee.deliveryAtUntil |
| Shipper | same as for orders, plus shipper.pickupAtFrom, shipper.pickupAtUntil |
| Lines | same as for orders |
List invoices
id, documentNumber, documentId, documentAmount, isDocumentCompleted, documentCompletedAt, isDocumentCancelled, documentCancelledAt, isDocumentSent, documentSentAt, isDone, dueDate, dueInDays, isPaid, paidAt, paymentAmount, paymentCurrency, createdAt, updatedAt