Salesforce B2C Commerce 24.7 > B2C Commerce API > B2C Commerce Script > dw.extensions.pinterest
dw.extensions.pinterest
Class PinterestProduct
Object
dw.extensions.pinterest.PinterestProduct
Represents a row in the Pinterest catalog feed export.
Constants
AVAILABILITY_IN_STOCK  :  String = "in stock"
Indicates that the product is in stock.
AVAILABILITY_OUT_OF_STOCK  :  String = "out of stock"
Indicates that the product is not in stock.
AVAILABILITY_PREORDER  :  String = "preorder"
Indicates that the product is availabile in preorder.
CONDITION_NEW  :  String = "new"
Indicates that the product has never been used.
CONDITION_REFURBISHED  :  String = "refurbished"
Indicates that the product has been used but refurbished.
CONDITION_USED  :  String = "used"
Indicates that the product has been used.
Properties
availability  :  String
The availability of the Pinterest product. Possible values are AVAILABILITY_IN_STOCK or AVAILABILITY_OUT_OF_STOCK.

brand  :  String
The Pinterest brand of the product.
color  :  String
The Pinterest color value label of the product.
colorHex  :  String
The Pinterest color hex value of the product.
colorImage  :  URL
The URL of the image to show in Pinterest for the product color (swatch).
condition  :  String
The condition of the Pinterest product. Possible values are CONDITION_NEW, CONDITION_REFURBISHED, or CONDITION_USED.
description  :  String
The Pinterest description of the product.
googleProductCategory  :  String
The category of this product in the Google category taxonomy.
gtin  :  String
The Pinterest GTIN of the product.
ID  :  String  (Read Only)
The ID of the Pinterest product. This is the same as the ID of the Demandware product.
imageLinks  :  List
A list containing the URLs of the image to show in Pinterest for the product.
itemGroupID  :  String
The ID of the Pinterest item group for the product, that is, its master product.
itemGroupLink  :  URL
The URL of the Pinterest item group for the product, that is, the link to its master product in the Demandware storefront.
link  :  URL
The URL of the Demandware storefront link to the product.
maxPrice  :  Money
The maximum price to show in Pinterest for the product.
minPrice  :  Money
The minimum price to show in Pinterest for the product.
price  :  Money
The price to show in Pinterest for the product.
productCategory  :  String
The Pinterest category path of the product.
returnPolicy  :  String
The Pinterest return policy of the product.
size  :  String
The Pinterest size value label of the product.
title  :  String
The Pinterest title of the product.
Constructor Summary
This class does not have a constructor, so you cannot create it directly.
Method Summary
getAvailability() : String
Returns the availability of the Pinterest product.
getBrand() : String
Returns the Pinterest brand of the product.
getColor() : String
Returns the Pinterest color value label of the product.
getColorHex() : String
Returns the Pinterest color hex value of the product.
getColorImage() : URL
Returns the URL of the image to show in Pinterest for the product color (swatch).
getCondition() : String
Returns the condition of the Pinterest product.
getDescription() : String
Returns the Pinterest description of the product.
getGoogleProductCategory() : String
Returns the category of this product in the Google category taxonomy.
getGtin() : String
Returns the Pinterest GTIN of the product.
getID() : String
Returns the ID of the Pinterest product.
getImageLinks() : List
Returns a list containing the URLs of the image to show in Pinterest for the product.
getItemGroupID() : String
Returns the ID of the Pinterest item group for the product, that is, its master product.
getItemGroupLink() : URL
Returns the URL of the Pinterest item group for the product, that is, the link to its master product in the Demandware storefront.
getLink() : URL
Returns the URL of the Demandware storefront link to the product.
getMaxPrice() : Money
Returns the maximum price to show in Pinterest for the product.
getMinPrice() : Money
Returns the minimum price to show in Pinterest for the product.
getPrice() : Money
Returns the price to show in Pinterest for the product.
getProductCategory() : String
Returns the Pinterest category path of the product.
getReturnPolicy() : String
Returns the Pinterest return policy of the product.
getSize() : String
Returns the Pinterest size value label of the product.
getTitle() : String
Returns the Pinterest title of the product.
setAvailability(availability : String) : void
Sets the availability of the Pinterest product.
setBrand(brand : String) : void
Sets the Pinterest brand of the product.
setColor(color : String) : void
Sets the Pinterest color value label of the product.
setColorHex(colorHex : String) : void
Sets the Pinterest color hex value of the product.
setColorImage(colorImage : URL) : void
Sets the URL of the image to show in Pinterest for the product color (swatch).
setCondition(condition : String) : void
Sets the condition of the Pinterest product.
setDescription(description : String) : void
Sets the Pinterest description of the product.
setGoogleProductCategory(googleProductCategory : String) : void
Sets the category of this product in the Google category taxonomy.
setGtin(gtin : String) : void
Sets the Pinterest GTIN of the product.
setImageLinks(imageLinks : List) : void
Sets the list of URLs of images to show in Pinterest for the product.
setItemGroupID(itemGroupID : String) : void
Sets the ID of the Pinterest item group for the product, that is, its master product.
setItemGroupLink(itemGroupLink : URL) : void
Sets the URL of the Pinterest item group for the product, that is, the link to its master product in the Demandware storefront.
setLink(link : URL) : void
Sets the URL of the Demandware storefront link to the product.
setMaxPrice(maxPrice : Money) : void
Sets the maximum price to show in Pinterest for the product.
setMinPrice(minPrice : Money) : void
Sets the minimum price to show in Pinterest for the product.
setPrice(price : Money) : void
Sets the price to show in Pinterest for the product.
setProductCategory(productCategory : String) : void
Sets the Pinterest category path of the product.
setReturnPolicy(returnPolicy : String) : void
Sets the Pinterest return policy of the product.
setSize(size : String) : void
Sets the Pinterest size value label of the product.
setTitle(title : String) : void
Sets the Pinterest title of the product.
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
getAvailability
getAvailability() : String
Returns the availability of the Pinterest product. Possible values are AVAILABILITY_IN_STOCK or AVAILABILITY_OUT_OF_STOCK.

