Home > @poq/sdk-sfcc > ProductSearchResult
Document representing a product search result.
Signature:
export declare class ProductSearchResult extends BaseModel<ProductSearchResult>
Extends: BaseModel<ProductSearchResult
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(params) | Constructs a new instance of the ProductSearchResult class |
| Property | Modifiers | Type | Description |
|---|---|---|---|
| count? | number | (Optional) The number of returned documents. | |
| data? | Array<object> | (Optional) | |
| fetchDate? | number | (Optional) | |
| hits? | Array<ProductSearchHit> | (Optional) The sorted array of search hits. This array can be empty. | |
| next? | string | (Optional) The URL of the next result page. | |
| previous? | string | (Optional) The URL of the previous result page. | |
| query? | string | (Optional) The query String that was searched for. | |
| refinements? | Array<ProductSearchRefinement> | (Optional) The sorted array of search refinements. This array can be empty. | |
| searchPhraseSuggestions? | Suggestion | (Optional) | |
| selectedRefinements? | { [key: string]: string; } | (Optional) A map of selected refinement attribute id/value(s) pairs. The sorting order is the same as in request URL. | |
| selectedSortingOption? | string | (Optional) The id of the applied sorting option. | |
| sortingOptions? | Array<ProductSearchSortingOption> | (Optional) The sorted array of search sorting options. This array can be empty. | |
| start? | number | (Optional) The zero-based index of the first search hit to include in the result. | |
| total? | number | (Optional) The total number of documents. |