Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SearchProducts

Performs a search for products, given a Query string.

Hierarchy

  • SearchProducts

Index

Properties

Properties

Optional AggregationOptions

AggregationOptions: undefined | {}

Optional AggregationState

AggregationState: undefined | string

Optional Explain

Explain: undefined | false | true

If Explain is set to true the response will contain an explanation of how the search was performed. This is ignored if you do not have the ProductSearchExplanations functionality.

Optional Filters

Filters: undefined | {}

Optional IncludedFields

IncludedFields: string[]

Entity type: ProductPropertyType

Optional Options

Options: SearchProductsOptions

Optional Page

Page: undefined | number

Optional PageSize

PageSize: undefined | number

Optional ProductSearchTemplateID

ProductSearchTemplateID: undefined | number

Entity type: ProductSearchTemplate

Optional Query

Query: undefined | string

Optional SearchStrategyCode

SearchStrategyCode: undefined | string

Optional Sort

Sort: SortFieldDescriptor[]

Optional UserTypeOverride

UserTypeOverride: UserTypes