ProductSearchRefinement document (Shop API 23.2)
Document representing a product search refinement attribute.
| Property | Type | Constraints | Description |
|---|---|---|---|
attribute_id |
String | mandatory=true, nullable=false | 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 |
Localized<String> | The localized label of the refinement. | |
values |
[ProductSearchRefinementValue] | The sorted array of refinement values. This array can be empty. |
X
OCAPI versions 15.x and 16.x will be retired on March 31, 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.
