Class Product

Represents a product in Commerce Cloud Digital. Products are identified by a unique product ID, sometimes called the SKU. There are several different types of product:

  • Simple product
  • **Master products:**This type of product defines a template for a set of related products which differ only by a set of defined "variation attributes", such as size or color. Master products are not orderable themselves. The variation information for a master product is available through its ProductVariationModel.
  • **Variant:**Variants are the actual orderable products that are related to a master product. Each variant of a master product has a unique set of values for the defined variation attributes. Variants are said to be "mastered" by the corresponding master product.
  • **Option products:**Option products define additional options, such as a warranty, which can be purchased for a defined price at the time the product is purchased. The option information for an option product is available through its ProductOptionModel.
  • **Product-sets:**A product-set is a set of products which the merchant can sell as a collection in the storefront, for example an outfit of clothes. Product-sets are not orderable and therefore do not define prices. They exist only to group the products together in the storefront UI. Members of the set are called "product-set-products".
  • **Products bundles:**A collection of products which can be ordered as a single unit and therefore can define its own price and inventory record.

Product price and availability information are retrievable through getPriceModel() and getAvailabilityModel() respectively. Attribute information is retrievable through getAttributeModel(). Products may reference other products, either as recommendations or product links. This class provides the methods for retrieving these referenced products.

Products belong to a catalog (the "owning" catalog) and are assigned to categories in other catalogs. Products assigned to categories in the site catalog are typically orderable on the site.

Any API method which returns products will return an instance of a Variant for variant products. This subclass contains methods which are specific to this type of product.

Variant, VariationGroup

PropertyDescription
EAN: String (read-only)Returns the European Article Number of the product.
ID: String (read-only)Returns the ID of the product.
UPC: String (read-only)Returns the Universal Product Code of the product.
activeData: ProductActiveData (read-only)Returns the active data for this product, for the current site.
allCategories: Collection (read-only)Returns a collection of all categories to which this product is assigned.
allCategoryAssignments: Collection (read-only)Returns all category assignments for this product in any catalog.
allIncomingProductLinks: Collection (read-only)Returns all incoming ProductLinks.
allProductLinks: Collection (read-only)Returns all outgoing ProductLinks.
assignedToSiteCatalog: Boolean (read-only)Returns true if the product is assigned to the current site (via the site catalog), otherwise false is returned.
attributeModel: ProductAttributeModel (read-only)Returns this product's ProductAttributeModel, which makes access to the product attribute information convenient.
availabilityModel: ProductAvailabilityModel (read-only)Returns the availability model, which can be used to determine availability information for a product.
available: Boolean (read-only)Identifies if the product is available.
availableFlag: BooleanIdentifies if the product is available.
brand: String (read-only)Returns the Brand of the product.
bundle: Boolean (read-only)Identifies if this product instance is a product bundle.
bundled: Boolean (read-only)Identifies if this product instance is bundled within at least one product bundle.
bundledProducts: Collection (read-only)Returns a collection containing all products that participate in the product bundle.
bundles: Collection (read-only)Returns a collection of all bundles in which this product is included.
categories: Collection (read-only)Returns a collection of all categories to which this product is assigned and which are also available through the current site.
categorized: Boolean (read-only)Identifies if this product is bound to at least one catalog category.
categoryAssignments: Collection (read-only)Returns a collection of category assignments for this product in the current site catalog.
classificationCategory: Category (read-only)Returns the classification category associated with this Product.
facebookEnabled: Boolean (read-only)Identifies if the product is Facebook enabled.
image: MediaFile (read-only)Returns the product's image.
incomingProductLinks: Collection (read-only)Returns incoming ProductLinks, where the source product is a site product.
longDescription: MarkupText (read-only)Returns the product's long description in the current locale.
manufacturerName: String (read-only)Returns the name of the product manufacturer.
manufacturerSKU: String (read-only)Returns the value of the manufacturer's stock keeping unit.
master: Boolean (read-only)Identifies if this product instance is a product master.
minOrderQuantity: Quantity (read-only)Returns the minimum order quantity for this product.
name: String (read-only)Returns the name of the product in the current locale.
online: Boolean (read-only)Returns the online status of the product.
onlineCategories: Collection (read-only)Returns a collection of all currently online categories to which this product is assigned and which are also available through the current site.
onlineFlag: Boolean (read-only)Returns the online status flag of the product.
onlineFrom: Date (read-only)Returns the date from which the product is online or valid.
onlineTo: Date (read-only)Returns the date until which the product is online or valid.
optionModel: ProductOptionModel (read-only)Returns the product's option model.
optionProduct: Boolean (read-only)Identifies if the product has options.
orderableRecommendations: Collection (read-only)Returns a list of outgoing recommendations for this product.
pageDescription: String (read-only)Returns product's page description in the default locale.
pageKeywords: String (read-only)Returns the product's page keywords in the default locale.
pageMetaTags: Array (read-only)Returns all page meta tags, defined for this instance for which content can be generated.
pageTitle: String (read-only)Returns the product's page title in the default locale.
pageURL: String (read-only)Returns the product's page URL in the default locale.
pinterestEnabled: Boolean (read-only)Identifies if the product is Pinterest enabled.
priceModel: ProductPriceModel (read-only)Returns the price model, which can be used to retrieve a price for this product.
primaryCategory: Category (read-only)Returns the primary category of the product within the current site catalog.
primaryCategoryAssignment: CategoryAssignment (read-only)Returns the category assignment to the primary category in the current site catalog or null if no primary category is defined within the current site catalog.
product: Boolean (read-only)Returns 'true' if the instance represents a product.
productLinks: Collection (read-only)Returns all outgoing ProductLinks, where the target product is also available in the current site.
productSet: Boolean (read-only)Returns 'true' if the instance represents a product set, otherwise 'false'.
productSetProduct: Boolean (read-only)Returns true if this product is part of any product set, otherwise false.
productSetProducts: Collection (read-only)Returns a collection of all products which are assigned to this product and which are also available through the current site.
productSets: Collection (read-only)Returns a collection of all product sets in which this product is included.
recommendations: Collection (read-only)Returns the outgoing recommendations for this product which belong to the site catalog.
retailSet: Boolean (read-only)Identifies if this product instance is part of a retail set.
searchPlacement: Number (read-only)Returns the product's search placement classification.
searchRank: Number (read-only)Returns the product's search rank.
searchable: Boolean (read-only)Identifies if the product is searchable.
searchableFlag: Boolean (read-only)Returns, whether the product is currently searchable.
searchableIfUnavailableFlag: Boolean (read-only)Returns the searchable status of the Product if unavailable.
shortDescription: MarkupText (read-only)Returns the product's short description in the current locale.
siteMapChangeFrequency: String (read-only)Returns the product's change frequency needed for the sitemap creation.
siteMapIncluded: Number (read-only)Returns the status if the product is included into the sitemap.
siteMapPriority: Number (read-only)Returns the product's priority needed for the sitemap creation.
siteProduct: Boolean (read-only)Returns 'true' if the product is assigned to the current site (via the site catalog), otherwise 'false' is returned.
stepQuantity: Quantity (read-only)Returns the steps in which the order amount of the product can be increased.
storeReceiptName: String (read-only)Returns the store receipt name of the product in the current locale.
storeTaxClass: String (read-only)Returns the store tax class ID.
taxClassID: String (read-only)Returns the ID of the product's tax class, by resolving the Global Preference setting selected.
template: String (read-only)Returns the name of the product's rendering template.
thumbnail: MediaFile (read-only)Returns the product's thumbnail image.
unit: String (read-only)Returns the product's sales unit.
unitQuantity: Quantity (read-only)Returns the product's unit quantity.
variant: Boolean (read-only)Identifies if this product instance is mastered by a product master.
variants: Collection (read-only)Returns a collection of all variants assigned to this variation master or variation group product.
variationGroup: Boolean (read-only)Identifies if this product instance is a variation group product.
variationGroups: Collection (read-only)Returns a collection of all variation groups assigned to this variation master product.
variationModel: ProductVariationModel (read-only)Returns the variation model of this product.

