Class FacebookProduct

Represents a row in the Facebook catalog feed export.

Constant Summary 
ConstantDescription
AGE_GROUP_ADULT: String = “adult”Indicates that the product is for adults.
AGE_GROUP_INFANT: String = “infant”Indicates that the product is for infant children.
AGE_GROUP_KIDS: String = “kids”Indicates that the product is for children.
AGE_GROUP_NEWBORN: String = “newborn”Indicates that the product is for newborn children.
AGE_GROUP_TODDLER: String = “toddler”Indicates that the product is for toddler children.
AVAILABILITY_AVAILABLE_FOR_ORDER: String = “available for order”Indicates that the product can be ordered for later shipment.
AVAILABILITY_IN_STOCK: String = “in stock”Indicates that the product is available to ship immediately.
AVAILABILITY_OUT_OF_STOCK: String = “out of stock”Indicates that the product is out of stock.
AVAILABILITY_PREORDER: String = “preorder”Indicates that the product will be available in the future.
CONDITION_NEW: String = “new”Indicates that the product is new.
CONDITION_REFURBISHED: String = “refurbished”Indicates that the product is used but has been refurbished.
CONDITION_USED: String = “used”Indicates that the product has been used.
GENDER_FEMALE: String = “female”Indicates that the product is for females.
GENDER_MALE: String = “male”Indicates that the product is for males.
GENDER_UNISEX: String = “unisex”Indicates that the product is for both males and females.
SHIPPING_SIZE_UNIT_CM: String = “cm”Indicates that the product is measured in centimeters.
SHIPPING_SIZE_UNIT_FT: String = “ft”Indicates that the product is measured in feet.
SHIPPING_SIZE_UNIT_IN: String = “in”Indicates that the product is measured in inches.
SHIPPING_SIZE_UNIT_M: String = “m”Indicates that the product is measured in meters.
SHIPPING_WEIGHT_UNIT_G: String = “g”Indicates that the product is weighed in grams.
SHIPPING_WEIGHT_UNIT_KG: String = “kg”Indicates that the product is weighed in kilograms.
SHIPPING_WEIGHT_UNIT_LB: String = “lb”Indicates that the product is weighed in pounds.
SHIPPING_WEIGHT_UNIT_OZ: String = “oz”Indicates that the product is weighed in ounces.

Property Summary 
PropertyDescription
ID: String (read-only)Returns the ID of the Facebook product.
ageGroup: StringReturns the age group for the Facebook product.
availability: StringReturns the availability of the Facebook product.
brand: StringReturns the Facebook brand of the product.
color: StringReturns the Facebook color value label of the product.
condition: StringReturns the condition of the Facebook product.
customLabel0: StringReturns the Facebook custom label 0 value of the product.
customLabel1: StringReturns the Facebook custom label 1 value of the product.
customLabel2: StringReturns the Facebook custom label 2 value of the product.
customLabel3: StringReturns the Facebook custom label 3 value of the product.
customLabel4: StringReturns the Facebook custom label 4 value of the product.
description: StringReturns the description of the Facebook product.
expirationDate: DateReturns the Facebook expiration date of the product.
gender: StringReturns the gender for the Facebook product.
googleProductCategory: StringReturns the category of this product in the Google category taxonomy.
gtin: StringReturns the Facebook GTIN of the product.
imageLinks: ListReturns a list containing the URLs of the images to show in Facebook for the product.
itemGroupID: StringReturns the ID of the Facebook item group for the product, that is, its master product.
link: URLReturns the URL of the Demandware storefront link to the product.
material: StringReturns the Facebook material value label of the product.
mpn: StringReturns the Facebook MPN of the product.
pattern: StringReturns the Facebook pattern value label of the product.
price: MoneyReturns the price to show in Facebook for the product.
productType: StringReturns the Facebook product type.
salePrice: MoneyReturns the sale price to show in Facebook for the product.
salePriceEffectiveDateEnd: DateReturns the end date of the Facebook sale price of the product.
salePriceEffectiveDateStart: DateReturns the start date of the Facebook sale price of the product.
shippingHeight: NumberReturns the shipping height of the product.
shippingLength: NumberReturns the shipping length of the product.
shippingSizeUnit: StringReturns the shipping size unit of the product.
shippingWeight: QuantityReturns the shipping weight for the product.
shippingWidth: NumberReturns the shipping width of the product.
size: StringReturns the Facebook size value label of the product.
title: StringReturns the title of the Facebook product.

