Alokai
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

NameRequiredTypeDescription
availableForPickupOptionalbooleanFlag defining if product is available for pickup {boolean} Product
averageRatingOptionalnumberRating number of average value {number} Product
baseOptionsOptionalArray<BaseOption>List of base options related to the product {Array<BaseOption>} Product
baseProductOptionalstringInformation about base product {string} Product
bundleTemplatesOptionalArray<BundleTemplate>Set of bundle templates that are identified as starter components and can initiate a bundle in the cart {Array<BundleTemplate>} Product
categoriesOptionalArray<Category>List of categories product belongs to {Array<Category>} Product
classificationsOptionalArray<Classification>List of classifications related to the product {Array<Classification>} Product
codeOptionalstringCode of the product {string} Product
configurableOptionalbooleanFlag stating if product is configurable {boolean} Product
configuratorTypeOptionalstringConfigurator type related to the product {string} Product
descriptionOptionalstringDescription of the product {string} Product
firstVariantCodeOptionalstring{string} Product
firstVariantImageOptionalstring{string} Product
futureStocksOptionalArray<FutureStock>List of future stocks {Array<FutureStock>} Product
imagesOptionalArray<Image>List of images linked to product {Array<Image>} Product
manufacturerOptionalstringData of product manufacturer {string} Product
multidimensionalOptionalbooleanFlag stating if product is multidimensional {boolean} Product
nameOptionalstringName of the product {string} Product
numberOfReviewsOptionalnumberNumber of reviews associated with the product {number} Product
potentialPromotionsOptionalArray<Promotion>List of potential promotions related to the product {Array<Promotion>} Product
priceOptionalPrice{Price} Product
priceRangeOptionalPriceRange{PriceRange} Product
productReferencesOptionalArray<ProductReference>List of product references {Array<ProductReference>} Product
purchasableOptionalbooleanFlag defining if product is purchasable {boolean} Product
reviewsOptionalArray<Review>List of reviews associated with the product {Array<Review>} Product
stockOptionalStock{Stock} Product
summaryOptionalstringProduct summary {string} Product
tagsOptionalSet<string>Tags associated with the product {Set<string>} Product
timedAccessPromotionOptionalPromotion{Promotion} Product
urlOptionalstringUrl address of the product {string} Product
variantMatrixOptionalArray<VariantMatrixElement>List of variant matrixes associated with the product {Array<VariantMatrixElement>} Product
variantOptionsOptionalArray<VariantOption>List of variant options related to the product {Array<VariantOption>} Product
variantTypeOptionalstringVariant type of the product {string} Product
volumePricesOptionalArray<Price>List of volume prices {Array<Price>} Product
volumePricesFlagOptionalbooleanFlag stating if volume price should be displayed {boolean} Product

Referenced Types

On this page