This class does not have a constructor, so you cannot create it directly.

MethodDescription
assignedToCategory(Category)Identifies if this product is bound to the specified catalog category.
getActiveData()Returns the active data for this product, for the current site.
getAllCategories()Returns a collection of all categories to which this product is assigned.
getAllCategoryAssignments()Returns all category assignments for this product in any catalog.
getAllIncomingProductLinks()Returns all incoming ProductLinks.
getAllIncomingProductLinks(Number)Returns all incoming ProductLinks of a specific type.
getAllProductLinks()Returns all outgoing ProductLinks.
getAllProductLinks(Number)Returns all outgoing ProductLinks of a specific type.
getAllRecommendations(Catalog)Returns the outgoing recommendations for this product which belong to the specified catalog.
getAllRecommendations(Catalog, Number)Returns the outgoing recommendations for this product which are of the specified type and which belong to the specified catalog.
getAttributeModel()Returns this product's ProductAttributeModel, which makes access to the product attribute information convenient.
getAvailabilityModel()Returns the availability model, which can be used to determine availability information for a product.
getAvailabilityModel(ProductInventoryList)Returns the availability model of the given inventory list, which can be used to determine availability information for a product.
getAvailableFlag()Identifies if the product is available.
getBrand()Returns the Brand of the product.
getBundledProductQuantity(Product)Returns the quantity of the specified product within the bundle.
getBundledProducts()Returns a collection containing all products that participate in the product bundle.
getBundles()Returns a collection of all bundles in which this product is included.
getCategories()Returns a collection of all categories to which this product is assigned and which are also available through the current site.
getCategoryAssignment(Category)Returns the category assignment for a specific category.
getCategoryAssignments()Returns a collection of category assignments for this product in the current site catalog.
getClassificationCategory()Returns the classification category associated with this Product.
getEAN()Returns the European Article Number of the product.
getID()Returns the ID of the product.
getImage()Returns the product's image.
getImage(String)The method calls getImages(String) and returns the first image.
getImage(String, Number)The method calls getImages(String) and returns the image at the specific index.
getImages(String)Returns all images assigned to this product for a specific view type, e.g.
getIncomingProductLinks()Returns incoming ProductLinks, where the source product is a site product.
getIncomingProductLinks(Number)Returns incoming ProductLinks, where the source product is a site product of a specific type.
getLongDescription()Returns the product's long description in the current locale.
getManufacturerName()Returns the name of the product manufacturer.
getManufacturerSKU()Returns the value of the manufacturer's stock keeping unit.
getMinOrderQuantity()Returns the minimum order quantity for this product.
getName()Returns the name of the product in the current locale.
getOnlineCategories()Returns a collection of all currently online categories to which this product is assigned and which are also available through the current site.
getOnlineFlag()Returns the online status flag of the product.
getOnlineFrom()Returns the date from which the product is online or valid.
getOnlineTo()Returns the date until which the product is online or valid.
getOptionModel()Returns the product's option model.
getOrderableRecommendations()Returns a list of outgoing recommendations for this product.
getOrderableRecommendations(Number)Returns a list of outgoing recommendations for this product.
getPageDescription()Returns product's page description in the default locale.
getPageKeywords()Returns the product's page keywords in the default locale.
getPageMetaTag(String)Returns the page meta tag for the specified id.
getPageMetaTags()Returns all page meta tags, defined for this instance for which content can be generated.
getPageTitle()Returns the product's page title in the default locale.
getPageURL()Returns the product's page URL in the default locale.
getPriceModel()Returns the price model, which can be used to retrieve a price for this product.
getPriceModel(ProductOptionModel)Returns the price model based on the specified optionModel.
getPrimaryCategory()Returns the primary category of the product within the current site catalog.
getPrimaryCategoryAssignment()Returns the category assignment to the primary category in the current site catalog or null if no primary category is defined within the current site catalog.
getProductLinks()Returns all outgoing ProductLinks, where the target product is also available in the current site.
getProductLinks(Number)Returns all outgoing ProductLinks of a specific type, where the target product is also available in the current site.
getProductSetProducts()Returns a collection of all products which are assigned to this product and which are also available through the current site.
getProductSets()Returns a collection of all product sets in which this product is included.
getRecommendations()Returns the outgoing recommendations for this product which belong to the site catalog.
getRecommendations(Number)Returns the outgoing recommendations for this product which are of the specified type and which belong to the site catalog.
getSearchPlacement()Returns the product's search placement classification.
getSearchRank()Returns the product's search rank.
getSearchableFlag()Returns, whether the product is currently searchable.
getSearchableIfUnavailableFlag()Returns the searchable status of the Product if unavailable.
getShortDescription()Returns the product's short description in the current locale.
getSiteMapChangeFrequency()Returns the product's change frequency needed for the sitemap creation.
getSiteMapIncluded()Returns the status if the product is included into the sitemap.
getSiteMapPriority()Returns the product's priority needed for the sitemap creation.
getStepQuantity()Returns the steps in which the order amount of the product can be increased.
getStoreReceiptName()Returns the store receipt name of the product in the current locale.
getStoreTaxClass()Returns the store tax class ID.
getTaxClassID()Returns the ID of the product's tax class, by resolving the Global Preference setting selected.
getTemplate()Returns the name of the product's rendering template.
getThumbnail()Returns the product's thumbnail image.
getUPC()Returns the Universal Product Code of the product.
getUnit()Returns the product's sales unit.
getUnitQuantity()Returns the product's unit quantity.
getVariants()Returns a collection of all variants assigned to this variation master or variation group product.
getVariationGroups()Returns a collection of all variation groups assigned to this variation master product.
getVariationModel()Returns the variation model of this product.
includedInBundle(Product)Identifies if the specified product participates in this product bundle.
isAssignedToCategory(Category)Returns 'true' if item is assigned to the specified category.
isAssignedToSiteCatalog()Returns true if the product is assigned to the current site (via the site catalog), otherwise false is returned.
isAvailable()Identifies if the product is available.
isBundle()Identifies if this product instance is a product bundle.
isBundled()Identifies if this product instance is bundled within at least one product bundle.
isCategorized()Identifies if this product is bound to at least one catalog category.
isFacebookEnabled()Identifies if the product is Facebook enabled.
isMaster()Identifies if this product instance is a product master.
isOnline()Returns the online status of the product.
isOptionProduct()Identifies if the product has options.
isPinterestEnabled()Identifies if the product is Pinterest enabled.
isProduct()Returns 'true' if the instance represents a product.
isProductSet()Returns 'true' if the instance represents a product set, otherwise 'false'.
isProductSetProduct()Returns true if this product is part of any product set, otherwise false.
isRetailSet()Identifies if this product instance is part of a retail set.
isSearchable()Identifies if the product is searchable.
isSiteProduct()Returns 'true' if the product is assigned to the current site (via the site catalog), otherwise 'false' is returned.
isVariant()Identifies if this product instance is mastered by a product master.
isVariationGroup()Identifies if this product instance is a variation group product.
setAvailableFlag(Boolean)Set the availability status flag of the product.
setOnlineFlag(Boolean)Set the online status flag of the product.
setOnlineFlag(Boolean)Set the online status flag of the product for the current site.
setSearchPlacement(Number)Set the product's search placement.
setSearchPlacement(Number)Set the product's search placement classification in context of the current site.
setSearchRank(Number)Set the product's search rank.
setSearchRank(Number)Set the product's search rank in context of the current site.
setSearchableFlag(Boolean)Set the flag indicating whether the product is searchable or not.
setSearchableFlag(Boolean)Set the flag indicating whether the product is searchable or not in context of the current site.

