ProductSearchRefinementValue document (Shop API 20.4)

Document representing a product search refinement value.

Property Type Constraints Description
description Localized<String>   The localized description of the refinement value.
hit_count Integer   The number of search hits when selecting the refinement value. Can be 0.
label Localized<String>   The localized label of the refinement value.
presentation_id String   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   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 [ProductSearchRefinementValue]   The array of hierarchical refinement values. This array can be empty.
OCAPI obsolete versions 13.x and 14.x will be end of life in 2020 and versions 15.x and 16.x in 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.
X Privacy Update: We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used. By continuing to use this site you are giving us your consent to do this. Privacy Policy.