SearchApiConfig
Parameters specific to the Bloomreach Product Search / Category API.
interface SearchApiConfig extends SubApiConfig {
currencies?: string[];
efq?: string;
facetVersion?: string;
productFields?: string[];
statsField?: string;
}Properties
| Name | Required | Type | Description |
|---|---|---|---|
currencies | Optional | string[] | Currencies for which per-currency price fields are indexed (e.g. ["GBP", "USD", "EUR"]). When set, the search API requests price_<currency> and sale_price_<currency> fields and the normalizer reads the currency-specific field matching the user's active currency. |
efq | Optional | string | Complex boolean filter expression passed as the efq parameter. Allows filtering by complex expressions not expressible via fq. |
facetVersion | Optional | string | Facet version for API requests. |
productFields | Optional | string[] | Additional product document fields to request from the Bloomreach Discovery API. These are appended to the base product fields in the fl (field list) parameter. |
statsField | Optional | string | Numeric field name(s) to return min/max statistics for in the response. Passed as the stats.field API parameter. |