Class PinterestProduct

Represents a row in the Pinterest catalog feed export.

Constant Summary 

ConstantDescription
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.

Property Summary 

PropertyDescription
ID: String (read-only)Returns the ID of the Pinterest product.
availability: StringReturns the availability of the Pinterest product.
brand: StringReturns the Pinterest brand of the product.
color: StringReturns the Pinterest color value label of the product.
colorHex: StringReturns the Pinterest color hex value of the product.
colorImage: URLReturns the URL of the image to show in Pinterest for the product color (swatch).
condition: StringReturns the condition of the Pinterest product.
description: StringReturns the Pinterest description of the product.
googleProductCategory: StringReturns the category of this product in the Google category taxonomy.
gtin: StringReturns the Pinterest GTIN of the product.
imageLinks: ListReturns a list containing the URLs of the image to show in Pinterest for the product.
itemGroupID: StringReturns the ID of the Pinterest item group for the product, that is, its master product.
itemGroupLink: URLReturns the URL of the Pinterest item group for the product, that is, the link to its master product in the Demandware storefront.
link: URLReturns the URL of the Demandware storefront link to the product.
maxPrice: MoneyReturns the maximum price to show in Pinterest for the product.
minPrice: MoneyReturns the minimum price to show in Pinterest for the product.
price: MoneyReturns the price to show in Pinterest for the product.
productCategory: StringReturns the Pinterest category path of the product.
returnPolicy: StringReturns the Pinterest return policy of the product.
size: StringReturns the Pinterest size value label of the product.
title: StringReturns the Pinterest title of the product.

Constructor Summary 

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

Method Summary 

MethodDescription
getAvailability()Returns the availability of the Pinterest product.
getBrand()Returns the Pinterest brand of the product.
getColor()Returns the Pinterest color value label of the product.
getColorHex()Returns the Pinterest color hex value of the product.
getColorImage()Returns the URL of the image to show in Pinterest for the product color (swatch).
getCondition()Returns the condition of the Pinterest product.
getDescription()Returns the Pinterest description of the product.
getGoogleProductCategory()Returns the category of this product in the Google category taxonomy.
getGtin()Returns the Pinterest GTIN of the product.
getID()Returns the ID of the Pinterest product.
getImageLinks()Returns a list containing the URLs of the image to show in Pinterest for the product.
getItemGroupID()Returns the ID of the Pinterest item group for the product, that is, its master product.
getItemGroupLink()Returns the URL of the Pinterest item group for the product, that is, the link to its master product in the Demandware storefront.
getLink()Returns the URL of the Demandware storefront link to the product.
getMaxPrice()Returns the maximum price to show in Pinterest for the product.
getMinPrice()Returns the minimum price to show in Pinterest for the product.
getPrice()Returns the price to show in Pinterest for the product.
getProductCategory()Returns the Pinterest category path of the product.
getReturnPolicy()Returns the Pinterest return policy of the product.
getSize()Returns the Pinterest size value label of the product.
getTitle()Returns the Pinterest title of the product.
setAvailability(String)Sets the availability of the Pinterest product.
setBrand(String)Sets the Pinterest brand of the product.
setColor(String)Sets the Pinterest color value label of the product.
setColorHex(String)Sets the Pinterest color hex value of the product.
setColorImage(URL)Sets the URL of the image to show in Pinterest for the product color (swatch).
setCondition(String)Sets the condition of the Pinterest product.
setDescription(String)Sets the Pinterest description of the product.
setGoogleProductCategory(String)Sets the category of this product in the Google category taxonomy.
setGtin(String)Sets the Pinterest GTIN of the product.
setImageLinks(List)Sets the list of URLs of images to show in Pinterest for the product.
setItemGroupID(String)Sets the ID of the Pinterest item group for the product, that is, its master product.
setItemGroupLink(URL)Sets the URL of the Pinterest item group for the product, that is, the link to its master product in the Demandware storefront.
setLink(URL)Sets the URL of the Demandware storefront link to the product.
setMaxPrice(Money)Sets the maximum price to show in Pinterest for the product.
setMinPrice(Money)Sets the minimum price to show in Pinterest for the product.
setPrice(Money)Sets the price to show in Pinterest for the product.
setProductCategory(String)Sets the Pinterest category path of the product.
setReturnPolicy(String)Sets the Pinterest return policy of the product.
setSize(String)Sets the Pinterest size value label of the product.
setTitle(String)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

Constant Details 

AVAILABILITY_IN_STOCK 

AVAILABILITY_IN_STOCK: String = "in stock"

Indicates that the product is in stock.


AVAILABILITY_OUT_OF_STOCK 

AVAILABILITY_OUT_OF_STOCK: String = "out of stock"

Indicates that the product is not in stock.