Constructor Summary 

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

Method Summary 
MethodDescription
getAgeGroup()Returns the age group for the Facebook product.
getAvailability()Returns the availability of the Facebook product.
getBrand()Returns the Facebook brand of the product.
getColor()Returns the Facebook color value label of the product.
getCondition()Returns the condition of the Facebook product.
getCustomLabel0()Returns the Facebook custom label 0 value of the product.
getCustomLabel1()Returns the Facebook custom label 1 value of the product.
getCustomLabel2()Returns the Facebook custom label 2 value of the product.
getCustomLabel3()Returns the Facebook custom label 3 value of the product.
getCustomLabel4()Returns the Facebook custom label 4 value of the product.
getDescription()Returns the description of the Facebook product.
getExpirationDate()Returns the Facebook expiration date of the product.
getGender()Returns the gender for the Facebook product.
getGoogleProductCategory()Returns the category of this product in the Google category taxonomy.
getGtin()Returns the Facebook GTIN of the product.
getID()Returns the ID of the Facebook product.
getImageLinks()Returns a list containing the URLs of the images to show in Facebook for the product.
getItemGroupID()Returns the ID of the Facebook item group for the product, that is, its master product.
getLink()Returns the URL of the Demandware storefront link to the product.
getMaterial()Returns the Facebook material value label of the product.
getMpn()Returns the Facebook MPN of the product.
getPattern()Returns the Facebook pattern value label of the product.
getPrice()Returns the price to show in Facebook for the product.
getProductType()Returns the Facebook product type.
getSalePrice()Returns the sale price to show in Facebook for the product.
getSalePriceEffectiveDateEnd()Returns the end date of the Facebook sale price of the product.
getSalePriceEffectiveDateStart()Returns the start date of the Facebook sale price of the product.
getShippingHeight()Returns the shipping height of the product.
getShippingLength()Returns the shipping length of the product.
getShippingSizeUnit()Returns the shipping size unit of the product.
getShippingWeight()Returns the shipping weight for the product.
getShippingWidth()Returns the shipping width of the product.
getSize()Returns the Facebook size value label of the product.
getTitle()Returns the title of the Facebook product.
setAgeGroup(String)Sets the age group for the Facebook product.
setAvailability(String)Sets the availability of the Facebook product.
setBrand(String)Sets the Facebook brand of the product.
setColor(String)Sets the Facebook color value label of the product.
setCondition(String)Sets the condition of the Facebook product.
setCustomLabel0(String)Sets the Facebook custom label 0 value of the product.
setCustomLabel1(String)Sets the Facebook custom label 1 value of the product.
setCustomLabel2(String)Sets the Facebook custom label 2 value of the product.
setCustomLabel3(String)Sets the Facebook custom label 3 value of the product.
setCustomLabel4(String)Sets the Facebook custom label 4 value of the product.
setDescription(String)Sets the description of the Facebook product.
setExpirationDate(Date)Sets the Facebook expiration date of the product.
setGender(String)Sets the gender for the Facebook product.
setGoogleProductCategory(String)Sets the category of this product in the Google category taxonomy.
setGtin(String)Sets the Facebook GTIN of the product.
setImageLinks(List)Sets the list of URLs of images to show in Facebook for the product.
setItemGroupID(String)Sets the ID of the Facebook item group for the product, that is, its master product.
setLink(URL)Sets the URL of the Demandware storefront link to the product.
setMaterial(String)Sets the Facebook material value label of the product.
setMpn(String)Sets the Facebook MPN of the product.
setPattern(String)Sets the Facebook pattern value label of the product.
setPrice(Money)Sets the price to show in Facebook for the product.
setProductType(String)Sets the Facebook product type.
setSalePrice(Money)Sets the sale price to show in Facebook for the product.
setSalePriceEffectiveDateEnd(Date)Sets the end date of the Facebook sale price of the product.
setSalePriceEffectiveDateStart(Date)Sets the start date of the Facebook sale price of the product.
setShippingHeight(Number)Sets the shipping height of the product.
setShippingLength(Number)Sets the shipping length of the product.
setShippingSizeUnit(String)Sets the shipping size unit of the product.
setShippingWeight(Quantity)Sets the shipping weight for the product.
setShippingWidth(Number)Sets the shipping width of the product.
setSize(String)Sets the Facebook size value label of the product.
setTitle(String)Sets the title of the Facebook 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 

