Home > @poq/sdk-sfcc > ProductSearchRefinementValue
Document representing a product search refinement value.
Signature:
export declare class ProductSearchRefinementValue extends BaseModel<ProductSearchRefinementValue>
Extends: BaseModel<ProductSearchRefinementValue
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(params) | Constructs a new instance of the ProductSearchRefinementValue class |
| Property | Modifiers | Type | Description |
|---|---|---|---|
| description? | string | (Optional) The localized description of the refinement value. | |
| hitCount? | number | (Optional) The number of search hits when selecting the refinement value. Can be 0. | |
| label? | string | (Optional) The localized label of the refinement value. | |
| presentationId? | string | (Optional) The optional presentation id associated with the refinement value. The presentation id can be used, for example, to associate an id with an HTML widget. | |
| value? | string | (Optional) The refinement value. In the case of an attribute refinement, this is the bucket, the attribute value, or a value range. In the case of a category refinement, this is the category id. In the case of a price refinement,k this is the price range. Ranges are enclosed by parentheses and separated by “..”; for example, “(100..999)” and “(Aa..Fa)” are valid ranges. | |
| values? | Array<ProductSearchRefinementValue> | (Optional) The array of hierarchical refinement values. This array can be empty. |