Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

Optional brUid2

brUid2: undefined | string

The visitor's ID for brSM API calls.

Optional categoryId

categoryId: undefined | string

Category ID to search by.

Optional customAttrFields

customAttrFields: undefined | string[]

Extra custom attribute field names.

Optional customVariantAttrFields

customVariantAttrFields: undefined | string[]

Extra custom variant attribute field names.

Optional customVariantListPriceField

customVariantListPriceField: undefined | string

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

Optional customVariantPurchasePriceField

customVariantPurchasePriceField: undefined | string

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

Optional facetFieldFilters

facetFieldFilters: undefined | FacetFieldFilterInput[]

Facet field filter(s).

Optional offset

offset: undefined | number

Optional pageSize

pageSize: undefined | number

The maximum item count in the search result.

Optional params

params: undefined | ParamInput[]

Optional extra parameters that can be used by the backend.

Optional productIds

productIds: undefined | string[]

Product ID array to search by.

Optional searchText

searchText: undefined | string

Initial keyword to search products by.

Optional smAccountId

smAccountId: undefined | string

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

Optional smAuthKey

smAuthKey: undefined | string

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

Optional smCatalogViews

smCatalogViews: undefined | string

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

Optional smDomainKey

smDomainKey: undefined | string

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

Optional smViewId

smViewId: undefined | string

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

Optional sortFields

sortFields: undefined | string

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

Optional storeKey

storeKey: undefined | string

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

widgetId

widgetId: string

The identifier of the widget.

widgetType

widgetType: string

The widget type. i.e. one of ['item', 'category', 'keyword', 'personalized', 'global'].

Generated using TypeDoc