AGE_GROUP_ADULT 
AGE_GROUP_ADULT: String = "adult"

Indicates that the product is for adults.

AGE_GROUP_INFANT 
AGE_GROUP_INFANT: String = "infant"

Indicates that the product is for infant children.

AGE_GROUP_KIDS 
AGE_GROUP_KIDS: String = "kids"

Indicates that the product is for children.

AGE_GROUP_NEWBORN 
AGE_GROUP_NEWBORN: String = "newborn"

Indicates that the product is for newborn children.

AGE_GROUP_TODDLER 
AGE_GROUP_TODDLER: String = "toddler"

Indicates that the product is for toddler children.

AVAILABILITY_AVAILABLE_FOR_ORDER 
AVAILABILITY_AVAILABLE_FOR_ORDER: String = "available for order"

Indicates that the product can be ordered for later shipment.

AVAILABILITY_IN_STOCK 
AVAILABILITY_IN_STOCK: String = "in stock"

Indicates that the product is available to ship immediately.

AVAILABILITY_OUT_OF_STOCK 
AVAILABILITY_OUT_OF_STOCK: String = "out of stock"

Indicates that the product is out of stock.

AVAILABILITY_PREORDER 
AVAILABILITY_PREORDER: String = "preorder"

Indicates that the product will be available in the future.

CONDITION_NEW 
CONDITION_NEW: String = "new"

Indicates that the product is new.

CONDITION_REFURBISHED 
CONDITION_REFURBISHED: String = "refurbished"

Indicates that the product is used but has been refurbished.

CONDITION_USED 
CONDITION_USED: String = "used"

Indicates that the product has been used.

GENDER_FEMALE 
GENDER_FEMALE: String = "female"

Indicates that the product is for females.

GENDER_MALE 
GENDER_MALE: String = "male"

Indicates that the product is for males.

GENDER_UNISEX 
GENDER_UNISEX: String = "unisex"

Indicates that the product is for both males and females.

SHIPPING_SIZE_UNIT_CM 
SHIPPING_SIZE_UNIT_CM: String = "cm"

Indicates that the product is measured in centimeters.

SHIPPING_SIZE_UNIT_FT 
SHIPPING_SIZE_UNIT_FT: String = "ft"

Indicates that the product is measured in feet.

SHIPPING_SIZE_UNIT_IN 
SHIPPING_SIZE_UNIT_IN: String = "in"

Indicates that the product is measured in inches.

SHIPPING_SIZE_UNIT_M 
SHIPPING_SIZE_UNIT_M: String = "m"

Indicates that the product is measured in meters.

SHIPPING_WEIGHT_UNIT_G 
SHIPPING_WEIGHT_UNIT_G: String = "g"

Indicates that the product is weighed in grams.

SHIPPING_WEIGHT_UNIT_KG 
SHIPPING_WEIGHT_UNIT_KG: String = "kg"

Indicates that the product is weighed in kilograms.

SHIPPING_WEIGHT_UNIT_LB 
SHIPPING_WEIGHT_UNIT_LB: String = "lb"

Indicates that the product is weighed in pounds.

SHIPPING_WEIGHT_UNIT_OZ 
SHIPPING_WEIGHT_UNIT_OZ: String = "oz"

Indicates that the product is weighed in ounces.

Property Details 

ID 
ID: String (read-only)

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

ageGroup 
ageGroup: String

Returns the age group for the Facebook product.

availability 
availability: String

Returns the availability of the Facebook product.

brand 
brand: String

Returns the Facebook brand of the product.

color 
color: String

Returns the Facebook color value label of the product.

condition 
condition: String

Returns the condition of the Facebook product.

customLabel0 
customLabel0: String

Returns the Facebook custom label 0 value of the product.

customLabel1 
customLabel1: String

Returns the Facebook custom label 1 value of the product.

customLabel2 
customLabel2: String

Returns the Facebook custom label 2 value of the product.

customLabel3 
customLabel3: String

Returns the Facebook custom label 3 value of the product.

