Home > @poq/sdk-sfcc > ProductSearchRequest
Search params for product search.
Signature:
export declare class ProductSearchRequest
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(query, start, count, expand, refinements, sort, currency, locale, originalSearchParams) | Constructs a new instance of the ProductSearchRequest class |
| Property | Modifiers | Type | Description |
|---|---|---|---|
| count | number | The maximum number of instances per request. | |
| currency? | string | (Optional) The id of the sorting option to sort the search hits. | |
| DEFAULT_COUNT | static |
(not declared) | Default count const |
| expand? | ProductSearchExpandOption[] | (Optional) The expand parameter. A list with the allowed values | |
| locale? | string | (Optional) The currency mnemonic specified for price. This parameter is effective only if specified expand parameter value contains prices. | |
| originalSearchParams | Record<string, string> | undefined | Keep information about original search params if they exist | |
| query? | string | (Optional) The query phrase to search for. | |
| refinements? | ProductSearchRequestRefinements | (Optional) Parameter that represents a refinement attribute/value(s) pair. Refinement attribute id and value(s) are separated by ‘=’. Multiple values are supported by a sub-set of refinement attributes and can be provided by separating them using a pipe (URL encoded = “|”). Value ranges can be specified like this: refine=price=(100..500) Multiple refine parameters can be provided by adding an underscore in combination with an integer counter right behind the parameter name and a counter range 1..9. I.e. refine_1=c_refinementColor=red|green|blue. | |
| sort? | string | (Optional) The id of the sorting option to sort the search hits. | |
| start | number | The result set index to return the first instance for. |