Skip to main content
GET
Spree SDK

Filters

Filter with q[<attribute>_<predicate>]=value, for example q[amount_eq]=…. Send a list as q[<attribute>_in][]=a&q[<attribute>_in][]=b. How filters work. Sort by: amount, created_at, currency, customer_id, id, 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
required

Query Parameters

q[from_gift_card]
boolean

Set to true to apply from_gift_card.

q[outstanding]
boolean

Set to true to apply outstanding.

page
integer
limit
integer
fields
string

Comma-separated list of fields to include (e.g., amount,currency). id is always included.

q
object

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

Response

store credits found

data
object[]
meta
object