List products

Spree Seller SDK

import { createSellerClient } from '@spree/seller-sdk'

const client = createSellerClient({
  baseUrl: 'https://your-store.com',
  jwtToken: 'eyJhbGciOi...',
  sellerId: 'sel_UkLWZg9DAJ',
})

const { data: products, meta } = await client.products.list({
  status_eq: 'draft',
  sort: '-created_at',
  limit: 25,
})

{
  "data": [
    {
      "id": "prod_UkLWZg9DAJ",
      "name": "Product 2843250",
      "slug": "product-2843250",
      "meta_title": null,
      "meta_description": null,
      "meta_keywords": null,
      "variant_count": 1,
      "available_on": null,
      "preorder_ships_at": null,
      "purchasable": true,
      "preorder": false,
      "in_stock": false,
      "backorderable": true,
      "available": true,
      "description": "Maiores ut qui dolores ab autem. Architecto quos sequi minus debitis tempora molestiae. Quasi officiis minus voluptatum eveniet incidunt. Nisi laboriosam a aliquam eveniet occaecati ducimus. Provident quo amet nostrum sed assumenda cum odio. Distinctio perferendis quasi nisi exercitationem veritatis minima esse. In velit at corporis nobis. Voluptate mollitia nam pariatur enim. Recusandae necessitatibus earum deserunt sapiente eveniet quidem unde. Consectetur ab perspiciatis veniam dolor tempora. Omnis odit autem quae repellat. Delectus corrupti ea nisi reiciendis atque iure a molestias. Repellendus laboriosam sint molestias debitis in. Minima omnis accusantium modi accusamus doloribus fugit. Accusamus autem sequi perferendis saepe quos perspiciatis.",
      "description_html": "Maiores ut qui dolores ab autem. Architecto quos sequi minus debitis tempora molestiae. Quasi officiis minus voluptatum eveniet incidunt. Nisi laboriosam a aliquam eveniet occaecati ducimus. Provident quo amet nostrum sed assumenda cum odio.\nDistinctio perferendis quasi nisi exercitationem veritatis minima esse. In velit at corporis nobis. Voluptate mollitia nam pariatur enim. Recusandae necessitatibus earum deserunt sapiente eveniet quidem unde.\nConsectetur ab perspiciatis veniam dolor tempora. Omnis odit autem quae repellat. Delectus corrupti ea nisi reiciendis atque iure a molestias.\nRepellendus laboriosam sint molestias debitis in. Minima omnis accusantium modi accusamus doloribus fugit. Accusamus autem sequi perferendis saepe quos perspiciatis.",
      "default_variant_id": "variant_UkLWZg9DAJ",
      "buy_box_variant_id": "variant_UkLWZg9DAJ",
      "thumbnail_url": null,
      "tags": [],
      "price": {
        "id": "price_UkLWZg9DAJ",
        "currency": "USD",
        "amount": "19.99",
        "compare_at_amount": null,
        "price_list_id": null
      },
      "original_price": null,
      "seller_id": "sel_UkLWZg9DAJ",
      "status": "active",
      "metadata": {},
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "product_type_id": null,
      "delivery_profile_id": "fp_UkLWZg9DAJ"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 1,
    "pages": 1,
    "from": 1,
    "to": 1,
    "in": 1,
    "previous": null,
    "next": null
  }
}

GET

api

seller

products

Spree Seller SDK

import { createSellerClient } from '@spree/seller-sdk'

const client = createSellerClient({
  baseUrl: 'https://your-store.com',
  jwtToken: 'eyJhbGciOi...',
  sellerId: 'sel_UkLWZg9DAJ',
})

const { data: products, meta } = await client.products.list({
  status_eq: 'draft',
  sort: '-created_at',
  limit: 25,
})

{
  "data": [
    {
      "id": "prod_UkLWZg9DAJ",
      "name": "Product 2843250",
      "slug": "product-2843250",
      "meta_title": null,
      "meta_description": null,
      "meta_keywords": null,
      "variant_count": 1,
      "available_on": null,
      "preorder_ships_at": null,
      "purchasable": true,
      "preorder": false,
      "in_stock": false,
      "backorderable": true,
      "available": true,
      "description": "Maiores ut qui dolores ab autem. Architecto quos sequi minus debitis tempora molestiae. Quasi officiis minus voluptatum eveniet incidunt. Nisi laboriosam a aliquam eveniet occaecati ducimus. Provident quo amet nostrum sed assumenda cum odio. Distinctio perferendis quasi nisi exercitationem veritatis minima esse. In velit at corporis nobis. Voluptate mollitia nam pariatur enim. Recusandae necessitatibus earum deserunt sapiente eveniet quidem unde. Consectetur ab perspiciatis veniam dolor tempora. Omnis odit autem quae repellat. Delectus corrupti ea nisi reiciendis atque iure a molestias. Repellendus laboriosam sint molestias debitis in. Minima omnis accusantium modi accusamus doloribus fugit. Accusamus autem sequi perferendis saepe quos perspiciatis.",
      "description_html": "Maiores ut qui dolores ab autem. Architecto quos sequi minus debitis tempora molestiae. Quasi officiis minus voluptatum eveniet incidunt. Nisi laboriosam a aliquam eveniet occaecati ducimus. Provident quo amet nostrum sed assumenda cum odio.\nDistinctio perferendis quasi nisi exercitationem veritatis minima esse. In velit at corporis nobis. Voluptate mollitia nam pariatur enim. Recusandae necessitatibus earum deserunt sapiente eveniet quidem unde.\nConsectetur ab perspiciatis veniam dolor tempora. Omnis odit autem quae repellat. Delectus corrupti ea nisi reiciendis atque iure a molestias.\nRepellendus laboriosam sint molestias debitis in. Minima omnis accusantium modi accusamus doloribus fugit. Accusamus autem sequi perferendis saepe quos perspiciatis.",
      "default_variant_id": "variant_UkLWZg9DAJ",
      "buy_box_variant_id": "variant_UkLWZg9DAJ",
      "thumbnail_url": null,
      "tags": [],
      "price": {
        "id": "price_UkLWZg9DAJ",
        "currency": "USD",
        "amount": "19.99",
        "compare_at_amount": null,
        "price_list_id": null
      },
      "original_price": null,
      "seller_id": "sel_UkLWZg9DAJ",
      "status": "active",
      "metadata": {},
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "product_type_id": null,
      "delivery_profile_id": "fp_UkLWZg9DAJ"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 1,
    "pages": 1,
    "from": 1,
    "to": 1,
    "in": 1,
    "previous": null,
    "next": null
  }
}

Filters

Filter with q[<attribute>_<predicate>]=value, for example q[name_cont]=…. Send a list as q[<attribute>_in][]=a&q[<attribute>_in][]=b. How filters work.

Attribute	Kind	Predicates
`available_on`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`created_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`description`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`discontinue_on`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`name`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`price`	Amount	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`seller_id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`slug`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`status`	One of `draft`, `active`, `archived`, `proposed`, `rejected`	`eq` `not_eq` `in` `not_in` `null` `not_null`
`updated_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`

Sort by: available_on, created_at, description, discontinue_on, id, name, price, seller_id, slug, status, 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[search]

string

Matches product name or variant SKU (partial, case-insensitive), and the store's searchable custom fields.

q[ascend_by_price]

boolean

Set to true to apply ascend_by_price.

q[descend_by_price]

boolean

Set to true to apply descend_by_price.

q[in_categories][]

string[]

Applies in_categories to the given value.

q[in_category]

string

Applies in_category to the given value.

q[in_collection]

string

Applies in_collection to the given value.

q[in_stock]

boolean

Set to true to apply in_stock.

q[in_taxon]

string

Applies in_taxon to the given value.

q[not_discontinued]

boolean

Set to true to apply not_discontinued.

q[out_of_stock]

boolean

Set to true to apply out_of_stock.

q[price_between][]

number[]

Applies price_between to the given value.

Required array length: 2 elements

q[price_gte]

number

Applies price_gte to the given value.

q[price_lte]

number

Applies price_lte to the given value.

q[search_by_name]

string

Applies search_by_name to the given value.

q[with_option_value_ids][]

string[]

Applies with_option_value_ids to the given value.

page

integer

Page number

limit

integer

Records per page (max 100)

sort

string

Sort field; prefix with - for descending

object

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

Response

200 - application/json

products listed

data

object[]

required

Show child attributes

API basics

Endpoints

Filters

Authorizations

Headers

Query Parameters

Response

​Filters

Authorizations

Headers

Query Parameters

Response

Filters