Salesforce B2C Commerce 24.7 > B2C Commerce API > B2C Commerce Script > dw.catalog
dw.catalog
Class Variant
Object
dw.object.PersistentObject
dw.object.ExtensibleObject
dw.catalog.Product
dw.catalog.Variant
Represents a variant of a product variation. If the variant does not define an own value, the value is retrieved by fallback from variation groups (sorted by their position) or the variation master.
Properties
allProductLinks  :  Collection  (Read Only)
All product links of the product variant.
If the variant does not define any product links, the product links are retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define any product links, the product links are retrieved from the master product.
brand  :  String  (Read Only)
The brand of the product variant.
If the variant does not define an own value for 'brand', the value is retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define a value for 'brand', the value of the master product is returned.
classificationCategory  :  Category  (Read Only)
The classification category of the product variant.
Please note that the classification category is always inherited from the master and cannot be overridden by the variant.
custom  :  CustomAttributes  (Read Only)
The custom attributes of the variant.
Custom attributes are inherited from the master product and can be overridden by the variant.
EAN  :  String  (Read Only)
The EAN of the product variant.
If the variant does not define an own value for 'EAN', the value is retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define a value for 'EAN', the value of the master product is returned.
image  :  MediaFile  (Read Only)
The image of the product variant.
If the variant does not define an own value for 'image', the value is retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define a value for 'image', the value of the master product is returned.
longDescription  :  MarkupText  (Read Only)
The long description of the product variant.
If the variant does not define an own value for 'longDescription', the value is retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define a value for 'longDescription', the value of the master product is returned.
manufacturerName  :  String  (Read Only)
The manufacturer name of the product variant.
If the variant does not define an own value for 'manufacturerName', the value is retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define a value for 'manufacturerName', the value of the master product is returned.
manufacturerSKU  :  String  (Read Only)
The manufacturer sku of the product variant.
If the variant does not define an own value for 'manufacturerSKU', the value is retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define a value for 'manufacturerSKU', the value of the master product is returned.
masterProduct  :  Product  (Read Only)
The ProductMaster for this mastered product.
name  :  String  (Read Only)
The name of the product variant.
If the variant does not define an own value for 'name', the value is retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define a value for 'name', the value of the master product is returned.
onlineFrom  :  Date  (Read Only)
The onlineFrom date of the product variant.
If the variant does not define an own value for 'onlineFrom', the value is retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define a value for 'onlineFrom', the value of the master product is returned.
onlineTo  :  Date  (Read Only)
The onlineTo date of the product variant.
If the variant does not define an own value for 'onlineTo', the value is retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define a value for 'onlineTo', the value of the master product is returned.
optionProduct  :  boolean  (Read Only)
Returns 'true' if the variant has any options, otherwise 'false'. Method also returns 'true' if the variant has not any options, but the related variation groups (sorted by position) or master product has options.
pageDescription  :  String  (Read Only)
The pageDescription of the product variant.
If the variant does not define an own value for 'pageDescription', the value is retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define a value for 'pageDescription', the value of the master product is returned.
pageKeywords  :  String  (Read Only)
The pageKeywords of the product variant.
If the variant does not define an own value for 'pageKeywords', the value is retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define a value for 'pageKeywords', the value of the master product is returned.
pageTitle  :  String  (Read Only)
The pageTitle of the product variant.
If the variant does not define an own value for 'pageTitle', the value is retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define a value for 'pageTitle', the value of the master product is returned.
pageURL  :  String  (Read Only)
The pageURL of the product variant.
If the variant does not define an own value for 'pageURL', the value is retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define a value for 'pageURL', the value of the master product is returned.
productLinks  :  Collection  (Read Only)
All product links of the product variant for which the target product is assigned to the current site catalog.
If the variant does not define any product links, the product links are retrieved from the assigned variation groups, sorted by their position If none of the variation groups define any product links, the product links are retrieved from the master product.
shortDescription  :  MarkupText  (Read Only)
The short description of the product variant.
If the variant does not define an own value for 'shortDescription', the value is retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define a value for 'shortDescription', the value of the master product is returned.
taxClassID  :  String  (Read Only)
The tax class id of the product variant.
If the variant does not define an own value for 'taxClassID', the value is retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define a value for 'taxClassID', the value of the master product is returned.
template  :  String  (Read Only)
The rendering template name of the product variant.
If the variant does not define an own value for 'template', the value is retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define a value for 'template', the value of the master product is returned.
thumbnail  :  MediaFile  (Read Only)
The thumbnail image of the product variant.
If the variant does not define an own value for 'thumbnail', the value is retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define a value for 'thumbnail', the value of the master product is returned.
unit  :  String  (Read Only)
The sales unit of the product variant as defined by the master product.
If the variant does not define an own value for 'unit', the value is retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define a value for 'unit', the value of the master product is returned.
unitQuantity  :  Quantity  (Read Only)
The unitQuantity of the product variant as defined by the master product.
If the variant does not define an own value for 'unitQuantity', the value is retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define a value for 'unitQuantity', the value of the master product is returned.
UPC  :  String  (Read Only)
The UPC of the product variant.
If the variant does not define an own value for 'UPC', the value is retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define a value for 'UPC', the value of the master product is returned.
Constructor Summary
This class does not have a constructor, so you cannot create it directly.
Method Summary
getAllProductLinks() : Collection
Returns all product links of the product variant.
getAllProductLinks(type : Number) : Collection
Returns all product links of the specified type of the product variant.
getBrand() : String
Returns the brand of the product variant.
getClassificationCategory() : Category
Returns the classification category of the product variant.
getCustom() : CustomAttributes
Returns the custom attributes of the variant.
getEAN() : String
Returns the EAN of the product variant.
getImage() : MediaFile
Returns the image of the product variant.
getLongDescription() : MarkupText
Returns the long description of the product variant.
getManufacturerName() : String
Returns the manufacturer name of the product variant.
getManufacturerSKU() : String
Returns the manufacturer sku of the product variant.
getMasterProduct() : Product
Returns the ProductMaster for this mastered product.
getName() : String
Returns the name of the product variant.
getOnlineFrom() : Date
Returns the onlineFrom date of the product variant.
getOnlineTo() : Date
Returns the onlineTo date of the product variant.
getPageDescription() : String
Returns the pageDescription of the product variant.
getPageKeywords() : String
Returns the pageKeywords of the product variant.
getPageTitle() : String
Returns the pageTitle of the product variant.
getPageURL() : String
Returns the pageURL of the product variant.
getProductLinks() : Collection
Returns all product links of the product variant for which the target product is assigned to the current site catalog.
getProductLinks(type : Number) : Collection
Returns all product links of the specified type of the product variant for which the target product is assigned to the current site catalog.
getRecommendations(type : Number) : Collection
Retrieve the sorted collection of recommendations of the specified type for this product variant.
getShortDescription() : MarkupText
Returns the short description of the product variant.
getTaxClassID() : String
Returns the tax class id of the product variant.
getTemplate() : String
Returns the rendering template name of the product variant.
getThumbnail() : MediaFile
Returns the thumbnail image of the product variant.
getUnit() : String
Returns the sales unit of the product variant as defined by the master product.
getUnitQuantity() : Quantity
Returns the unitQuantity of the product variant as defined by the master product.
getUPC() : String
Returns the UPC of the product variant.
isOptionProduct() : boolean
Returns 'true' if the variant has any options, otherwise 'false'.
Methods inherited from class Product
assignedToCategory, getActiveData, getAllCategories, getAllCategoryAssignments, getAllIncomingProductLinks, getAllIncomingProductLinks, getAllProductLinks, getAllProductLinks, getAllRecommendations, getAllRecommendations, getAttributeModel, getAvailabilityModel, getAvailabilityModel, getAvailableFlag, getBrand, getBundledProductQuantity, getBundledProducts, getBundles, getCategories, getCategoryAssignment, getCategoryAssignments, getClassificationCategory, getEAN, getID, getImage, getImage, getImage, getImages, getIncomingProductLinks, getIncomingProductLinks, getLongDescription, getManufacturerName, getManufacturerSKU, getMinOrderQuantity, getName, getOnlineCategories, getOnlineFlag, getOnlineFrom, getOnlineTo, getOptionModel, getOrderableRecommendations, getOrderableRecommendations, getPageDescription, getPageKeywords, getPageMetaTag, getPageMetaTags, getPageTitle, getPageURL, getPriceModel, getPriceModel, getPrimaryCategory, getPrimaryCategoryAssignment, getProductLinks, getProductLinks, getProductSetProducts, getProductSets, getRecommendations, getRecommendations, getSearchableFlag, getSearchableIfUnavailableFlag, getSearchPlacement, getSearchRank, getShortDescription, getSiteMapChangeFrequency, getSiteMapIncluded, getSiteMapPriority, getStepQuantity, getStoreReceiptName, getStoreTaxClass, getTaxClassID, getTemplate, getThumbnail, getUnit, getUnitQuantity, getUPC, getVariants, getVariationGroups, getVariationModel, includedInBundle, isAssignedToCategory, isAssignedToSiteCatalog, isAvailable, isBundle, isBundled, isCategorized, isFacebookEnabled, isMaster, isOnline, isOptionProduct, isPinterestEnabled, isProduct, isProductSet, isProductSetProduct, isRetailSet, isSearchable, isSiteProduct, isVariant, isVariationGroup, setAvailableFlag, setOnlineFlag, setSearchableFlag, setSearchPlacement, setSearchRank
Methods inherited from class ExtensibleObject
describe, getCustom
Methods inherited from class PersistentObject
getCreationDate, getLastModified, getUUID
Methods inherited from class Object
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
Method Detail
getAllProductLinks
getAllProductLinks() : Collection
Returns all product links of the product variant.
If the variant does not define any product links, the product links are retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define any product links, the product links are retrieved from the master product.
Returns:
All product links of the variant, variation group or master
getAllProductLinks
getAllProductLinks(type : Number) : Collection
Returns all product links of the specified type of the product variant.
If the variant does not define any product links of the specified type, the product links are retrieved for the specified type from the assigned variation groups, sorted by their position. If none of the variation groups define any product links of the specified type, the product links are retrieved for the specified type from the master product.
Parameters:
type - Type of the product link
Returns:
Product links of specified type of the variant, variation group or master
getBrand
getBrand() : String
Returns the brand of the product variant.
If the variant does not define an own value for 'brand', the value is retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define a value for 'brand', the value of the master product is returned.
Returns:
The brand of the variant, variation group or master
getClassificationCategory
getClassificationCategory() : Category
Returns the classification category of the product variant.
Please note that the classification category is always inherited from the master and cannot be overridden by the variant.
Returns:
The classification category as defined for the master product of the variant
getCustom
getCustom() : CustomAttributes
Returns the custom attributes of the variant.
Custom attributes are inherited from the master product and can be overridden by the variant.
Returns:
the custom attributes of the variant.
getEAN
getEAN() : String
Returns the EAN of the product variant.
If the variant does not define an own value for 'EAN', the value is retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define a value for 'EAN', the value of the master product is returned.
Returns:
The EAN of the variant, variation group or master
getImage
getImage() : MediaFile
Returns the image of the product variant.
If the variant does not define an own value for 'image', the value is retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define a value for 'image', the value of the master product is returned.
Returns:
The image of the variant, variation group or master
getLongDescription
getLongDescription() : MarkupText
Returns the long description of the product variant.
If the variant does not define an own value for 'longDescription', the value is retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define a value for 'longDescription', the value of the master product is returned.
Returns:
The long description of the variant, variation group or master
getManufacturerName
getManufacturerName() : String
Returns the manufacturer name of the product variant.
If the variant does not define an own value for 'manufacturerName', the value is retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define a value for 'manufacturerName', the value of the master product is returned.
Returns:
The manufacturer name of the variant, variation group or master
getManufacturerSKU
getManufacturerSKU() : String
Returns the manufacturer sku of the product variant.
If the variant does not define an own value for 'manufacturerSKU', the value is retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define a value for 'manufacturerSKU', the value of the master product is returned.
Returns:
The manufacturer sku of the variant, variation group or master
getMasterProduct
getMasterProduct() : Product
Returns the ProductMaster for this mastered product.
Returns:
the ProductMaster of this mastered product
getName
getName() : String
Returns the name of the product variant.
If the variant does not define an own value for 'name', the value is retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define a value for 'name', the value of the master product is returned.
Returns:
The name of the variant, variation group or master
getOnlineFrom
getOnlineFrom() : Date
Returns the onlineFrom date of the product variant.
If the variant does not define an own value for 'onlineFrom', the value is retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define a value for 'onlineFrom', the value of the master product is returned.
Returns:
The onlineFrom date of the variant, variation group or master
getOnlineTo
getOnlineTo() : Date
Returns the onlineTo date of the product variant.
If the variant does not define an own value for 'onlineTo', the value is retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define a value for 'onlineTo', the value of the master product is returned.
Returns:
The onlineTo date of the variant, variation group or master
getPageDescription
getPageDescription() : String
Returns the pageDescription of the product variant.
If the variant does not define an own value for 'pageDescription', the value is retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define a value for 'pageDescription', the value of the master product is returned.
Returns:
The pageDescription of the variant, variation group or master
getPageKeywords
getPageKeywords() : String
Returns the pageKeywords of the product variant.
If the variant does not define an own value for 'pageKeywords', the value is retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define a value for 'pageKeywords', the value of the master product is returned.
Returns:
The pageKeywords of the variant, variation group or master
getPageTitle
getPageTitle() : String
Returns the pageTitle of the product variant.
If the variant does not define an own value for 'pageTitle', the value is retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define a value for 'pageTitle', the value of the master product is returned.
Returns:
The pageTitle of the variant, variation group or master
getPageURL
getPageURL() : String
Returns the pageURL of the product variant.
If the variant does not define an own value for 'pageURL', the value is retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define a value for 'pageURL', the value of the master product is returned.
Returns:
The pageURL of the variant, variation group or master
getProductLinks
getProductLinks() : Collection
Returns all product links of the product variant for which the target product is assigned to the current site catalog.
If the variant does not define any product links, the product links are retrieved from the assigned variation groups, sorted by their position If none of the variation groups define any product links, the product links are retrieved from the master product.
Returns:
Product links of the variant, variation group or master
getProductLinks
getProductLinks(type : Number) : Collection
Returns all product links of the specified type of the product variant for which the target product is assigned to the current site catalog.
If the variant does not define any product links of the specified type, the product links are retrieved for the specified type from the assigned variation groups, sorted by their position If none of the variation groups define any product links of the specified type, the product links are retrieved for the specified type from the master product.
Parameters:
type - Type of the product link
Returns:
Product links of specified type of the variant, variation group or master
getRecommendations
getRecommendations(type : Number) : Collection
Retrieve the sorted collection of recommendations of the specified type for this product variant. The types (cross-sell, up-sell, etc) are enumerated in the dw.catalog.Recommendation class. Only recommendations which are stored in the current site catalog are returned. Furthermore, a recommendation is only returned if the target of the recommendation is assigned to the current site catalog.

