Skip to main content
GET
Spree Seller SDK

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: channel_id, completed_at, created_at, currency, customer_id, delivery_total, fulfillment_status, id, item_total, locale, market_id, number, order_group_id, payment_status, po_number, seller_id, status, total, total_quantity, updated_at. Prefix a field with - to sort descending.

Authorizations

Authorization
string
header
required

JWT token for an authenticated seller session (seller_api audience)

Headers

X-Spree-Seller-Id
string
required

Query Parameters

q[complete]
boolean

Set to true to apply complete.

q[incomplete]
boolean

Set to true to apply incomplete.

q[partially_refunded]
boolean

Set to true to apply partially_refunded.

q[refunded]
boolean

Set to true to apply refunded.

page
integer

Page number

limit
integer

Records per page (max 100)

sort
string

Sort field; prefix with - for descending

q
object

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

Response

200 - application/json

orders listed

data
object[]
required
meta
object
required