Skip to main content
GET
List Orders

Authorizations

Authorization
string
header
required

API key generated in Settings > API Keys. Include as Authorization: Bearer <key>.

Query Parameters

changedSince
string<date-time>

Return only orders whose own data or DDS linkage changed at or after this instant (inclusive). ISO 8601 with Z or an offset (URL-encode + as %2B); passed once. Deletions and unlinking are not covered — see the Batch Import guide for the delta-sync pattern.

hasDdsReference
enum<string>

Restrict to orders that already have a DDS statement linked (true), or to orders that have none yet (false). Note this means a DDS is linked, not that it has been submitted to TRACES — a linked but unsubmitted DDS appears with an empty referenceNumber. A withdrawn or rejected DDS, or one deleted before it was filed with TRACES, does not count as linked (false returns the order; its ddsReferences is empty). Do not combine true with changedSince in a delta poll: the filter hides an order whose DDS was withdrawn or rejected, or deleted before it was filed with TRACES.

Available options:
true,
false
status
enum<string>

Restrict to orders with this derived status (see the status field). One value, passed once; any other value or a repeated key is rejected with 400.

Available options:
open,
done,
notRelevant
orderNumbers
string

Comma-separated list of order numbers to return, e.g. ORD-1,ORD-2. Maximum 1000 values; the answer is still paged, so send limit when you name more than 100. Pass the parameter once — repeating the key is rejected rather than silently using only the first value. An empty list is rejected with 400.

limit
integer
default:100

Maximum number of results to return (default 100, max 1000).

Required range: 1 <= x <= 1000
offset
integer | null
default:0

Number of results to skip for pagination. Results are returned in a stable total order, so paging with limit and offset never skips or repeats an order.

Required range: x >= 0
fields
string

Comma-separated list of the resource's top-level keys to return (per element for a list), e.g. id,name; omit for the full body. Top-level only; whitespace is trimmed and duplicates count once. fields never adds keys: a selected optional key that is absent on a row stays absent. 400 when passed more than once, when empty, or when it names an unknown key (the error names it and lists the allowed ones).

Response

List of orders

id
string
required

UUID of the order.

supplier
object
required
orderNumber
string
required

Your order number, unique per company — the key batch imports upsert on.

orderDate
string | null
required

Order date (ISO 8601, UTC), or null.

deliveryDate
string | null
required

Delivery date (ISO 8601, UTC), or null when not known. When the lines carry their own dates (lines[].deliveryDate), the earliest of them.

orderType
string
required

purchase (inbound from a supplier) or sale (outbound to a customer).

lines
object[]
required

The order lines.

totalVolume
number
required

Sum of all order line quantities

ddsReferences
object[]
required

The TRACES referenceNumber / verificationNumber pairs of the live DDS statements linked to this order. A withdrawn or rejected statement is not listed; an archived one stays.

status
enum<string>
required

Derived EUDR status of the order, recomputed on every read (never stored). notRelevant: no line carries an EUDR-relevant article AND no line's article awaits the manual EUDR check (lines[].article.needsManualCheck) — such a line counts as EUDR-relevant below until a person resolves the check. done: every EUDR-relevant line is covered by a submitted, validated or grouped DDS linked to THIS order that declares the line's article FOR THE ORDER'S SUPPLIER with enough remaining volume (the article's quantity over all orders of that supplier linked to that DDS does not exceed its declared volume; an order of another supplier linked by hand stays open). open: otherwise — including after a quantity increase beyond the declared volume, an article change, or a withdrawn/rejected DDS.

Available options:
open,
done,
notRelevant