List orders

Returns a collection of created orders.

Filtering — see Basic Usage → Filtering

?filter[id]=1,2,3 — one or more order IDs
?filter[state]=completed / cancelled — by state
?filter[external_identifier]=organic — by your own identifier
?filter[external_reference]=143000 — by your own reference
?filter[since_id]=1 — IDs greater than the given ID
?filter[created_at_min]=2025-09-27 / created_at_max — created in range
?filter[updated_at_min] / updated_at_max — updated in range

Expanding objects (Basic Usage → Expanding Objects) — ?expand=order_type, ?expand=items.id_tags, ?expand=items.variant.

AuthorizationbearerAuth

Authorization

bearerAuth

AuthorizationBearer <token>

OAuth2 access token — how to obtain one is described under Setup → Authentication.

In: header

Query Parameters

page?integer

Page number — see Basic Usage → Pagination.

Default1

per_page?integer

Rangevalue <= 100

Default25

filter[state]?string

Value in

"open"
"prepared"
"completed"
"failed"
"cancelled"

filter[external_identifier]?string

filter[external_reference]?string

filter[since_id]?integer

filter[created_at_min]?string

Formatdate

filter[created_at_max]?string

Formatdate

expand?string

Header Parameters

Accept*"application/json"

The API only responds with JSON — this header is mandatory on every request (see Setup → Headers).

Default"application/json"

Value in

"application/json"

Response Body

`application/json`

Request example

curl -X GET "https://example.com/orders" \  -H "Accept: application/json"

{  "data": [    {      "id": 0,      "state": "open",      "external_identifier": "string",      "external_reference": "string",      "customer_id": 0,      "items": [        {          "id": 0,          "variant_id": 0,          "quantity": 0,          "id_tags": [            {              "id": 0,              "code": "string"            }          ]        }      ],      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "current_page": 0,    "per_page": 0,    "total": 0  }}