List orders

get

https://myapi.xegora.com/api/v1/orders

Newest-first (by creation), offset-paginated listing of the workspace's API orders. Every filter is optional and they combine. Send status or statusGroup, not both. A sync that remembers when it last looked reads only what changed since with updatedFrom. Requires the orders.read scope.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

offset

integer

0 to 100000

Defaults to 0

limit

integer

1 to 100

Defaults to 50

status

string

enum

Exactly one status name, in any letter case and with surrounding spaces ignored (fulfilled and Fulfilled both match). A number, a comma-separated list, two names separated by a space or an unknown name is 400 — the same rule the withdrawal lists apply to their status.

statusGroup

string

enum

Several statuses read as one state, case-insensitive: open (pending, reserved, processing), delivered (fulfilled), failed (failed, cancelled), refunded, refund_pending (refundpending), under_review (reconciliationrequired). Not together with status.

Allowed:

clientReference

string

length ≤ 200

Exactly this client reference (trimmed, as order creation stored it) — not a prefix or a substring.

reference

string

^[oO][rR][dD]_[0-9a-fA-F]{32}$

Exactly the order with this Xegora reference, in any letter case; anything else is 400.

productId

uuid

Orders with a line that bought this catalog product.

createdFrom

date-time

Orders created at or after this instant.

createdTo

date-time

Orders created before this instant; must come after createdFrom.

updatedFrom

date-time

Orders last changed (updatedAtUtc) at or after this instant.

updatedTo

date-time

Orders last changed before this instant; must come after updatedFrom.

Headers

X-Correlation-Id

string

length ≤ 128

^[A-Za-z0-9._:-]{1,128}$

Your own correlation id, carried through Xegora's logs and audit records and returned in correlationId. Kept when it is 1–128 characters of ASCII letters, digits, ., _, : and -; anything else is replaced by an id of Xegora's.

X-Language

string

enum

The language an error's message, title and detail are written in; without it, Accept-Language decides, then English. Successful responses are not translated.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200A page of orders.

400The request is malformed (code = invalid_request): a bad parameter or header, a missing or malformed Idempotency-Key, or a body member the contract does not have — named, by its path in the body, in errors. Do not retry unchanged.

401No valid API key (code = unauthorized): missing, malformed, unknown, revoked or expired, or a wrong secret. The message is worded for an API key — this surface has no session to sign in to.