customLabel4 
customLabel4: String

Returns the Facebook custom label 4 value of the product.

description 
description: String

Returns the description of the Facebook product.

expirationDate 
expirationDate: Date

Returns the Facebook expiration date of the product. If the product is expired it will not be shown.

gender 
gender: String

Returns the gender for the Facebook product.

googleProductCategory 
googleProductCategory: String

Returns the category of this product in the Google category taxonomy. If the value is longer than 250 characters it is truncated.

gtin 
gtin: String

Returns the Facebook GTIN of the product.

imageLinks 
imageLinks: List

Returns a list containing the URLs of the images to show in Facebook for the product.

itemGroupID 
itemGroupID: String

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

link 
link: URL

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

material 
material: String

Returns the Facebook material value label of the product.

mpn 
mpn: String

Returns the Facebook MPN of the product.

pattern 
pattern: String

Returns the Facebook pattern value label of the product.

price 
price: Money

Returns the price to show in Facebook for the product.

productType 
productType: String

Returns the Facebook product type. This is the retailer-defined category of the item.

salePrice 
salePrice: Money

Returns the sale price to show in Facebook for the product.

salePriceEffectiveDateEnd 
salePriceEffectiveDateEnd: Date

Returns the end date of the Facebook sale price of the product.

salePriceEffectiveDateStart 
salePriceEffectiveDateStart: Date

Returns the start date of the Facebook sale price of the product.

shippingHeight 
shippingHeight: Number

Returns the shipping height of the product.

See Also:

shippingLength 
shippingLength: Number

Returns the shipping length of the product.

See Also:

shippingSizeUnit 
shippingSizeUnit: String

Returns the shipping size unit of the product.

See Also:

shippingWeight 
shippingWeight: Quantity

Returns the shipping weight for the product.

shippingWidth 
shippingWidth: Number

Returns the shipping width of the product.

See Also:

size 
size: String

Returns the Facebook size value label of the product.

title 
title: String

Returns the title of the Facebook product.

Method Details 

getAgeGroup() 
getAgeGroup(): String

Returns the age group for the Facebook product.

Returns:

  • product age group

getAvailability() 
getAvailability(): String

Returns the availability of the Facebook product.

Returns:

  • product availability

getBrand() 
getBrand(): String

Returns the Facebook brand of the product.

Returns:

  • the brand

getColor() 
getColor(): String

Returns the Facebook color value label of the product.

Returns:

  • the color value label

getCondition() 
getCondition(): String

Returns the condition of the Facebook product.

Returns:

  • product condition

getCustomLabel0() 
getCustomLabel0(): String

Returns the Facebook custom label 0 value of the product.

Returns:

  • the custom label 0 value

getCustomLabel1() 
getCustomLabel1(): String

Returns the Facebook custom label 1 value of the product.

Returns:

  • the custom label 1 value

getCustomLabel2() 
getCustomLabel2(): String

Returns the Facebook custom label 2 value of the product.

Returns:

  • the custom label 2 value

getCustomLabel3() 
getCustomLabel3(): String

Returns the Facebook custom label 3 value of the product.

Returns:

  • the custom label 3 value

getCustomLabel4() 
getCustomLabel4(): String

Returns the Facebook custom label 4 value of the product.

Returns:

  • the custom label 4 value

getDescription() 
getDescription(): String

Returns the description of the Facebook product.

Returns:

  • product description

getExpirationDate() 
getExpirationDate(): Date

Returns the Facebook expiration date of the product. If the product is expired it will not be shown.

Returns:

  • the expiration date

getGender() 
getGender(): String

Returns the gender for the Facebook product.

Returns:

  • product gender

getGoogleProductCategory() 
getGoogleProductCategory(): String

Returns the category of this product in the Google category taxonomy. If the value is longer than 250 characters it is truncated.

Returns:

  • the category of this product in the Google category taxonomy

getGtin() 
getGtin(): String

Returns the Facebook GTIN of the product.

Returns:

  • the GTIN

getID() 
getID(): String

Returns the ID of the Facebook 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 images to show in Facebook for the product.

Returns:

  • the URLs of the images

getItemGroupID() 
getItemGroupID(): String

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

Returns:

  • the ID of the Facebook item group

getLink() 
getLink(): URL

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

