Skip to main content
GET
/
order
List orders
curl --request GET \
  --url https://playground.runa.io/v2/order \
  --header 'X-Api-Key: <api-key>'
{
  "items": [
    {
      "id": "O-01H5WQGHKCBB85MQFM68S9KJ5Q",
      "status": "PROCESSING",
      "created_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z",
      "description": "Your own reference text",
      "payment_method": {
        "type": "ACCOUNT_BALANCE",
        "currency": "USD"
      },
      "currency": "USD",
      "total_price": "10",
      "total_discount": "1"
    }
  ],
  "pagination": {
    "cursors": {
      "after": "A-789",
      "before": "A-123"
    },
    "page": {
      "limit": 100
    }
  }
}
This endpoint is paginated and supports cursor based pagination. Each response includes a next_cursor and previous_cursor which can be used to fetch the next and previous pages of results. The orders returned only contain a subset of the fields that are returned for a single order. To fetch the full details of an order use the single order get endpoint. This endpoint can return both complete and incomplete orders. The types of these responses differ, you should use the status field to determine which type of response you are receiving.
  • Completed orders will have a status of COMPLETED or FAILED and have a full response body.
  • Incomplete orders will have a status of PROCESSING and have a partial response body.

Authorizations

​
X-Api-Key
string
header
required

Your API key. See the API key page on details of how to generate and store your keys.

Headers

​
X-Api-Version
string

The dated version of the API, if not specified a default is used. See API versioning for more information.

Query Parameters

​
limit
integer
default:100

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

Required range: 1 <= x <= 500
​
before
string

A cursor for use in pagination to return the previous set of results. The before and after cursors are mutually exclusive (you can't use them at the same time). You can get a value from the pagination.cursors.before field in the response. See pagination for more information.

Example:

"A-123"

​
after
string

A cursor for use in pagination to return the next set of results. The before and after cursors are mutually exclusive (you can't use them at the same time). You can get a value from the pagination.cursors.after field in the response. See pagination for more information.

Example:

"A-789"

Response

OK

​
items
Items · array
required

The list of orders in the page.

  • Completed order
  • Incomplete order
​
pagination
object
required

Metadata of the result page. Information about the page of results returned. See pagination for more information on how to page through results.