Interface InputSearchProducts

List of custom boosts

Provide category id if search engine is used to get results for category pages. provide either categoryId or categoryPath, don't use both

Provide category path if search engine is used to get results for category pages. provide either categoryId or categoryPath, don't use both

Returns only one result for each unique value for provided field. Can be used to group product variations (e.g. different colors)

Enables to add or modify facet configuration on query time. If facet with the same ID is present in the dashboard configuration, their parameters will be merged. In that case, only partial facet parameters can be provided. If facet is not present in the configuration, all required params must be present.

Matches all objects if query is not provided or empty. Defaults to true if no name provided, false for serp and autocomplete

(Private key only) Overwrite default exclusions behavior

List of facet ID's, the ones configured in the dashboard, to be counted. The search engine will automatically filter out irrelevant facets depending on search queries, so not all facets listed here may be returned. * selects all facets

List of filters. Values are joined with AND operator

Offset of returned product list. Used for pagination, use together with size parameter

(Private key only) Overwrite default out of stock behavior

Used to provide brand, category, and other affinities from Nosto personalization frontend script. These will be different for each user

Personalization impact in comparison to relevance and other boosts

Used to change positions of returned products. Pinning rearranges returned product positions, which means that if product is not returned with search results, it won't be pinned

Same format as filter, but is always applied before counting facets. excludeFacets param is not allowed

Queries data only from searchable fields with specified priorities. Use [ high, medium, low ] for serp. Use [ high, medium ] for autocomplete

How much weight has relevance in comparison to other scores (e.g. boost)

(Private key only) Allow private fields to be returned in search results and used in query parameters

How many products will be returned

Sets how results should be sorted. After sorting by all the options provided in sort param, or in case sort param is not set, results will be sorted by relevance. For example, if you set sort by availability status, products with the same availability status will be sorted by relevance.

Selects product variation or currency