List all orders of the merchant

Request

Security

ApiKey

Query

page[page]integer, >= 1

The 1-based page number to fetch (offset pagination).

Default:1

page[size]integer, >= 1

The maximum number of results to return per page.

filter[status]string

Filter orders by status. Accepts the high-level aliases pending, paid, placed, cancelled, all, a comma-separated combination of refund statuses (for example refund_proposed,refund_processing), or an exact internal status string.

Example:filter[status]=paid

filter[search]string

Case-insensitive search matching the order reference, the customer email, or part of the order UUID.

filter[date_range]string

Filter orders by a predefined creation-date range.

Default:"all"

Enum:"all""current_day""last_day""current_week""last_week""current_month""last_month""current_year"

sortstring

Sort field. Prefix with - for descending order (for example -created_at).

Enum:"created_at""reference""customer_email""currency""total""settlement_amount""status"

includestring

Value:"payment"

curl -i -X GET \
  'https://docs.xmoney.com/_mock/crypto_api/reference/stores/orders?page%5Bpage%5D=1&page%5Bsize%5D=1&filter%5Bstatus%5D=paid&filter%5Bsearch%5D=string&filter%5Bdate_range%5D=all&sort=created_at&include=payment' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

List of orders for merchant

Bodyapplication/vnd.api+json

dataArray of items

Response

{
  "data": [
    { … }
  ]
}