If the variant does not define any recommendations, recommendations are retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define any recommendations, the recommendations of the master are returned.

Parameters:
type - the recommendation type
Returns:
the sorted collection, never null but possibly empty.
getShortDescription
getShortDescription() : MarkupText
Returns the short description of the product variant.
If the variant does not define an own value for 'shortDescription', the value is retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define a value for 'shortDescription', the value of the master product is returned.
Returns:
The short description of the variant, variation group or master
getTaxClassID
getTaxClassID() : String
Returns the tax class id of the product variant.
If the variant does not define an own value for 'taxClassID', the value is retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define a value for 'taxClassID', the value of the master product is returned.
Returns:
The tax class id of the variant, variation group or master
getTemplate
getTemplate() : String
Returns the rendering template name of the product variant.
If the variant does not define an own value for 'template', the value is retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define a value for 'template', the value of the master product is returned.
Returns:
The rendering template name of the variant, variation group or master
getThumbnail
getThumbnail() : MediaFile
Returns the thumbnail image of the product variant.
If the variant does not define an own value for 'thumbnail', the value is retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define a value for 'thumbnail', the value of the master product is returned.
Returns:
The thumbnail image of the variant, variation group or master
getUnit
getUnit() : String
Returns the sales unit of the product variant as defined by the master product.
If the variant does not define an own value for 'unit', the value is retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define a value for 'unit', the value of the master product is returned.
Returns:
The sales unit of the variant, variation group or master
getUnitQuantity
getUnitQuantity() : Quantity
Returns the unitQuantity of the product variant as defined by the master product.
If the variant does not define an own value for 'unitQuantity', the value is retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define a value for 'unitQuantity', the value of the master product is returned.
Returns:
The unitQuantity of the variant, variation group or master
getUPC
getUPC() : String
Returns the UPC of the product variant.
If the variant does not define an own value for 'UPC', the value is retrieved from the assigned variation groups, sorted by their position. If none of the variation groups define a value for 'UPC', the value of the master product is returned.
Returns:
The UPC of the variant, variation group or master
isOptionProduct
isOptionProduct() : boolean
Returns 'true' if the variant has any options, otherwise 'false'. Method also returns 'true' if the variant has not any options, but the related variation groups (sorted by position) or master product has options.
Returns:
true if the variant has any options, false otherwise.

Infocenter Retirement: On June 30, 2023, the Infocenter was retired, and documentation currently hosted on the Infocenter will be published to Salesforce Help, Commerce Cloud Developer Center, and Salesforce B2C Commerce Developer Documentation Resources. For more information, see the release note.