Class ProductPriceTable
dw.catalog
Class ProductPriceTable
Object
dw.catalog.ProductPriceTable
A ProductPriceTable is a map of quantities to prices representing the potentially tiered prices of a product in Commerce Cloud Digital. The price of a product is the price associated with the largest quantity in the ProductPriceTable which does not exceed the purchase quantity.
Properties
quantities  :  Collection  (Read Only)
All quantities stored in the price table.
Constructor Summary
This class does not have a constructor, so you cannot create it directly.
Method Summary
getNextQuantity(quantity : Quantity) : Quantity
Returns the quantity following the passed quantity in the price table.
getPercentage(quantity : Quantity) : Number
Returns the percentage off value of the price related to the passed quantity, calculated based on the price of the products minimum order quantity.
getPrice(quantity : Quantity) : Money
Returns the monetary price for the passed order quantity.
getPriceBook(quantity : Quantity) : PriceBook
Returns the price book which defined the monetary price for the passed order quantity.
getQuantities() : Collection
Returns all quantities stored in the price table.
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
getNextQuantity
getNextQuantity(quantity : Quantity) : Quantity
Returns the quantity following the passed quantity in the price table. If the passed quantity is the last entry in the price table, null is returned.
Parameters:
quantity - the quantity to use to locate the next quantity in the price table.
Returns:
the next quantity or null.
getPercentage
getPercentage(quantity : Quantity) : Number
Returns the percentage off value of the price related to the passed quantity, calculated based on the price of the products minimum order quantity.
Parameters:
quantity - the price quantity to compute the percentage off.
Returns:
the percentage off value of the price related to the passed quantity.
getPrice
getPrice(quantity : Quantity) : Money
Returns the monetary price for the passed order quantity. If no price is defined for the passed quantity, null is returned. This can happen if for example no price is defined for a single item.
Parameters:
quantity - the quantity to use to determine price.
Returns:
price amount for the passed quantity
getPriceBook
getPriceBook(quantity : Quantity) : PriceBook
Returns the price book which defined the monetary price for the passed order quantity. If no price is defined for the passed quantity, null is returned. This can happen if for example no price is defined for a single item.
Parameters:
quantity - the quantity to use to determine price.
Returns:
the price book defining this price, or null
getQuantities
getQuantities() : Collection
Returns all quantities stored in the price table.
Returns:
all price table quantities.