ContentSearchRefinementValue document (Shop API 23.2)
Document representing a 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 (0 or more) when selecting the refinement value. | |
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 content folder refinement, this is the folder id. | |
values |
[ContentSearchRefinementValue] | The array of hierarchical 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.