AVAILABILITY_PREORDER 

AVAILABILITY_PREORDER: String = "preorder"

Indicates that the product is availabile in preorder.


CONDITION_NEW 

CONDITION_NEW: String = "new"

Indicates that the product has never been used.


CONDITION_REFURBISHED 

CONDITION_REFURBISHED: String = "refurbished"

Indicates that the product has been used but refurbished.


CONDITION_USED 

CONDITION_USED: String = "used"

Indicates that the product has been used.


Property Details 

ID 

ID: String (read-only)

Returns the ID of the Pinterest product. This is the same as the ID of the Demandware product.


availability 

availability: String

Returns the availability of the Pinterest product. Possible values are AVAILABILITY_IN_STOCK or AVAILABILITY_OUT_OF_STOCK.


brand 

brand: String

Returns the Pinterest brand of the product.


color 

color: String

Returns the Pinterest color value label of the product.


colorHex 

colorHex: String

Returns the Pinterest color hex value of the product.


colorImage 

colorImage: URL

Returns the URL of the image to show in Pinterest for the product color (swatch).


condition 

condition: String

Returns the condition of the Pinterest product. Possible values are CONDITION_NEW, CONDITION_REFURBISHED, or CONDITION_USED.


description 

description: String

Returns the Pinterest description of the product.


googleProductCategory 

googleProductCategory: String

Returns the category of this product in the Google category taxonomy.


gtin 

gtin: String

Returns the Pinterest GTIN of the product.


imageLinks 

imageLinks: List

Returns a list containing the URLs of the image to show in Pinterest for the product.


itemGroupID 

itemGroupID: String

Returns the ID of the Pinterest item group for the product, that is, its master product.


itemGroupLink 

itemGroupLink: URL

Returns the URL of the Pinterest item group for the product, that is, the link to its master product in the Demandware storefront.


link 

link: URL

Returns the URL of the Demandware storefront link to the product.


maxPrice 

maxPrice: Money

Returns the maximum price to show in Pinterest for the product.


minPrice 

minPrice: Money

Returns the minimum price to show in Pinterest for the product.


price 

price: Money

Returns the price to show in Pinterest for the product.


productCategory 

productCategory: String

Returns the Pinterest category path of the product.


returnPolicy 

returnPolicy: String

Returns the Pinterest return policy of the product.


size 

size: String

Returns the Pinterest size value label of the product.


title 

title: String

Returns the Pinterest title of the product.


Method Details 

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(String) 

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(String) 

setBrand(brand: String): void

Sets the Pinterest brand of the product.

Parameters:

  • brand - Pinterest brand

setColor(String) 

setColor(color: String): void

Sets the Pinterest color value label of the product.

Parameters:

  • color - Pinterest color value label

setColorHex(String) 

setColorHex(colorHex: String): void

Sets the Pinterest color hex value of the product.

Parameters:

  • colorHex - Pinterest color hex value

setColorImage(URL) 

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(String) 

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(String) 

setDescription(description: String): void

Sets the Pinterest description of the product.

Parameters:

  • description - Pinterest description

setGoogleProductCategory(String) 

setGoogleProductCategory(googleProductCategory: String): void

Sets the category of this product in the Google category taxonomy.

Parameters:

  • googleProductCategory - Google product category

setGtin(String) 

setGtin(gtin: String): void

Sets the Pinterest GTIN of the product.

Parameters:

  • gtin - Pinterest GTIN

setImageLinks(List) 

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(String) 

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(URL) 

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(URL) 

setLink(link: URL): void

Sets the URL of the Demandware storefront link to the product.

Parameters:

  • link - Demandware storefront link to the product

setMaxPrice(Money) 

setMaxPrice(maxPrice: Money): void

Sets the maximum price to show in Pinterest for the product.

Parameters:

  • maxPrice - Pinterest maximum price

setMinPrice(Money) 

setMinPrice(minPrice: Money): void

Sets the minimum price to show in Pinterest for the product.

Parameters:

  • minPrice - Pinterest minimum price

setPrice(Money) 

setPrice(price: Money): void

Sets the price to show in Pinterest for the product.

Parameters:

  • price - Pinterest price

setProductCategory(String) 

setProductCategory(productCategory: String): void

Sets the Pinterest category path of the product.

Parameters:

  • productCategory - Pinterest category path

setReturnPolicy(String) 

setReturnPolicy(returnPolicy: String): void

Sets the Pinterest return policy of the product.

Parameters:

  • returnPolicy - Pinterest return policy

setSize(String) 

setSize(size: String): void

Sets the Pinterest size value label of the product.

Parameters:

  • size - Pinterest size value label

setTitle(String) 

setTitle(title: String): void

Sets the Pinterest title of the product.

Parameters:

  • title - Pinterest title