v4

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-04-277127123.7 KB
Orders

List orders

get/orders

Query parameters

pageinteger

Page number for pagination.

per_pageinteger

Number of results per page.

searchstring

Field to search by (e.g. email, tag).

querystring

Search term to filter by.

date_beginstring date
Example:2024-01-01

Start date filter (ISO 8601).

date_endstring date
Example:2024-12-31

End date filter (ISO 8601).

orderstring

Field to sort results by.

sort'asc' | 'desc'

Sort direction.

status'DRAFT' | 'PENDING_DETAILS' | 'PENDING_PUBLISH' | 'PUBLISHED' | 'ACCEPTED' | 'REJECTED' | 'CANCELLED' | 'RELEASED'

Filter by order status.

sandboxboolean

Filter sandbox orders.

Response

Paginated list of orders

current_pageinteger
last_pageinteger
per_pageinteger
totalinteger
frominteger
tointeger

Example response

{
  "current_page": 1,
  "last_page": 5,
  "per_page": 15,
  "total": 73,
  "from": 1,
  "to": 15,
  "data": [
    {
      "self": "/2.0/orders/1234",
      "currency": "EUR",
      "amount": "150.00 €"
    }
  ]
}