Returns:

  • the URL of the storefront link

getMaterial() 
getMaterial(): String

Returns the Facebook material value label of the product.

Returns:

  • the material value label

getMpn() 
getMpn(): String

Returns the Facebook MPN of the product.

Returns:

  • the MPN

getPattern() 
getPattern(): String

Returns the Facebook pattern value label of the product.

Returns:

  • the pattern value label

getPrice() 
getPrice(): Money

Returns the price to show in Facebook for the product.

Returns:

  • the price to show in Facebook

getProductType() 
getProductType(): String

Returns the Facebook product type. This is the retailer-defined category of the item.

Returns:

  • the Facebook product type

getSalePrice() 
getSalePrice(): Money

Returns the sale price to show in Facebook for the product.

Returns:

  • the sale price to show in Facebook

getSalePriceEffectiveDateEnd() 
getSalePriceEffectiveDateEnd(): Date

Returns the end date of the Facebook sale price of the product.

Returns:

  • the end date of the Facebook sale price

getSalePriceEffectiveDateStart() 
getSalePriceEffectiveDateStart(): Date

Returns the start date of the Facebook sale price of the product.

Returns:

  • the start date of the Facebook sale price

getShippingHeight() 
getShippingHeight(): Number

Returns the shipping height of the product.

Returns:

  • the shipping height

See Also:

getShippingLength() 
getShippingLength(): Number

Returns the shipping length of the product.

Returns:

  • the shipping length

See Also:

getShippingSizeUnit() 
getShippingSizeUnit(): String

Returns the shipping size unit of the product.

Returns:

  • the shipping size unit

See Also:

getShippingWeight() 
getShippingWeight(): Quantity

Returns the shipping weight for the product.

Returns:

  • the shipping weight

getShippingWidth() 
getShippingWidth(): Number

Returns the shipping width of the product.

Returns:

  • the shipping width

See Also:

getSize() 
getSize(): String

Returns the Facebook size value label of the product.

Returns:

  • the size value label

getTitle() 
getTitle(): String

Returns the title of the Facebook product.

Returns:

  • product title

setAgeGroup(String) 
setAgeGroup(ageGroup: String): void

Sets the age group for the Facebook product. Possible values are AGE_GROUP_ADULT, AGE_GROUP_INFANT, AGE_GROUP_KIDS, AGE_GROUP_NEWBORN, AGE_GROUP_TODDLER, or null.

Parameters:

  • ageGroup - the ageGroup to set for this product

setAvailability(String) 
setAvailability(availability: String): void

Sets the availability of the Facebook product. Possible values are AVAILABILITY_AVAILABLE_FOR_ORDER, AVAILABILITY_IN_STOCK, AVAILABILITY_OUT_OF_STOCK, or AVAILABILITY_PREORDER

Parameters:

  • availability - the availability status to set for this product

setBrand(String) 
setBrand(brand: String): void

Sets the Facebook brand of the product. If the value is longer than 70 characters it is truncated.

Parameters:

  • brand - Facebook brand, up to 70 characters

setColor(String) 
setColor(color: String): void

Sets the Facebook color value label of the product. If the value is longer than 100 characters it is truncated.

Parameters:

  • color - Facebook color value label, up to 100 characters

setCondition(String) 
setCondition(condition: String): void

Sets the condition of the Facebook product. Possible values are CONDITION_NEW, CONDITION_REFURBISHED, or CONDITION_USED.

Parameters:

  • condition - the condition status to set for this product

setCustomLabel0(String) 
setCustomLabel0(customLabel0: String): void

Sets the Facebook custom label 0 value of the product.

Parameters:

  • customLabel0 - custom label 0 value

setCustomLabel1(String) 
setCustomLabel1(customLabel1: String): void

Sets the Facebook custom label 1 value of the product.

Parameters:

  • customLabel1 - custom label 1 value

setCustomLabel2(String) 
setCustomLabel2(customLabel2: String): void

Sets the Facebook custom label 2 value of the product.

Parameters:

  • customLabel2 - custom label 2 value

setCustomLabel3(String) 
setCustomLabel3(customLabel3: String): void

Sets the Facebook custom label 3 value of the product.

Parameters:

  • customLabel3 - custom label 3 value

setCustomLabel4(String) 
setCustomLabel4(customLabel4: String): void

