Skip to main content
GET
List all orders

Authorizations

Authorization
string
header
required

Sign in to the admin dashboard and use the resulting ID token for a store and operation you can access. The authenticated dashboard cookie is accepted when the Authorization header is absent. Missing or insufficient access returns 401.

Query Parameters

page
integer
default:1

Page number, starting at 1. Non-integer values and values below 1 return 400.

Required range: x >= 1
limit
integer
default:25

Results per page. Values below 1 use 1; values above 500 return 400. Non-integer input returns 400.

Required range: 1 <= x <= 500
filters
string

JSON object

Example:

"{\"condition\":\"AND\",\"filters\":[{\"type\":\"data\",\"field\":\"status\",\"operator\":\"equals\",\"value\":\"success\"}]}"

sort_by
string

JSON string format: {"field1":"asc", "field2":"desc"} json string in format {'field_name':'asc', 'other_field_name':'desc', ...}

search keyword

billing_first_name
string

Case-insensitive match within the billing first name.

billing_phone
string

Case-insensitive match within the billing phone number.

coupon_code
string

Case-insensitive match within the coupon code.

on_subscription
boolean

Filter orders by whether they contain a subscription.

payment_status
string

Comma-separated payment statuses; optional square brackets and quotes are accepted.

status
string

Comma-separated order statuses; optional square brackets and quotes are accepted.

Response

OK

message
string
required
success
boolean
required
content
object
required