Search products
const url = 'https://apibase.ecomweb.app/api/v1/public/stores/example/search/catalog?q=T-shirt&collection=products&page=1&page_size=10&sort_by=min_price%3Aasc&min_price=10&max_price=100&variant_mode=single&has_promotion=true&collection_slug=summer-sale&ids=1&ids=2&ids=3';const options = {method: 'GET', headers: {'x-storefront-api-key': '<x-storefront-api-key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://apibase.ecomweb.app/api/v1/public/stores/example/search/catalog?q=T-shirt&collection=products&page=1&page_size=10&sort_by=min_price%3Aasc&min_price=10&max_price=100&variant_mode=single&has_promotion=true&collection_slug=summer-sale&ids=1&ids=2&ids=3' \ --header 'x-storefront-api-key: <x-storefront-api-key>'Searches the store’s products with typo tolerance and meaning-based matching. collection must be products. Only active products published to the online store are searched. Page with page and page_size (at most 100), sort with sort_by (up to three field:asc|desc pairs), and narrow with min_price, max_price, variant_mode, has_promotion, collection_slug or ids. Use q=* to list products without a search term.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The store’s ref, as returned by GET /stores.
Query Parameters
Section titled “Query Parameters”Example
T-shirtThe search query string
Example
productsThe collection to search within
Example
1Page number for pagination (1-based)
Example
10Number of items per page
Example
min_price:ascSort order for results: field:asc|desc, up to 3 comma-separated. Products sort by: _text_match, store_id, name, min_price, max_price, max_discount_percentage, updated_at, created_at, promotion_start_date, promotion_end_date, total_sales, sales_last_30_days, trending_score, view_count, view_count_last_7_days, rating_average, review_count, variant_count, published_at
Example
10Minimum price for filtering
Example
100Maximum price for filtering
Example
singleVariant mode for filtering
Example
trueFilter products with active promotions
Example
summer-saleFilter products by collection slug
Example
[ 1, 2, 3]Array of product IDs to filter by
Responses
Section titled “Responses”object
For each faceted field, how many matches carry each value. Empty when the response is read from the database.
object
The matches on this page. Present on results from the search index.
object
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
Highlighted fragments of the matched fields, keyed by field name. Absent on results read from the database.
object
The same fragments as a list, one entry per matched field. Absent on results read from the database.
object
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.
object
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
Highlighted fragments of the matched fields, keyed by field name. Absent on results read from the database.
object
The same fragments as a list, one entry per matched field. Absent on results read from the database.
object
The request parameters as the search ran them. Absent on results read from the database.
object
Number of matches per page.
The search query.
Total number of records that match, across all pages.
The page these results belong to, starting at 1.
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.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key is missing, invalid, revoked or expired.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
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.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}