Sets the Facebook custom label 4 value of the product.

Parameters:

  • customLabel4 - custom label 4 value

setDescription(String) 
setDescription(description: String): void

Sets the description of the Facebook product. If the value is longer than 5000 characters it is truncated.

Parameters:

  • description - product description, up to 5000 characters

setExpirationDate(Date) 
setExpirationDate(expirationDate: Date): void

Sets the Facebook expiration date of the product.

Parameters:

  • expirationDate - Facebook expiration date

setGender(String) 
setGender(gender: String): void

Sets the gender for the Facebook product. Possible values are GENDER_MALE, GENDER_FEMALE, GENDER_UNISEX, or null.

Parameters:

  • gender - the gender to set for this product

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 Facebook GTIN of the product. If the value is longer than 70 characters it is truncated.

Parameters:

  • gtin - Facebook GTIN, up to 70 characters

setImageLinks(List) 
setImageLinks(imageLinks: List): void

Sets the list of URLs of images to show in Facebook for the product.

Parameters:

  • imageLinks - links to the product images

setItemGroupID(String) 
setItemGroupID(itemGroupID: String): void

Sets the ID of the Facebook item group for the product, that is, its master product.

Parameters:

  • itemGroupID - ID of Facebook 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

setMaterial(String) 
setMaterial(material: String): void

Sets the Facebook material value label of the product. If the value is longer than 200 characters it is truncated.

Parameters:

  • material - Facebook material value label, up to 200 characters

setMpn(String) 
setMpn(mpn: String): void

Sets the Facebook MPN of the product. If the value is longer than 70 characters it is truncated.

Parameters:

  • mpn - Facebook MPN, up to 70 characters

setPattern(String) 
setPattern(pattern: String): void

Sets the Facebook pattern value label of the product. If the value is longer than 100 characters it is truncated.

Parameters:

  • pattern - Facebook pattern value label, up to 100 characters

setPrice(Money) 
setPrice(price: Money): void

Sets the price to show in Facebook for the product.

Parameters:

  • price - Facebook price

setProductType(String) 
setProductType(productType: String): void

Sets the Facebook product type. If the value is longer than 750 characters it is truncated.

Parameters:

  • productType - Facebook product type, up to 750 characters

setSalePrice(Money) 
setSalePrice(salePrice: Money): void

Sets the sale price to show in Facebook for the product.

Parameters:

  • salePrice - Facebook sale price

setSalePriceEffectiveDateEnd(Date) 
setSalePriceEffectiveDateEnd(salePriceEffectiveDateEnd: Date): void

Sets the end date of the Facebook sale price of the product.

Parameters:

  • salePriceEffectiveDateEnd - end date of Facebook sale price

setSalePriceEffectiveDateStart(Date) 
setSalePriceEffectiveDateStart(salePriceEffectiveDateStart: Date): void

Sets the start date of the Facebook sale price of the product.

Parameters:

  • salePriceEffectiveDateStart - start date of Facebook sale price

setShippingHeight(Number) 
setShippingHeight(shippingHeight: Number): void

Sets the shipping height of the product. If the value is negative it is truncated to 0.

Parameters:

  • shippingHeight - shipping height, may not be negative

See Also:

setShippingLength(Number) 
setShippingLength(shippingLength: Number): void

Sets the shipping length of the product. If the value is negative it is truncated to 0.

Parameters:

  • shippingLength - shipping length, may not be negative

See Also:

setShippingSizeUnit(String) 
setShippingSizeUnit(shippingSizeUnit: String): void

Sets the shipping size unit of the product.

Parameters:

  • shippingSizeUnit - shipping size unit

See Also:

setShippingWeight(Quantity) 
setShippingWeight(shippingWeight: Quantity): void

Sets the shipping weight for the product. Possible unit values are SHIPPING_WEIGHT_UNIT_LB, SHIPPING_WEIGHT_UNIT_OZ, SHIPPING_WEIGHT_UNIT_G, or SHIPPING_WEIGHT_UNIT_KG.

Parameters:

  • shippingWeight - product shipping weight

setShippingWidth(Number) 
setShippingWidth(shippingWidth: Number): void

Sets the shipping width of the product. If the value is negative it is truncated to 0.