getBrand
getBrand() : String
Returns the Pinterest brand of the product.
getColor
getColor() : String
Returns the Pinterest color value label of the product.
getColorHex
getColorHex() : String
Returns the Pinterest color hex value of the product.
getColorImage
getColorImage() : URL
Returns the URL of the image to show in Pinterest for the product color (swatch).
getCondition
getCondition() : String
Returns the condition of the Pinterest product. Possible values are CONDITION_NEW, CONDITION_REFURBISHED, or CONDITION_USED.
getDescription
getDescription() : String
Returns the Pinterest description of the product.
getGoogleProductCategory
getGoogleProductCategory() : String
Returns the category of this product in the Google category taxonomy.
getGtin
getGtin() : String
Returns the Pinterest GTIN of the product.
getID
getID() : String
Returns the ID of the Pinterest product. This is the same as the ID of the Demandware product.
Returns:
product ID
getImageLinks
getImageLinks() : List
Returns a list containing the URLs of the image to show in Pinterest for the product.
getItemGroupID
getItemGroupID() : String
Returns the ID of the Pinterest item group for the product, that is, its master product.
getItemGroupLink
getItemGroupLink() : URL
Returns the URL of the Pinterest item group for the product, that is, the link to its master product in the Demandware storefront.
getLink
getLink() : URL
Returns the URL of the Demandware storefront link to the product.
getMaxPrice
getMaxPrice() : Money
Returns the maximum price to show in Pinterest for the product.
getMinPrice
getMinPrice() : Money
Returns the minimum price to show in Pinterest for the product.
getPrice
getPrice() : Money
Returns the price to show in Pinterest for the product.
getProductCategory
getProductCategory() : String
Returns the Pinterest category path of the product.
getReturnPolicy
getReturnPolicy() : String
Returns the Pinterest return policy of the product.
getSize
getSize() : String
Returns the Pinterest size value label of the product.
getTitle
getTitle() : String
Returns the Pinterest title of the product.
setAvailability
setAvailability(availability : String) : void
Sets the availability of the Pinterest product. Possible values are AVAILABILITY_IN_STOCK or AVAILABILITY_OUT_OF_STOCK.

Parameters:
availability - the availability status to set for this product
setBrand
setBrand(brand : String) : void
Sets the Pinterest brand of the product.
Parameters:
brand - Pinterest brand
setColor
setColor(color : String) : void
Sets the Pinterest color value label of the product.
Parameters:
color - Pinterest color value label
setColorHex
setColorHex(colorHex : String) : void
Sets the Pinterest color hex value of the product.
Parameters:
colorHex - Pinterest color hex value
setColorImage
setColorImage(colorImage : URL) : void
Sets the URL of the image to show in Pinterest for the product color (swatch).
Parameters:
colorImage - link to Pinterest color image
setCondition
setCondition(condition : String) : void
Sets the condition of the Pinterest product. Possible values are CONDITION_NEW, CONDITION_REFURBISHED, or CONDITION_USED.

Parameters:
condition - the condition status to set for this product
setDescription
setDescription(description : String) : void
Sets the Pinterest description of the product.
Parameters:
description - Pinterest description
setGoogleProductCategory
setGoogleProductCategory(googleProductCategory : String) : void
Sets the category of this product in the Google category taxonomy.
Parameters:
googleProductCategory - Google product category
setGtin
setGtin(gtin : String) : void
Sets the Pinterest GTIN of the product.
Parameters:
gtin - Pinterest GTIN
setImageLinks
setImageLinks(imageLinks : List) : void
Sets the list of URLs of images to show in Pinterest for the product.
Parameters:
imageLinks - links to the product images
setItemGroupID
setItemGroupID(itemGroupID : String) : void
Sets the ID of the Pinterest item group for the product, that is, its master product.
Parameters:
itemGroupID - ID of Pinterest item group
setItemGroupLink
setItemGroupLink(itemGroupLink : URL) : void
Sets the URL of the Pinterest item group for the product, that is, the link to its master product in the Demandware storefront.
Parameters:
itemGroupLink - link to the Pinterest item group
setLink
setLink(link : URL) : void
Sets the URL of the Demandware storefront link to the product.
Parameters:
link - Demandware storefront link to the product
setMaxPrice
setMaxPrice(maxPrice : Money) : void
Sets the maximum price to show in Pinterest for the product.
Parameters:
maxPrice - Pinterest maximum price
setMinPrice
setMinPrice(minPrice : Money) : void
Sets the minimum price to show in Pinterest for the product.
Parameters:
minPrice - Pinterest minimum price
setPrice
setPrice(price : Money) : void
Sets the price to show in Pinterest for the product.
Parameters:
price - Pinterest price
setProductCategory
setProductCategory(productCategory : String) : void
Sets the Pinterest category path of the product.
Parameters:
productCategory - Pinterest category path
setReturnPolicy
setReturnPolicy(returnPolicy : String) : void
Sets the Pinterest return policy of the product.
Parameters:
returnPolicy - Pinterest return policy
setSize
setSize(size : String) : void
Sets the Pinterest size value label of the product.
Parameters:
size - Pinterest size value label
setTitle
setTitle(title : String) : void
Sets the Pinterest title of the product.
Parameters:
title - Pinterest title

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.