List Orders

Returns the orders of the calling member in this application, newest first, and paginated. A member only ever sees their own orders, so there is no way to list another member's orders with this endpoint. Use List Order Items for the producer view across the whole application.

An order is a container: its lifecycle lives on its items, and the order status is only created or cancelled. Each order carries its items and any refunds issued against it.

Query parameters, all optional:

  • status: created or cancelled.
  • redemption_method: reward_item or cash.
  • reward_item_id, product_id, variant_id: UUIDs that narrow the list to orders paid with one reward item, or containing one product or variant.
  • total_amount__gte, total_amount__lte: inclusive bounds on the order total.
  • since, until: ISO 8601 times. since is inclusive and until is exclusive, both on the creation time.
  • ordering: created_at, updated_at, status or total_amount. Prefix with a minus for descending order. The default is -created_at.
  • page and page_size: pagination. The default page size is 20.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The client ID of the application.

Query Params
string
enum

Only orders with this status.

Allowed:
integer

Page number.

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json