Class ProductPriceInfo

• TopLevel.Object
  • dw.catalog.ProductPriceInfo

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

Property Summary 

Property	Description
onlineFrom: Date (read-only)	Returns the date from which the associated price point is valid.
onlineTo: Date (read-only)	Returns the date until which the associated price point is valid.
percentage: Number (read-only)	Returns the percentage off value of this price point related to the base price for the product’s minimum order quantity.
price: Money (read-only)	Returns the monetary price for this price point.
priceBook: PriceBook (read-only)	Returns the price book which defined this price point.
priceInfo: String (read-only)	Returns the price info associated with this price point.

Constructor Summary 

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

Method Summary 

Method	Description
getOnlineFrom()	Returns the date from which the associated price point is valid.
getOnlineTo()	Returns the date until which the associated price point is valid.
getPercentage()	Returns the percentage off value of this price point related to the base price for the product’s minimum order quantity.
getPrice()	Returns the monetary price for this price point.
getPriceBook()	Returns the price book which defined this price point.
getPriceInfo()	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

Property Details 

onlineFrom 

onlineFrom: Date (read-only)

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.

---

onlineTo 

onlineTo: Date (read-only)

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.

---

percentage 

percentage: Number (read-only)

Returns the percentage off value of this price point related to the base price for the product's minimum order quantity.

---

price 

price: Money (read-only)

Returns the monetary price for this price point.

---

priceBook 

priceBook: PriceBook (read-only)

Returns the price book which defined this price point.

---

priceInfo 

priceInfo: String (read-only)

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.

---

Method Details 

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.

---