List collection products

const options = {method: 'GET', headers: {'x-spree-api-key': '<api-key>'}};

fetch('http://{defaultHost}/api/v3/store/collections/{collection_id}/products', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": [
    {
      "id": "prod_UkLWZg9DAJ",
      "name": "Product 3476979",
      "slug": "product-3476979",
      "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": "Accusantium ex dicta error nemo ipsa vel eaque porro. Laborum ipsam molestias iure aspernatur quos dolorem. Quia libero odio nesciunt debitis eaque.",
      "description_html": "Accusantium ex dicta error nemo ipsa vel eaque porro. Laborum ipsam molestias iure aspernatur quos dolorem. Quia libero odio nesciunt debitis eaque.",
      "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,
        "amount_in_cents": 1999,
        "compare_at_amount_in_cents": null,
        "display_amount": "$19.99",
        "display_compare_at_amount": null,
        "price_list_id": null
      },
      "original_price": null,
      "seller_id": null
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 1,
    "pages": 1,
    "from": 1,
    "to": 1,
    "in": 1,
    "previous": null,
    "next": null
  }
}

GET

api

store

collections

{collection_id}

products

List collection products

const options = {method: 'GET', headers: {'x-spree-api-key': '<api-key>'}};

fetch('http://{defaultHost}/api/v3/store/collections/{collection_id}/products', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": [
    {
      "id": "prod_UkLWZg9DAJ",
      "name": "Product 3476979",
      "slug": "product-3476979",
      "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": "Accusantium ex dicta error nemo ipsa vel eaque porro. Laborum ipsam molestias iure aspernatur quos dolorem. Quia libero odio nesciunt debitis eaque.",
      "description_html": "Accusantium ex dicta error nemo ipsa vel eaque porro. Laborum ipsam molestias iure aspernatur quos dolorem. Quia libero odio nesciunt debitis eaque.",
      "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,
        "amount_in_cents": 1999,
        "compare_at_amount_in_cents": null,
        "display_amount": "$19.99",
        "display_compare_at_amount": null,
        "price_list_id": null
      },
      "original_price": null,
      "seller_id": null
    }
  ],
  "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`

Filters through associations

Prefix an associated record’s attribute with the association, as in q[categories_id_eq]. The same predicates apply.

Prefix	Attributes
`categories_`	`automatic`, `children_count`, `created_at`, `depth`, `id`, `name`, `parent_id`, `permalink`, `position`, `pretty_name`, `products_count`, `updated_at`
`collections_`	`automatic`, `created_at`, `id`, `name`, `permalink`, `position`, `products_count`, `sort_order`, `updated_at`
`tags_`	`created_at`, `id`, `name`, `updated_at`

Also filters and sorts on the store’s searchable custom fields, as q[cf_<namespace>_<key>_<predicate>] and sort=cf_<namespace>_<key>. Sort by: available_on, best_selling, created_at, description, discontinue_on, id, manual, name, price, seller_id, slug, status, updated_at. Prefix a field with - to sort descending.

Authorizations

x-spree-api-key

string

header

required

Publishable API key for store access

Headers

x-spree-api-key

string

required

Path Parameters

collection_id

string

required

Collection permalink or prefix ID

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.

sort

string

Sort order (e.g., price, -price). Defaults to the collection's sort_order.

page

integer

limit

integer

object

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

Response

200 - application/json

products found

data

object[]

Show child attributes

API basics

Endpoints

List collection products

Filters

Authorizations

Headers

Path Parameters

Query Parameters

Response

​Filters

Authorizations

Headers

Path Parameters

Query Parameters

Response

Filters