Skip to main content
GET
Spree SDK

Authorizations

x-spree-api-key
string
header
required

Publishable API key for store access

Authorization
string
header
required

JWT token for authenticated customers

Headers

x-spree-api-key
string
required
Authorization
string
required

Query Parameters

page
integer

Page number (default: 1)

limit
integer

Number of results per page (default: 25, max: 100)

sort
string

Sort order. Prefix with - for descending. Values: completed_at, -completed_at, total, -total, number, -number

q[completed_at_gt]
string

Filter by completed after date (ISO 8601)

q[completed_at_lt]
string

Filter by completed before date (ISO 8601)

q[number_eq]
string

Filter by exact order number (e.g., R123456)

q[state_eq]
string

Filter by order state (complete, returned, canceled)

q[payment_state_eq]
string

Filter by payment state (paid, balance_due, credit_owed, void, failed)

q[total_gteq]
number

Filter by minimum total

q[total_lteq]
number

Filter by maximum total

expand
string

Comma-separated associations to expand (items, fulfillments, payments, discounts, billing_address, shipping_address, gift_card). Use "none" to skip associations.

fields
string

Comma-separated list of fields to include (e.g., total,amount_due,item_count). id is always included.

Response

orders listed

data
object[]
required
meta
object
required