Search (storefront API)
Storefront and customer routes of the search module. Send Accept-Language (or X-Locale from a browser) on every call; a customer route needs the session cookie.
GET /v1/search
Section titled “GET /v1/search”Search products
Parameters:
brandin query (string, max length 100, optional).categoryIdin query (string, optional).inStockin query (boolean, optional).pagein query (number, min 1, optional).pageSizein query (number, min 1, max 100, optional).priceMaxin query (number, min 0, optional).priceMinin query (number, min 0, optional).qin query (string, max length 200, optional).ratingin query (number, min 1, max 5, optional).
Responses:
200: Search results.
POST /v1/search/events/{id}/click
Section titled “POST /v1/search/events/{id}/click”Log product click
Parameters:
idin path (string, required).
Request body: LogClickDto.
Responses:
204: Click logged.
POST /v1/search/events/{id}/convert
Section titled “POST /v1/search/events/{id}/convert”Log product conversion
Parameters:
idin path (string, required).
Responses:
204: Conversion logged.
GET /v1/search/filters
Section titled “GET /v1/search/filters”Get search filters
Parameters:
qin query (string, required).
Responses:
200: Filters retrieved.
GET /v1/search/suggest
Section titled “GET /v1/search/suggest”Get search suggestions
Parameters:
qin query (string, min length 1, max length 100, required).
Responses:
200: Suggestions retrieved.
Schemas
Section titled “Schemas”LogClickDto
Section titled “LogClickDto”clickedProductId(string, required).clickPosition(number, min 0, required).