Home > @poq/sdk-sfcc > ProductSearchRefinement
Document representing a product search refinement attribute.
Signature:
export declare class ProductSearchRefinement extends BaseModel<ProductSearchRefinement>
Extends: BaseModel<ProductSearchRefinement
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(params) | Constructs a new instance of the ProductSearchRefinement class |
| Property | Modifiers | Type | Description |
|---|---|---|---|
| attributeId | string | The id of the search refinement attribute. In the case of an attribute refinement, this is the attribute id. Custom attributes are marked by the prefix “c_” (for example, “c_refinementColor”). In the case of a category refinement, the id must be “cgid”. In the case of a price refinement, the id must be “price”. | |
| label? | string | (Optional) The localized label of the refinement. | |
| values? | Array<ProductSearchRefinementValue> | (Optional) The sorted array of refinement values. This array can be empty. |