new module:models/ProductSearchHit()
Constructs a new ProductSearchHit.
Document representing a product search hit.
- Source:
Members
(inner) currency :String
The ISO 4217 mnemonic code of the currency.
Type:
- String
- Source:
(inner) hit_type :String
The type information for the search hit.
Type:
- String
- Source:
(inner) image :module:models/Image
The first image of the product hit for the configured viewtype.
Type:
- Source:
(inner) link :String
The URL addressing the product.
Type:
- String
- Source:
(inner) orderable :Boolean
A flag indicating whether the product is orderable.
Type:
- Boolean
- Source:
(inner) price :Number
The sales price of the product. In case of complex products like master or set this is the minimum price of related child products.
Type:
- Number
- Source:
(inner) price_max :Number
The maximum sales of related child products in case of complex products like master or set.
Type:
- Number
- Source:
(inner) prices :Object.<String, Number>
The prices map with price book ids and their values.
Type:
- Object.<String, Number>
- Source:
(inner) product_id :String
The id (SKU) of the product.
Type:
- String
- Source:
(inner) product_name :String
The localized name of the product.
Type:
- String
- Source:
(inner) product_type :module:models/ProductType
The type information for the product.
Type:
- Source:
(inner) represented_product :module:models/ProductRef
The first represented product.
Type:
- Source:
(inner) represented_products :Array.<module:models/ProductRef>
All the represented products.
Type:
- Array.<module:models/ProductRef>
- Source:
(inner) variation_attributes :Array.<module:models/VariationAttribute>
The array of represented variation attributes (for the master product only). This array can be empty.
Type:
- Array.<module:models/VariationAttribute>
- Source:
Methods
(static) constructFromObject(data, obj) → {module:models/ProductSearchHit}
Constructs a ProductSearchHit from a plain JavaScript object, optionally creating a new instance.
Copies all relevant properties from data to obj if supplied or a new instance if not.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Object | The plain JavaScript object bearing properties of interest. |
obj |
module:models/ProductSearchHit | Optional instance to populate. |
- Source:
Returns:
The populated ProductSearchHit instance.