Skip to main content
GET
Get Order by ID

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

Query Parameters

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

Order details including lines and DDS references

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