Parameters:

  • shippingWidth - shipping width, may not be negative

See Also:

setSize(String) 
setSize(size: String): void

Sets the Facebook size value label of the product. If the value is longer than 100 characters it is truncated.

Parameters:

  • size - Facebook size value label, up to 100 characters

setTitle(String) 
setTitle(title: String): void

Sets the title of the Facebook product. If the value is longer than 100 characters it is truncated.

Parameters:

  • title - product title, up to 100 characters

Open Commerce API (deprecated)
Shop Baskets (deprecated)
Shop Categories (deprecated)
Shop Content (deprecated)
Shop Content Search (deprecated)
Shop Custom Objects (deprecated)
Shop Customers (deprecated)
Shop Folders (deprecated)
Shop Gift Certificate (deprecated)
Shop Order Search (deprecated)
Shop Orders (deprecated)
Shop Price Adjustment Limits (deprecated)
Shop Product Lists (deprecated)
Shop Product Search (deprecated)
Shop Products (deprecated)
Shop Promotions (deprecated)
Shop Search Suggestion (deprecated)
Shop Sessions (deprecated)
Shop Site (deprecated)
Shop Stores (deprecated)
Data A/B Test Search (deprecated)
Data A/B Tests (deprecated)
Data Alerts (deprecated)
Data Campaign Search (deprecated)
Data Campaigns (deprecated)
Data Cartridges (deprecated)
Data Catalog Search (deprecated)
Data Catalogs (deprecated)
Data Category Search (deprecated)
Data Code Versions (deprecated)
Data Coupon Redemption Search (deprecated)
Data Coupon Search (deprecated)
Data Coupons (deprecated)
Data Custom Object Definitions (deprecated)
Data Custom Objects (deprecated)
Data Custom Objects Search (deprecated)
Data Customer Group Search (deprecated)
Data Customer Groups (deprecated)
Data Customer Lists (deprecated)
Data Gift Certificate Search (deprecated)
Data Gift Certificates (deprecated)
Data Global Custom Objects (deprecated)
Data Global Locale Info (deprecated)
Data Global Preferences (deprecated)
Data Global Site Preferences (deprecated)
Data Inventory List Search (deprecated)
Data Inventory Lists (deprecated)
Data Job Execution Search (deprecated)
Data Jobs (deprecated)
Data Libraries (deprecated)
Data Locale Info (deprecated)
Data Log Requests (deprecated)
Data Metrics (deprecated)
Data OCAPI Configs (deprecated)
Data Orders (deprecated)
Data Permissions (deprecated)
Data Product Search (deprecated)
Data Products (deprecated)
Data Promotion Campaign Assignment Search (deprecated)
Data Promotion Search (deprecated)
Data Promotions (deprecated)
Data Recommender Names (deprecated)
Data Role Search (deprecated)
Data Roles (deprecated)
Data Settings (deprecated)
Data Site Preferences (deprecated)
Data Site Search (deprecated)
Data Sites (deprecated)
Data Slot Configuration Campaign Assignment Search (deprecated)
Data Slot Configuration Search (deprecated)
Data Slot Configurations (deprecated)
Data Slot Search (deprecated)
Data Slots (deprecated)
Data Sorting Rule Search (deprecated)
Data Source Code Group Search (deprecated)
Data Source Code Groups (deprecated)
Data Store Search (deprecated)
Data Stores (deprecated)
Data System Object Definition Search (deprecated)
Data System Object Definitions (deprecated)
Data User Search (deprecated)
Data Users (deprecated)
Script API
B2C Commerce Script API 26.4
TopLevel
dw.alert
dw.campaign
dw.catalog
dw.content
dw.crypto
dw.customer
dw.customer.oauth
dw.customer.shoppercontext
dw.experience
dw.experience.cms
dw.experience.image
dw.extensions.applepay
dw.extensions.facebook
FacebookFeedHooks
FacebookProduct
dw.extensions.paymentapi
dw.extensions.paymentrequest
dw.extensions.payments
dw.extensions.pinterest
dw.io
dw.job
dw.net
dw.object
dw.order
dw.order.hooks
dw.rpc
dw.sitemap
dw.suggest
dw.svc
dw.system
dw.template
dw.util
dw.value
dw.web
dw.ws
B2C Commerce Developer Sandbox REST API

DID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!