Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

brEnvType?: string

Optional parameter specifying the Bloomreach environment type (e.g. STAGING) If the target is production, please do not specify this field.

brUid2?: string

The visitor's ID for brSM API calls.

connector?: string

If you want to use a different connector for the search (e.g. brsm), pass in the connector ID.

customAttrFields?: string[]

Extra custom attribute field names.

customQueryOptionsProcessor?: CustomQueryOptionsProcessor<Items, ItemsVariables>

Optional Custom Query and Options Processor to update the original query document and variables if necessary

customVariantAttrFields?: string[]

Extra custom variant attribute field names.

customVariantListPriceField?: string

Optional extra custom variant attribute field name representing the product variant's list price data.

customVariantPurchasePriceField?: string

Optional extra custom variant attribute field name representing the product variant's purchase price data.

facetFieldFilters?: FacetFieldFilterInput[]

Facet field filter(s).

offset?: number
pageSize?: number

The maximum item count in the search result.

params?: ParamInput[]

Optional extra parameters that can be used by the backend.

searchText?: string

Initial keyword to search products by.

smAccountId?: string

The 'account_id' parameter value to be passed to the brSM API calls if provided.

smAuthKey?: string

The 'auth_key' parameter value to be passed to the brSM API calls if provided.

smDomainKey?: string

The 'domain_key' parameter value to be passed to the brSM API calls if provided.

smViewId?: string

'view_id' parameter value to override in brSM API calls.

sortFields?: string

Sorting fields separated by comma. Prefix by '-' for descending order. e.g. '-purchasePrice'.

storeKey?: string

Optional store key information which may provide the context the customers shop in

Generated using TypeDoc