Skip to main content
GET
Spree SDK

Authorizations

x-spree-api-key
string
header
required

Publishable API key for store access

Headers

x-spree-api-key
string
required

Publishable API key

Query Parameters

category_id
string

Scope filters to products in this category (prefix ID)

q[name_cont]
string

Filter by name containing string

Response

filters scoped to category

filters
object[]
required

Available filters (price_range, availability, option, category)

sort_options
object[]
required

Available sort options

default_sort
string
required

Default sort option ID

total_count
integer
required

Total products matching current filters