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));curl --request GET \
--url http://{defaultHost}/api/v3/store/collections/{collection_id}/products \
--header 'x-spree-api-key: <api-key>'{
"data": [
{
"id": "prod_UkLWZg9DAJ",
"name": "Product 2516979",
"slug": "product-2516979",
"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",
"amount": "19.99",
"amount_in_cents": 1999,
"compare_at_amount": null,
"compare_at_amount_in_cents": null,
"currency": "USD",
"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
}
}List collection products
Products in the collection. Defaults to the collection’s own sort order and accepts the same filters, sort, and pagination as the products endpoint.
GET
/
api
/
v3
/
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));curl --request GET \
--url http://{defaultHost}/api/v3/store/collections/{collection_id}/products \
--header 'x-spree-api-key: <api-key>'{
"data": [
{
"id": "prod_UkLWZg9DAJ",
"name": "Product 2516979",
"slug": "product-2516979",
"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",
"amount": "19.99",
"amount_in_cents": 1999,
"compare_at_amount": null,
"compare_at_amount_in_cents": null,
"currency": "USD",
"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
}
}Authorizations
Publishable API key for store access
Headers
Path Parameters
Collection permalink or prefix ID
Query Parameters
Sort order (e.g., price, -price). Defaults to the collection's sort_order.
Was this page helpful?
⌘I

