Skip to main content
GET
List returns

Filters

Filter with q[<attribute>_<predicate>]=value, for example q[number_cont]=…. Send a list as q[<attribute>_in][]=a&q[<attribute>_in][]=b. How filters work. Sort by: created_at, id, number, status, updated_at. Prefix a field with - to sort descending.

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

Bearer token for authenticated customers

x-spree-token
string

Order token for guest access

Path Parameters

order_id
string
required

Order prefixed ID

Query Parameters

Matches any of number (partial, case-insensitive).

q
object

Attribute filters, as q[<attribute>_<predicate>]=value. See Filters above for the list.

Response

200 - application/json

returns listed

data
object[]
required
meta
object
required