ProductSearchHit Document (Shop API 17.2)
(supports custom properties)
Document representing a product search hit.
| Property | Type | Constraints | Description |
|---|---|---|---|
currency
|
String | The ISO 4217 mnemonic code of the currency. | |
image
|
Image | The first image of the product hit for the configured viewtype. | |
link
|
String | The URL addressing the product. | |
orderable
|
Boolean | A flag indicating whether the product is orderable. | |
price
|
Decimal | The sales price of the product. In case of complex products like master or set this is the minimum price of related child products. | |
price_max
|
Decimal | The maximum sales of related child products in case of complex products like master or set. | |
prices
|
Map[String, Decimal] | The prices map with price book ids and their values. | |
product_id
|
String | The id (SKU) of the product. | |
product_name
|
Localized<String> | The localized name of the product. | |
product_type
|
ProductType | The type information for the product. | |
variation_attributes
|
[VariationAttribute] | The array of represented variation attributes (for the master product only). 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.
