v1
latestOpenAPI 3.0.0MIT2026-07-147825.1 KBProduct List Page
Get list of the possible facets for a given query
Lists the possible facets for a given query
get/facets/{facets}
Path parameters
facetsstring nullable required
Format
The facets parameter follows the format : /${facetKey1}/${facetValue1}/${facetKey2}/${facetValue2}/.../${facetKeyN}/${facetValueN}.
The order in which the terms appear is not relevant to the search.
You can also repeat the same facetKey several times for different values. For example: category-1/shoes/color/blue/color/red/color/yellow
General filters
The facets parameter also allows the following general filters.
| facetKey | Description | Example |
|---|---|---|
| price | Filter the search by a price range. The facet value follows the format ${minPrice}:${maxPrice} | /color/blue/price/100:500?query=shirt |
| category-${n} | Filter the search by category, where n represents the category tree level (1 = department, 2 = category, 3 = subcategory, and so on) | category-1/clothing/category-2/shirts |
| region-id | Filter the search by a region id (aka regionalization). The value is the region id | /color/blue/region-id/v2.26219C7C3DE42BAAD11CFB92CD0BFE91?query=shirt. |
Query parameters
querystring
Search term. It can contain any character.
localestring nullable
Indicates the target language as a BCP 47 language code. The Intelligent Search must have indexed the account in the target language.
hideUnavailableItemsboolean
Whether the result should hide unavailable items (true), or not (false)
Response
List of facets for the given query.