You are reading the documentation for v7.x and earlier, which is no longer the latest version. Switch to v8.x
Product
Representation of a Product Product
export interface Product {
'availableForPickup'?: boolean;
'averageRating'?: number;
'baseOptions'?: Array<BaseOption>;
'baseProduct'?: string;
'bundleTemplates'?: Array<BundleTemplate>;
'categories'?: Array<Category>;
'classifications'?: Array<Classification>;
'code'?: string;
'configurable'?: boolean;
'configuratorType'?: string;
'description'?: string;
'firstVariantCode'?: string;
'firstVariantImage'?: string;
'futureStocks'?: Array<FutureStock>;
'images'?: Array<Image>;
'manufacturer'?: string;
'multidimensional'?: boolean;
'name'?: string;
'numberOfReviews'?: number;
'potentialPromotions'?: Array<Promotion>;
'price'?: Price;
'priceRange'?: PriceRange;
'productReferences'?: Array<ProductReference>;
'purchasable'?: boolean;
'reviews'?: Array<Review>;
'stock'?: Stock;
'summary'?: string;
'tags'?: Set<string>;
'timedAccessPromotion'?: Promotion;
'url'?: string;
'variantMatrix'?: Array<VariantMatrixElement>;
'variantOptions'?: Array<VariantOption>;
'variantType'?: string;
'volumePrices'?: Array<Price>;
'volumePricesFlag'?: boolean;
}Properties
| Name | Required | Type | Description |
|---|---|---|---|
availableForPickup | Optional | boolean | Flag defining if product is available for pickup {boolean} Product |
averageRating | Optional | number | Rating number of average value {number} Product |
baseOptions | Optional | Array<BaseOption> | List of base options related to the product {Array<BaseOption>} Product |
baseProduct | Optional | string | Information about base product {string} Product |
bundleTemplates | Optional | Array<BundleTemplate> | Set of bundle templates that are identified as starter components and can initiate a bundle in the cart {Array<BundleTemplate>} Product |
categories | Optional | Array<Category> | List of categories product belongs to {Array<Category>} Product |
classifications | Optional | Array<Classification> | List of classifications related to the product {Array<Classification>} Product |
code | Optional | string | Code of the product {string} Product |
configurable | Optional | boolean | Flag stating if product is configurable {boolean} Product |
configuratorType | Optional | string | Configurator type related to the product {string} Product |
description | Optional | string | Description of the product {string} Product |
firstVariantCode | Optional | string | {string} Product |
firstVariantImage | Optional | string | {string} Product |
futureStocks | Optional | Array<FutureStock> | List of future stocks {Array<FutureStock>} Product |
images | Optional | Array<Image> | List of images linked to product {Array<Image>} Product |
manufacturer | Optional | string | Data of product manufacturer {string} Product |
multidimensional | Optional | boolean | Flag stating if product is multidimensional {boolean} Product |
name | Optional | string | Name of the product {string} Product |
numberOfReviews | Optional | number | Number of reviews associated with the product {number} Product |
potentialPromotions | Optional | Array<Promotion> | List of potential promotions related to the product {Array<Promotion>} Product |
price | Optional | Price | {Price} Product |
priceRange | Optional | PriceRange | {PriceRange} Product |
productReferences | Optional | Array<ProductReference> | List of product references {Array<ProductReference>} Product |
purchasable | Optional | boolean | Flag defining if product is purchasable {boolean} Product |
reviews | Optional | Array<Review> | List of reviews associated with the product {Array<Review>} Product |
stock | Optional | Stock | {Stock} Product |
summary | Optional | string | Product summary {string} Product |
tags | Optional | Set<string> | Tags associated with the product {Set<string>} Product |
timedAccessPromotion | Optional | Promotion | {Promotion} Product |
url | Optional | string | Url address of the product {string} Product |
variantMatrix | Optional | Array<VariantMatrixElement> | List of variant matrixes associated with the product {Array<VariantMatrixElement>} Product |
variantOptions | Optional | Array<VariantOption> | List of variant options related to the product {Array<VariantOption>} Product |
variantType | Optional | string | Variant type of the product {string} Product |
volumePrices | Optional | Array<Price> | List of volume prices {Array<Price>} Product |
volumePricesFlag | Optional | boolean | Flag stating if volume price should be displayed {boolean} Product |