GET
/
order
Get a list of orders.
curl --request GET \
  --url https://playground.runa.io/v2/order \
  --header 'X-Api-Key: <api-key>'
{
  "items": [
    {
      "id": "O-01H5WQGHKCBB85MQFM68S9KJ5Q",
      "status": "COMPLETED",
      "created_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "payment_method": {
        "type": "ACCOUNT_BALANCE"
      },
      "currency": "USD",
      "total_price": "10",
      "total_discount": 123
    }
  ],
  "pagination": {
    "cursors": {
      "after": "ZXhhbXBsZW9mYWN1cnNvcg==",
      "before": "ZXhhbXBsZW9mYWN1cnNvcg=="
    },
    "page": {
      "limit": 100
    }
  }
}

Authorizations

​
X-Api-Key
string
header
required

Headers

​
X-Api-Version
string

The dated version of the API, if not specified a default is used.

Query Parameters

​
limit
integer

The number (1–100) of orders to include in each page of orders. Default: 100.

​
before
string

A cursor. Using this parameter will return the page of orders from before the cursor (i.e., the previous page). The before and after cursors are mutually exclusive (you can't use them at the same time). Get this value from the pagination section of any page of orders.

​
after
string

A cursor. Using this parameter will return the page of orders from after the cursor (i.e., the next page). The before and after cursors are mutually exclusive (you can't use them at the same time). Get this value from the pagination section of any page of orders.

Response

200
application/json

OK

The response is of type object.