describe, getCustom

getCreationDate, getLastModified, getUUID

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

EAN: String (read-only)

Returns the European Article Number of the product.

ID: String (read-only)

Returns the ID of the product.

UPC: String (read-only)

Returns the Universal Product Code of the product.

activeData: ProductActiveData (read-only)

Returns the active data for this product, for the current site.

allCategories: Collection (read-only)

Returns a collection of all categories to which this product is assigned.

allCategoryAssignments: Collection (read-only)

Returns all category assignments for this product in any catalog.

allIncomingProductLinks: Collection (read-only)

Returns all incoming ProductLinks.

allProductLinks: Collection (read-only)

Returns all outgoing ProductLinks.

assignedToSiteCatalog: Boolean (read-only)

Returns true if the product is assigned to the current site (via the site catalog), otherwise false is returned.

In case of the product being a variant, the variant will be considered as assigned if its master, one of the variation groups it is in or itself is assigned to the site catalog. In case this is triggered for a variation group the variation group is considered as assigned if its master or itself is assigned.

attributeModel: ProductAttributeModel (read-only)

Returns this product's ProductAttributeModel, which makes access to the product attribute information convenient. The model is calculated based on the product attributes assigned to this product's classification category (or any of it's ancestors) and the global attribute definitions for the system object type 'Product'. If this product has no classification category, the attribute model is calculated on the global attribute definitions only. If this product is a variant, then the attribute model is calculated based on the classification category of its corresponding master product.

availabilityModel: ProductAvailabilityModel (read-only)

Returns the availability model, which can be used to determine availability information for a product.

available: Boolean (read-only)

Identifies if the product is available.

Deprecated:

Use getAvailabilityModel().isInStock() instead
availableFlag: Boolean

Identifies if the product is available.

Deprecated:

Use getAvailabilityModel() instead.
brand: String (read-only)

Returns the Brand of the product.

bundle: Boolean (read-only)

Identifies if this product instance is a product bundle.

bundled: Boolean (read-only)

Identifies if this product instance is bundled within at least one product bundle.

bundledProducts: Collection (read-only)

Returns a collection containing all products that participate in the product bundle.

bundles: Collection (read-only)

Returns a collection of all bundles in which this product is included. The method only returns bundles assigned to the current site.

categories: Collection (read-only)

Returns a collection of all categories to which this product is assigned and which are also available through the current site.

categorized: Boolean (read-only)

Identifies if this product is bound to at least one catalog category.

categoryAssignments: Collection (read-only)

Returns a collection of category assignments for this product in the current site catalog.

classificationCategory: Category (read-only)

Returns the classification category associated with this Product. A product has a single classification category which may or may not be in the site catalog. The classification category defines the attribute set of the product. See getAttributeModel() for how the classification category is used.

facebookEnabled: Boolean (read-only)

Identifies if the product is Facebook enabled.

image: MediaFile (read-only)

Returns the product's image.

Deprecated:

Commerce Cloud Digital introduces a new more powerful product image management. It allows to group product images by self-defined view types (e.g. 'large', 'thumbnail', 'swatch') and variation values (e.g. for attribute color 'red', 'blue'). Images can be annotated with pattern based title and alt. Product images can be accessed from Digital locations or external storage locations.

Please use the new product image management. Therefore you have to set up the common product image settings like view types, image location, default image alt and title for your catalogs first. After that you can group your product images by the previously defined view types in context of a product. Finally use getImages(String) and getImage(String, Number) to access your images.
incomingProductLinks: Collection (read-only)

Returns incoming ProductLinks, where the source product is a site product.

longDescription: MarkupText (read-only)

Returns the product's long description in the current locale.

manufacturerName: String (read-only)

Returns the name of the product manufacturer.

manufacturerSKU: String (read-only)

Returns the value of the manufacturer's stock keeping unit.

master: Boolean (read-only)

Identifies if this product instance is a product master.

minOrderQuantity: Quantity (read-only)

Returns the minimum order quantity for this product.

name: String (read-only)

Returns the name of the product in the current locale.

online: Boolean (read-only)

Returns the online status of the product. The online status is calculated from the online status flag and the onlineFrom onlineTo dates defined for the product.

onlineCategories: Collection (read-only)

Returns a collection of all currently online categories to which this product is assigned and which are also available through the current site. A category is currently online if its online flag equals true and the current site date is within the date range defined by the onlineFrom and onlineTo attributes.

onlineFlag: Boolean (read-only)

Returns the online status flag of the product.

onlineFrom: Date (read-only)

Returns the date from which the product is online or valid.

onlineTo: Date (read-only)

Returns the date until which the product is online or valid.

optionModel: ProductOptionModel (read-only)

Returns the product's option model. The option values selections are initialized with the values defined for the product, or the default values defined for the option.

optionProduct: Boolean (read-only)

Identifies if the product has options.

orderableRecommendations: Collection (read-only)

Returns a list of outgoing recommendations for this product. This method behaves similarly to getRecommendations() but additionally filters out recommendations for which the target product is unorderable according to its product availability model.

See Also:

pageDescription: String (read-only)

Returns product's page description in the default locale.

pageKeywords: String (read-only)

Returns the product's page keywords in the default locale.

pageMetaTags: Array (read-only)

Returns all page meta tags, defined for this instance for which content can be generated.

The meta tag content is generated based on the product detail page meta tag context and rules. The rules are obtained from the current product context or inherited from variation groups, master product, the primary category, up to the root category.

pageTitle: String (read-only)

Returns the product's page title in the default locale.

pageURL: String (read-only)

Returns the product's page URL in the default locale.

pinterestEnabled: Boolean (read-only)

Identifies if the product is Pinterest enabled.

priceModel: ProductPriceModel (read-only)

Returns the price model, which can be used to retrieve a price for this product.

primaryCategory: Category (read-only)

Returns the primary category of the product within the current site catalog.

primaryCategoryAssignment: CategoryAssignment (read-only)

Returns the category assignment to the primary category in the current site catalog or null if no primary category is defined within the current site catalog.

product: Boolean (read-only)

Returns 'true' if the instance represents a product. Returns 'false' if the instance represents a product set.

See Also:

productLinks: Collection (read-only)

Returns all outgoing ProductLinks, where the target product is also available in the current site. The ProductLinks are unsorted.

productSet: Boolean (read-only)

Returns 'true' if the instance represents a product set, otherwise 'false'.

See Also:

productSetProduct: Boolean (read-only)

Returns true if this product is part of any product set, otherwise false.

productSetProducts: Collection (read-only)

Returns a collection of all products which are assigned to this product and which are also available through the current site. If this product does not represent a product set then an empty collection will be returned.

productSets: Collection (read-only)

Returns a collection of all product sets in which this product is included. The method only returns product sets assigned to the current site.

recommendations: Collection (read-only)

Returns the outgoing recommendations for this product which belong to the site catalog. If this product is not assigned to the site catalog, or there is no site catalog, an empty collection is returned. Only recommendations for which the target product exists and is assigned to the site catalog are returned. The recommendations are sorted by their explicitly set order.

retailSet: Boolean (read-only)

Identifies if this product instance is part of a retail set.

Deprecated:

Use isProductSet() instead
searchPlacement: Number (read-only)

Returns the product's search placement classification. The higher the numeric product placement value, the more relevant is the product when sorting search results. The range of numeric placement values is defined in the meta data of object type 'Product' and can therefore be customized.

searchRank: Number (read-only)

Returns the product's search rank. The higher the numeric product rank, the more relevant is the product when sorting search results. The range of numeric rank values is defined in the meta data of object type 'Product' and can therefore be customized.

searchable: Boolean (read-only)

Identifies if the product is searchable.

searchableFlag: Boolean (read-only)

Returns, whether the product is currently searchable.

searchableIfUnavailableFlag: Boolean (read-only)

Returns the searchable status of the Product if unavailable.

Besides true or false, the return value null indicates that the value is not set.

shortDescription: MarkupText (read-only)

Returns the product's short description in the current locale.

siteMapChangeFrequency: String (read-only)

Returns the product's change frequency needed for the sitemap creation.

siteMapIncluded: Number (read-only)

Returns the status if the product is included into the sitemap.

siteMapPriority: Number (read-only)

Returns the product's priority needed for the sitemap creation.

siteProduct: Boolean (read-only)

Returns 'true' if the product is assigned to the current site (via the site catalog), otherwise 'false' is returned.

Deprecated:

Use isAssignedToSiteCatalog() instead
stepQuantity: Quantity (read-only)

Returns the steps in which the order amount of the product can be increased.

storeReceiptName: String (read-only)

Returns the store receipt name of the product in the current locale.

storeTaxClass: String (read-only)

Returns the store tax class ID.

This is an optional override for in-store tax calculation.

taxClassID: String (read-only)

Returns the ID of the product's tax class, by resolving the Global Preference setting selected. If the Localized Tax Class setting under Global Preferences -> Products is selected, the localizedTaxClassID attribute value will be returned, else the legacy taxClassID attribute value will be returned.

template: String (read-only)

Returns the name of the product's rendering template.

thumbnail: MediaFile (read-only)

Returns the product's thumbnail image.

Deprecated:

Commerce Cloud Digital introduces a new more powerful product image management. It allows to group product images by self-defined view types (e.g. 'large', 'thumbnail', 'swatch') and variation values (e.g. for attribute color 'red', 'blue'). Images can be annotated with pattern based title and alt. Product images can be accessed from Digital locations or external storage locations.

Please use the new product image management. Therefore you have to set up the common product image settings like view types, image location, default image alt and title for your catalogs first. After that you can group your product images by the previously defined view types in context of a product. Finally use getImages(String) and getImage(String, Number) to access your images.
unit: String (read-only)

Returns the product's sales unit.

unitQuantity: Quantity (read-only)

Returns the product's unit quantity.

variant: Boolean (read-only)

Identifies if this product instance is mastered by a product master.

variants: Collection (read-only)

Returns a collection of all variants assigned to this variation master or variation group product. All variants are returned regardless of whether they are online or offline.

If this product does not represent a variation master or variation group product then an empty collection is returned.

variationGroup: Boolean (read-only)

Identifies if this product instance is a variation group product.

variationGroups: Collection (read-only)

Returns a collection of all variation groups assigned to this variation master product. All variation groups are returned regardless of whether they are online or offline.

If this product does not represent a variation master product then an empty collection is returned.

variationModel: ProductVariationModel (read-only)

Returns the variation model of this product. If this product is a master product, then the returned model will encapsulate all the information about its variation attributes and variants. If this product is a variant product, then the returned model will encapsulate all the same information, but additionally pre-select all the variation attribute values of this variant. (See ProductVariationModel for details on what "selected" means.) If this product is neither a master product or a variation product, then a model will be returned but will be essentially empty and not useful for any particular purpose.

assignedToCategory(category: Category): Boolean

Identifies if this product is bound to the specified catalog category.

Parameters:

  • category - the CatalogCategory to check.

Returns:

  • true if the product is bound to the CatalogCategory, false otherwise.

Deprecated:

Use isAssignedToCategory(Category)
getActiveData(): ProductActiveData

Returns the active data for this product, for the current site.

Returns:

  • the active data for this product for the current site.
getAllCategories(): Collection

Returns a collection of all categories to which this product is assigned.

Returns:

  • Collection of categories.
getAllCategoryAssignments(): Collection

Returns all category assignments for this product in any catalog.

Returns:

  • Collection of category assignments of the product in any catalog.
getAllIncomingProductLinks(): Collection

Returns all incoming ProductLinks.

Returns:

  • a collection of all incoming ProductLinks.
getAllIncomingProductLinks(type: Number): Collection

Returns all incoming ProductLinks of a specific type.

Parameters:

  • type - the type of ProductLinks to use.

Returns:

  • a collection of all incoming ProductLinks of a specific type.
getAllProductLinks(): Collection

Returns all outgoing ProductLinks.

Returns:

  • a collection of all outgoing ProductLinks.
getAllProductLinks(type: Number): Collection

Returns all outgoing ProductLinks of a specific type.

Parameters:

  • type - the type of ProductLinks to fetch.

Returns:

  • a collection of all outgoing ProductLinks of a specific type.
getAllRecommendations(catalog: Catalog): Collection

Returns the outgoing recommendations for this product which belong to the specified catalog. The recommendations are sorted by their explicitly set order.

Parameters:

  • catalog - the catalog containing the recommendations.

Returns:

  • the sorted collection of recommendations, never null but possibly empty.
getAllRecommendations(catalog: Catalog, type: Number): Collection

Returns the outgoing recommendations for this product which are of the specified type and which belong to the specified catalog. The recommendations are sorted by their explicitly set order.

Parameters:

  • catalog - the catalog containing the recommendations.
  • type - the recommendation type.

Returns:

  • the sorted collection of recommendations, never null but possibly empty.
getAttributeModel(): ProductAttributeModel

Returns this product's ProductAttributeModel, which makes access to the product attribute information convenient. The model is calculated based on the product attributes assigned to this product's classification category (or any of it's ancestors) and the global attribute definitions for the system object type 'Product'. If this product has no classification category, the attribute model is calculated on the global attribute definitions only. If this product is a variant, then the attribute model is calculated based on the classification category of its corresponding master product.

Returns:

  • the ProductAttributeModel for this product.
getAvailabilityModel(): ProductAvailabilityModel

Returns the availability model, which can be used to determine availability information for a product.

Returns:

  • the availability model for a product.
getAvailabilityModel(list: ProductInventoryList): ProductAvailabilityModel

Returns the availability model of the given inventory list, which can be used to determine availability information for a product.

Parameters:

  • list - The inventory list to get the availability model for. Must not be null or an exception will be raised.

Returns:

  • the availability model of the given inventory list for a product.
getAvailableFlag(): Boolean

Identifies if the product is available.

Returns:

  • the availability status flag of the product.

Deprecated:

Use getAvailabilityModel() instead.
getBrand(): String

Returns the Brand of the product.

Returns:

  • the Brand of the product.
getBundledProductQuantity(aProduct: Product): Quantity

Returns the quantity of the specified product within the bundle. If the specified product is not part of the bundle, a 0 quantity is returned.

Parameters:

  • aProduct - The product to determine the quantity for.

Returns:

  • The quantity of the product within the bundle or 0 if the product is not part of the bundle.
getBundledProducts(): Collection

Returns a collection containing all products that participate in the product bundle.

Returns:

  • A collection containing all products of the product bundle.
getBundles(): Collection

Returns a collection of all bundles in which this product is included. The method only returns bundles assigned to the current site.

Returns:

  • Collection of bundles in which this product is included, possibly empty.
getCategories(): Collection

Returns a collection of all categories to which this product is assigned and which are also available through the current site.

Returns:

  • Collection of categories to which this product is assigned and which are also available through the current site.
getCategoryAssignment(category: Category): CategoryAssignment

Returns the category assignment for a specific category.

Parameters:

  • category - the category to use when fetching assignments.

Returns:

  • The category assignment for a specific category.
getCategoryAssignments(): Collection

Returns a collection of category assignments for this product in the current site catalog.

Returns:

  • Collection of category assignments.
getClassificationCategory(): Category

Returns the classification category associated with this Product. A product has a single classification category which may or may not be in the site catalog. The classification category defines the attribute set of the product. See getAttributeModel() for how the classification category is used.

Returns:

  • the associated classification Category, or null if none is associated.
getEAN(): String

Returns the European Article Number of the product.

Returns:

  • the European Article Number of the product.
getID(): String

Returns the ID of the product.

Returns:

  • ID of the product.
getImage(): MediaFile

Returns the product's image.

Returns:

  • the product's image.

Deprecated:

Commerce Cloud Digital introduces a new more powerful product image management. It allows to group product images by self-defined view types (e.g. 'large', 'thumbnail', 'swatch') and variation values (e.g. for attribute color 'red', 'blue'). Images can be annotated with pattern based title and alt. Product images can be accessed from Digital locations or external storage locations.

Please use the new product image management. Therefore you have to set up the common product image settings like view types, image location, default image alt and title for your catalogs first. After that you can group your product images by the previously defined view types in context of a product. Finally use getImages(String) and getImage(String, Number) to access your images.
getImage(viewtype: String): MediaFile

The method calls getImages(String) and returns the first image. If no image is available the method returns null.

When called for a variant with defined images for specified view type the method returns the first image.

When called for a variant without defined images for specified view type the method returns the first master product image. If no master product images are defined, the method returns null.

Parameters:

  • viewtype - the view type annotated to image

Returns:

  • the MediaFile or null

Throws:

  • NullArgumentException - if viewtype is null
getImage(viewtype: String, index: Number): MediaFile

The method calls getImages(String) and returns the image at the specific index. If no image for specified index is available the method returns null.

Parameters:

  • viewtype - the view type annotated to image
  • index - the index number of the image within image list

Returns:

  • the MediaFile or null

Throws:

  • NullArgumentException - if viewtype is null
getImages(viewtype: String): List

Returns all images assigned to this product for a specific view type, e.g. all 'thumbnail' images. The images are returned in the order of their index number ascending.

When called for a master the method returns the images specific to the master, which are typically the fall back images.

Parameters:

  • viewtype - the view type annotated to images

Returns:

  • a list of MediaFile objects, possibly empty

Throws:

  • NullArgumentException - if viewtype is null
getIncomingProductLinks(): Collection

Returns incoming ProductLinks, where the source product is a site product.

Returns:

  • a collection of incoming ProductLinks, where the source product is a site product.
getIncomingProductLinks(type: Number): Collection

Returns incoming ProductLinks, where the source product is a site product of a specific type.

Parameters:

  • type - the type of ProductLinks to fetch.

Returns:

  • a collection of incoming ProductLinks, where the source product is a site product of a specific type.
getLongDescription(): MarkupText

Returns the product's long description in the current locale.

Returns:

  • The product's long description in the current locale, or null if it wasn't found.
getManufacturerName(): String

Returns the name of the product manufacturer.

Returns:

  • the name of the product manufacturer.
getManufacturerSKU(): String

Returns the value of the manufacturer's stock keeping unit.

Returns:

  • the value of the manufacturer's stock keeping unit.
getMinOrderQuantity(): Quantity

Returns the minimum order quantity for this product.

Returns:

  • the minimum order quantity of the product.
getName(): String

Returns the name of the product in the current locale.

Returns:

  • The name of the product for the current locale, or null if it wasn't found.
getOnlineCategories(): Collection

Returns a collection of all currently online categories to which this product is assigned and which are also available through the current site. A category is currently online if its online flag equals true and the current site date is within the date range defined by the onlineFrom and onlineTo attributes.

Returns:

  • Collection of currently online categories to which this product is assigned and which are also available through the current site.
getOnlineFlag(): Boolean

Returns the online status flag of the product.

Returns:

  • the online status flag of the product.
getOnlineFrom(): Date

Returns the date from which the product is online or valid.

Returns:

  • the date from which the product is online or valid.
getOnlineTo(): Date

Returns the date until which the product is online or valid.

Returns:

  • the date until which the product is online or valid.
getOptionModel(): ProductOptionModel

Returns the product's option model. The option values selections are initialized with the values defined for the product, or the default values defined for the option.

Returns:

  • the products option model.
getOrderableRecommendations(): Collection

Returns a list of outgoing recommendations for this product. This method behaves similarly to getRecommendations() but additionally filters out recommendations for which the target product is unorderable according to its product availability model.

Returns:

  • the sorted collection of recommendations, never null but possibly empty.

See Also:

getOrderableRecommendations(type: Number): Collection

Returns a list of outgoing recommendations for this product. This method behaves similarly to getRecommendations(Number) but additionally filters out recommendations for which the target product is unorderable according to its product availability model.

Parameters:

  • type - the recommendation type.

Returns:

  • the sorted collection of recommendations, never null but possibly empty.

See Also:

getPageDescription(): String

Returns product's page description in the default locale.

Returns:

  • The product's page description in the default locale, or null if it wasn't found.
getPageKeywords(): String

Returns the product's page keywords in the default locale.

Returns:

  • The product's page keywords in the default locale, or null if it wasn't found.
getPageMetaTag(id: String): PageMetaTag

Returns the page meta tag for the specified id.

The meta tag content is generated based on the product detail page meta tag context and rule. The rule is obtained from the current product context or inherited from variation groups, master product, the primary category, up to the root category.

Null will be returned if the meta tag is undefined on the current instance, or if no rule can be found for the current context, or if the rule resolves to an empty string.

Parameters:

  • id - the ID to get the page meta tag for

Returns:

  • page meta tag containing content generated based on rules
getPageMetaTags(): Array

Returns all page meta tags, defined for this instance for which content can be generated.

The meta tag content is generated based on the product detail page meta tag context and rules. The rules are obtained from the current product context or inherited from variation groups, master product, the primary category, up to the root category.

Returns:

  • page meta tags defined for this instance, containing content generated based on rules
getPageTitle(): String

Returns the product's page title in the default locale.

Returns:

  • The product's page title in the default locale, or null if it wasn't found.
getPageURL(): String

Returns the product's page URL in the default locale.

Returns:

  • The product's page URL in the default locale, or null if it wasn't found.
getPriceModel(): ProductPriceModel

Returns the price model, which can be used to retrieve a price for this product.

Returns:

  • the price model, which can be used to retrieve a price for this product.
getPriceModel(optionModel: ProductOptionModel): ProductPriceModel

Returns the price model based on the specified optionModel. The price model can be used to retrieve a price for this product. Prices are calculated based on the option values selected in the specified option model.

Parameters:

  • optionModel - the option model to use when fetching the price model.

Returns:

  • the price model based on the specified optionModel.
getPrimaryCategory(): Category

Returns the primary category of the product within the current site catalog.

Returns:

  • The product's primary category or null.
getPrimaryCategoryAssignment(): CategoryAssignment

Returns the category assignment to the primary category in the current site catalog or null if no primary category is defined within the current site catalog.

Returns:

  • The category assignment to the primary category or null.
getProductLinks(): Collection

Returns all outgoing ProductLinks, where the target product is also available in the current site. The ProductLinks are unsorted.

Returns:

  • a collection of outgoing ProductLinks where the target product is also available in the current site.
getProductLinks(type: Number): Collection

Returns all outgoing ProductLinks of a specific type, where the target product is also available in the current site. The ProductLinks are sorted.

Parameters:

  • type - the type of ProductLinks to fetch.

Returns:

  • a collection of outgoing ProductLinks where the target product is also available in the current site.
getProductSetProducts(): Collection

Returns a collection of all products which are assigned to this product and which are also available through the current site. If this product does not represent a product set then an empty collection will be returned.

Returns:

  • Collection of products which are assigned to this product and which are also available through the current site.
getProductSets(): Collection

Returns a collection of all product sets in which this product is included. The method only returns product sets assigned to the current site.

Returns:

  • Collection of product sets in which this product is included, possibly empty.
getRecommendations(): Collection

Returns the outgoing recommendations for this product which belong to the site catalog. If this product is not assigned to the site catalog, or there is no site catalog, an empty collection is returned. Only recommendations for which the target product exists and is assigned to the site catalog are returned. The recommendations are sorted by their explicitly set order.

Returns:

  • the sorted collection of recommendations, never null but possibly empty.
getRecommendations(type: Number): Collection

Returns the outgoing recommendations for this product which are of the specified type and which belong to the site catalog. Behaves the same as getRecommendations() but additionally filters by recommendation type.

Parameters:

  • type - the recommendation type.

Returns:

  • the sorted collection of recommendations, never null but possibly empty.
getSearchPlacement(): Number

Returns the product's search placement classification. The higher the numeric product placement value, the more relevant is the product when sorting search results. The range of numeric placement values is defined in the meta data of object type 'Product' and can therefore be customized.

Returns:

  • The product's search placement classification.
getSearchRank(): Number

Returns the product's search rank. The higher the numeric product rank, the more relevant is the product when sorting search results. The range of numeric rank values is defined in the meta data of object type 'Product' and can therefore be customized.

Returns:

  • The product's search rank.
getSearchableFlag(): Boolean

Returns, whether the product is currently searchable.

Returns:

  • the searchable status flag of the product.
getSearchableIfUnavailableFlag(): Boolean

Returns the searchable status of the Product if unavailable.

Besides true or false, the return value null indicates that the value is not set.

Returns:

  • The searchable status of the product if unavailable or null if not set.
getShortDescription(): MarkupText

Returns the product's short description in the current locale.

Returns:

  • the product's short description in the current locale, or null if it wasn't found.
getSiteMapChangeFrequency(): String

Returns the product's change frequency needed for the sitemap creation.

Returns:

  • The product's sitemap change frequency.
getSiteMapIncluded(): Number

Returns the status if the product is included into the sitemap.

Returns:

  • the value of the attribute 'siteMapIncluded'.
getSiteMapPriority(): Number

Returns the product's priority needed for the sitemap creation.

Returns:

  • The product's sitemap priority.
getStepQuantity(): Quantity

Returns the steps in which the order amount of the product can be increased.

Returns:

  • the order amount by which the product can be increased.
getStoreReceiptName(): String

Returns the store receipt name of the product in the current locale.

Returns:

  • The store receipt name of the product for the current locale, or null if it wasn't found.
getStoreTaxClass(): String

Returns the store tax class ID.

This is an optional override for in-store tax calculation.

Returns:

  • the store tax class id.
getTaxClassID(): String

Returns the ID of the product's tax class, by resolving the Global Preference setting selected. If the Localized Tax Class setting under Global Preferences -> Products is selected, the localizedTaxClassID attribute value will be returned, else the legacy taxClassID attribute value will be returned.

Returns:

  • the ID of the product's tax class depending on the Global Preference setting selected for Products.
getTemplate(): String

Returns the name of the product's rendering template.

Returns:

  • the name of the product's rendering template.
getThumbnail(): MediaFile

Returns the product's thumbnail image.

Returns:

  • the product's thumbnail image.

Deprecated:

Commerce Cloud Digital introduces a new more powerful product image management. It allows to group product images by self-defined view types (e.g. 'large', 'thumbnail', 'swatch') and variation values (e.g. for attribute color 'red', 'blue'). Images can be annotated with pattern based title and alt. Product images can be accessed from Digital locations or external storage locations.

Please use the new product image management. Therefore you have to set up the common product image settings like view types, image location, default image alt and title for your catalogs first. After that you can group your product images by the previously defined view types in context of a product. Finally use getImages(String) and getImage(String, Number) to access your images.
getUPC(): String

Returns the Universal Product Code of the product.

Returns:

  • the Universal Product Code of the product.
getUnit(): String

Returns the product's sales unit.

Returns:

  • the products sales unit.
getUnitQuantity(): Quantity

Returns the product's unit quantity.

Returns:

  • the products unit quantity.
getVariants(): Collection

Returns a collection of all variants assigned to this variation master or variation group product. All variants are returned regardless of whether they are online or offline.

If this product does not represent a variation master or variation group product then an empty collection is returned.

Returns:

  • Collection of variants associated with this variation master or variation group product.
getVariationGroups(): Collection

Returns a collection of all variation groups assigned to this variation master product. All variation groups are returned regardless of whether they are online or offline.

If this product does not represent a variation master product then an empty collection is returned.

Returns:

  • Collection of variation groups associated with this variation master product.
getVariationModel(): ProductVariationModel

Returns the variation model of this product. If this product is a master product, then the returned model will encapsulate all the information about its variation attributes and variants. If this product is a variant product, then the returned model will encapsulate all the same information, but additionally pre-select all the variation attribute values of this variant. (See ProductVariationModel for details on what "selected" means.) If this product is neither a master product or a variation product, then a model will be returned but will be essentially empty and not useful for any particular purpose.

Returns:

  • the variation model of the product.
includedInBundle(product: Product): Boolean

Identifies if the specified product participates in this product bundle. If this product does not represent a bundle at all, then false will always be returned.

Parameters:

  • product - the product to check for participation.

Returns:

  • true if the product participates in the bundle, false otherwise.
isAssignedToCategory(category: Category): Boolean

Returns 'true' if item is assigned to the specified category.

Parameters:

  • category - the category to check.

Returns:

  • true if item is assigned to category.
isAssignedToSiteCatalog(): Boolean

Returns true if the product is assigned to the current site (via the site catalog), otherwise false is returned.

In case of the product being a variant, the variant will be considered as assigned if its master, one of the variation groups it is in or itself is assigned to the site catalog. In case this is triggered for a variation group the variation group is considered as assigned if its master or itself is assigned.

Returns:

  • 'true' if product assigned to the site catalog
isAvailable(): Boolean

Identifies if the product is available.

Returns:

  • the value of the attribute 'available'.

Deprecated:

Use getAvailabilityModel().isInStock() instead
isBundle(): Boolean

Identifies if this product instance is a product bundle.

Returns:

  • true if the product is a bundle, false otherwise.
isBundled(): Boolean

Identifies if this product instance is bundled within at least one product bundle.

Returns:

  • true if the product is bundled, false otherwise.
isCategorized(): Boolean

Identifies if this product is bound to at least one catalog category.

Returns:

  • true if the product is bound to at least one catalog category, false otherwise.
isFacebookEnabled(): Boolean

Identifies if the product is Facebook enabled.

Returns:

  • the value of the attribute 'facebookEnabled'.
isMaster(): Boolean

Identifies if this product instance is a product master.

Returns:

  • true if the product is a master, false otherwise.
isOnline(): Boolean

Returns the online status of the product. The online status is calculated from the online status flag and the onlineFrom onlineTo dates defined for the product.

Returns:

  • the online status of the product.
isOptionProduct(): Boolean

Identifies if the product has options.

Returns:

  • true if product has options, false otherwise.
isPinterestEnabled(): Boolean

Identifies if the product is Pinterest enabled.

Returns:

  • the value of the attribute 'pinterestEnabled'.
isProduct(): Boolean

Returns 'true' if the instance represents a product. Returns 'false' if the instance represents a product set.

Returns:

  • true if the instance is a product, false otherwise.

See Also:

isProductSet(): Boolean

Returns 'true' if the instance represents a product set, otherwise 'false'.

Returns:

  • true if the instance is a product set, false otherwise.

See Also:

isProductSetProduct(): Boolean

Returns true if this product is part of any product set, otherwise false.

Returns:

  • true if the product is part of any product set, false otherwise.
isRetailSet(): Boolean

Identifies if this product instance is part of a retail set.

Returns:

  • true if the product is part of a retail set, false otherwise.

Deprecated:

Use isProductSet() instead
isSearchable(): Boolean

Identifies if the product is searchable.

Returns:

  • the value of the attribute 'searchable'.
isSiteProduct(): Boolean

Returns 'true' if the product is assigned to the current site (via the site catalog), otherwise 'false' is returned.

Returns:

  • 'true' if product assigned to site.

Deprecated:

Use isAssignedToSiteCatalog() instead
isVariant(): Boolean

Identifies if this product instance is mastered by a product master.

Returns:

  • true if the product is mastered, false otherwise.
isVariationGroup(): Boolean

Identifies if this product instance is a variation group product.

Returns:

  • true if the product is a variation group, false otherwise.
setAvailableFlag(available: Boolean): void

Set the availability status flag of the product.

Parameters:

  • available - Availability status flag.

Deprecated:

Don't use this method anymore.
setOnlineFlag(online: Boolean): void

Set the online status flag of the product.

Parameters:

  • online - Online status flag.

API Version:

No longer available as of version 10.6.
setOnlineFlag(online: Boolean): void

Set the online status flag of the product for the current site. If current site is not available (i.e. in case this method is called by a job that runs on organization level) the online status flag is set global, which can affect all sites.

In previous versions this method set the online status flag global, instead of site specific.

Parameters:

  • online - Online status flag.

API Version:

Available from version 10.6. In prior versions this method set the online status flag global, instead of site specific.
setSearchPlacement(placement: Number): void

Set the product's search placement.

Parameters:

  • placement - The product's search placement classification.

API Version:

No longer available as of version 10.6.
setSearchPlacement(placement: Number): void

Set the product's search placement classification in context of the current site. If current site is not available (i.e. in case this method is called by a job that runs on organization level) the search placement is set global, which can affect all sites.

In previous versions this method set the search placement classification global, instead of site specific.

Parameters:

  • placement - The product's search placement classification.

API Version:

Available from version 10.6. In prior versions this method set the search placement classification global, instead of site specific.
setSearchRank(rank: Number): void

Set the product's search rank.

Parameters:

  • rank - The product's search rank.

API Version:

No longer available as of version 10.6.
setSearchRank(rank: Number): void

Set the product's search rank in context of the current site. If current site is not available (i.e. in case this method is called by a job that runs on organization level) the search rank is set global, which can affect all sites.

In previous versions this method set the search rank global, instead of site specific.

Parameters:

  • rank - The product's search rank.

API Version:

Available from version 10.6. In prior versions this method set the search rank global, instead of site specific.
setSearchableFlag(searchable: Boolean): void

Set the flag indicating whether the product is searchable or not.

Parameters:

  • searchable - The value of the attribute 'searchable'.

API Version:

No longer available as of version 10.6.
setSearchableFlag(searchable: Boolean): void

Set the flag indicating whether the product is searchable or not in context of the current site. If current site is not available (i.e. in case this method is called by a job that runs on organization level) the searchable flag is set global, which can affect all sites.

In previous versions this method set the searchable flag global, instead of site specific.

Parameters:

  • searchable - The value of the attribute 'searchable'.

API Version:

Available from version 10.6. In prior versions this method set the searchable flag global, instead of site specific.