Storefront APICatalog
Search products
The product listing with the search text in q, ordered by relevance
(full-text rank plus title similarity, so typos still match).
Path Parameters
store_slug*string
Store slug
Query Parameters
q?string
Search text. Without it, every product is listed.
limit?integer
Page size, 1 to 100 (out-of-range values are clamped). Defaults to 24.
Format
int64offset?integer
Products to skip. Defaults to 0.
Format
int64category_slug?string
Only products in this category.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/storefront-api/string/api/products/search"{
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"image_alt": "string",
"image_sizes": [
"string"
],
"image_url": "string",
"price": "string",
"sale_price": "string",
"short_description": "string",
"slug": "string",
"title": "string"
}
],
"limit": 0,
"offset": 0,
"total": 0
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}