Search Product
Search for products using keywords and filters.
Endpoint
GET /api/shop/products/searchRequest Headers
| Header | Required | Description |
|---|---|---|
Content-Type | Yes | application/json |
X-STOREFRONT-KEY | Yes | Your storefront API key |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
q | string | Yes | Search query (min 2 characters) |
limit | integer | No | Maximum results (default: 20, max: 100) |
page | integer | No | Page number (default: 1) |
category | integer | No | Filter by category ID |
minPrice | decimal | No | Minimum price filter |
maxPrice | decimal | No | Maximum price filter |
sort | string | No | Sort by (relevance, price, rating, newest) |
direction | string | No | Sort direction (asc, desc) |
Response Fields (200 OK)
| Field | Type | Description |
|---|---|---|
id | integer | Product ID |
name | string | Product name |
slug | string | URL-friendly product identifier |
sku | string | Stock keeping unit |
price | decimal | Product price |
specialPrice | decimal | Sale price (if applicable) |
imageUrl | string | Product image URL |
rating | decimal | Average rating |
reviews | integer | Number of reviews |
inStock | boolean | Stock availability |
Metadata Response
| Field | Type | Description |
|---|---|---|
total | integer | Total matching results |
query | string | Search query used |
highlightedResults | integer | Number of highlighted/featured results |
Search Features
- Full-text product name and description search
- Category filtering
- Price range filtering
- Rating-based sorting
- Relevance ranking
- Autocomplete suggestions support
Use Cases
- Implement product search functionality
- Build search result pages
- Create product finding features
- Support search suggestions/autocomplete
- Filter search results by attributes