Skip to content

List a collection's products

GET
/public/stores/{storeRef}/collections/slug/{slug}/products
curl --request GET \
--url 'https://apibase.ecomweb.app/api/v1/public/stores/example/collections/slug/example/products?page=1&page_size=10' \
--header 'x-storefront-api-key: <x-storefront-api-key>'

Returns a page of the products in an active collection, found by its slug. A manual collection lists its products in the merchant’s order; a smart collection selects them with its rules. Page with page and page_size (at most 100). A collection that is not active, or does not exist, answers 404.

slug
required
string

The collection’s URL slug.

storeRef
required
string

The store’s ref, as returned by GET /stores.

page
number
default: 1 >= 1

1-based page

page_size
number
default: 10 >= 1 <= 100
Media typeapplication/json
object
facet_counts
required

For each faceted field, how many matches carry each value. Empty when the response is read from the database.

Array<object>
object
key
additional properties
any
data

The matches on this page. Present on results from the search index.

Array<object>
object
document
required

The indexed record. For products it holds fields such as id, name, slug, description, main_image_url, min_price, max_price, has_promotion, variant_mode and rating_average; for blog posts, id, title, slug, excerpt and published_at.

object
key
additional properties
any
highlight

Highlighted fragments of the matched fields, keyed by field name. Absent on results read from the database.

object
key
additional properties
any
highlights

The same fragments as a list, one entry per matched field. Absent on results read from the database.

Array<object>
object
key
additional properties
any
hits

The matches on this page. Present instead of data when the response is read directly from the database, which happens for a manual collection that keeps its hand-picked order.

Array<object>
object
document
required

The indexed record. For products it holds fields such as id, name, slug, description, main_image_url, min_price, max_price, has_promotion, variant_mode and rating_average; for blog posts, id, title, slug, excerpt and published_at.

object
key
additional properties
any
highlight

Highlighted fragments of the matched fields, keyed by field name. Absent on results read from the database.

object
key
additional properties
any
highlights

The same fragments as a list, one entry per matched field. Absent on results read from the database.

Array<object>
object
key
additional properties
any
request_params

The request parameters as the search ran them. Absent on results read from the database.

object
per_page
required

Number of matches per page.

number
q
required

The search query.

string
found
required

Total number of records that match, across all pages.

number
page
required

The page these results belong to, starting at 1.

number

Example generated

{
"facet_counts": [
{}
],
"data": [
{
"document": {},
"highlight": {},
"highlights": [
{}
]
}
],
"hits": [
{
"document": {},
"highlight": {},
"highlights": [
{}
]
}
],
"request_params": {
"per_page": 1,
"q": "example"
},
"found": 1,
"page": 1
}

The request is malformed or failed validation.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The resource does not exist in this store.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}