dw.catalog
Class ProductPriceInfo
dw.catalog.ProductPriceInfoSimple class representing a product price point. This class is useful
because it provides additional information beyond just the price. Since the
system calculates sales prices based on applicable price books, it is
sometimes useful to know additional information such as which price book
defined a price point, what percentage discount off the base price
this value represents, and the date range for which this price point is active.
Properties
onlineFrom
:
Date
(Read Only)
The date from which the associated price point is valid. If such a date doesn't exist, e.g. as in the
case of a continuous price point, null will be returned.
onlineTo
:
Date
(Read Only)
The date until which the associated price point is valid. If such a date doesn't exist, e.g. as in the case
of a continuous price point, null will be returned.
percentage
:
Number
(Read Only)
The percentage off value of this price point related to the base
price for the product's minimum order quantity.
price
:
Money
(Read Only)
The monetary price for this price point.
priceBook
:
PriceBook
(Read Only)
The price book which defined this price point.
priceInfo
:
String
(Read Only)
The price info associated with this price point. This is an
arbitrary string which a merchant can associate with a price entry. This
can be used for example, to track which back-end system the price is
derived from.
Constructor Summary
This class does not have a constructor, so you cannot create it directly.
Method Summary
getOnlineFrom()
:
Date
Returns the date from which the associated price point is valid.
getOnlineTo()
:
Date
Returns the date until which the associated price point is valid.
getPercentage()
:
Number
Returns the percentage off value of this price point related to the base price for the product's minimum order quantity.
getPriceBook()
:
PriceBook
Returns the price book which defined this price point.
getPriceInfo()
:
String
Returns the price info associated with this price point.
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
getOnlineFrom
getOnlineFrom()
:
Date
Returns the date from which the associated price point is valid. If such a date doesn't exist, e.g. as in the
case of a continuous price point, null will be returned.
Returns:
the date from which the associated price point is valid
getOnlineTo
getOnlineTo()
:
Date
Returns the date until which the associated price point is valid. If such a date doesn't exist, e.g. as in the case
of a continuous price point, null will be returned.
Returns:
the date to which the associated price point is valid
getPercentage
getPercentage()
:
Number
Returns the percentage off value of this price point related to the base
price for the product's minimum order quantity.
Returns:
the percentage off value of this price point
getPrice
getPrice()
:
Money
Returns the monetary price for this price point.
Returns:
the price amount
getPriceBook
getPriceBook()
:
PriceBook
Returns the price book which defined this price point.
Returns:
the price book defining this price
getPriceInfo
getPriceInfo()
:
String
Returns the price info associated with this price point. This is an
arbitrary string which a merchant can associate with a price entry. This
can be used for example, to track which back-end system the price is
derived from.
Returns:
the price info associated with this price point.