Salesforce B2C Commerce 24.7 > B2C Commerce API > B2C Commerce Script > dw.catalog
dw.catalog
Class PriceBook
Object
dw.object.PersistentObject
dw.object.ExtensibleObject
dw.catalog.PriceBook
Represents a price book.
Properties
currencyCode  :  String  (Read Only)
The currency code of the price book.
description  :  String  (Read Only)
The description of the price book.
displayName  :  String  (Read Only)
The display name of the price book.
ID  :  String  (Read Only)
The ID of the price book.
online  :  boolean  (Read Only)
The online status of the price book. The online status is calculated from the online status flag and the onlineFrom onlineTo dates defined for the price book.
onlineFlag  :  boolean  (Read Only)
The online status flag of the price book.
onlineFrom  :  Date  (Read Only)
The date from which the price book is online or valid.
onlineTo  :  Date  (Read Only)
The date until which the price book is online or valid.
parentPriceBook  :  PriceBook  (Read Only)
The parent price book.
Constructor Summary
This class does not have a constructor, so you cannot create it directly.
Method Summary
getCurrencyCode() : String
Returns the currency code of the price book.
getDescription() : String
Returns the description of the price book.
getDisplayName() : String
Returns the display name of the price book.
getID() : String
Returns the ID of the price book.
getOnlineFlag() : boolean
Returns the online status flag of the price book.
getOnlineFrom() : Date
Returns the date from which the price book is online or valid.
getOnlineTo() : Date
Returns the date until which the price book is online or valid.
getParentPriceBook() : PriceBook
Returns the parent price book.
isOnline() : boolean
Returns the online status of the price book.
Methods inherited from class ExtensibleObject
describe, getCustom
Methods inherited from class PersistentObject
getCreationDate, getLastModified, getUUID
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
getCurrencyCode
getCurrencyCode() : String
Returns the currency code of the price book.
Returns:
Currency code of the price book
getDescription
getDescription() : String
Returns the description of the price book.
Returns:
Currency code of the price book
getDisplayName
getDisplayName() : String
Returns the display name of the price book.
Returns:
Display name of the price book
getID
getID() : String
Returns the ID of the price book.
Returns:
ID of the price book
getOnlineFlag
getOnlineFlag() : boolean
Returns the online status flag of the price book.
Returns:
the online status flag of the price book.
getOnlineFrom
getOnlineFrom() : Date
Returns the date from which the price book is online or valid.
Returns:
the date from which the price book is online or valid.
getOnlineTo
getOnlineTo() : Date
Returns the date until which the price book is online or valid.
Returns:
the date until which the price book is online or valid.
getParentPriceBook
getParentPriceBook() : PriceBook
Returns the parent price book.
Returns:
Parent price book
isOnline
isOnline() : boolean
Returns the online status of the price book. The online status is calculated from the online status flag and the onlineFrom onlineTo dates defined for the price book.
Returns:
The online status of the price book.

Infocenter Retirement: On June 30, 2023, the Infocenter was retired, and documentation currently hosted on the Infocenter will be published to Salesforce Help, Commerce Cloud Developer Center, and Salesforce B2C Commerce Developer Documentation Resources. For more information, see the release note.