Class ProductInventoryList
dw.catalog
Class ProductInventoryList
Object
dw.object.PersistentObject
dw.object.ExtensibleObject
dw.catalog.ProductInventoryList
The ProductInventoryList provides access to ID, description and defaultInStockFlag of the list. Furthermore inventory records can be accessed by product or product ID.

When using Omnichannel Inventory (OCI):

  • B2C Commerce uses ProductInventoryLists to reference and expose OCI Locations and Location Groups. They're required for synchronizing availability data and creating reservations.
  • Create a ProductInventoryList in B2C Commerce for each OCI Location and Location Group that B2C Commerce will access. The ProductInventoryList ID must match the External Reference field on the corresponding Location or Location Group.
  • A ProductInventoryList ID/External Reference must have between 2 and 128 characters (inclusive). It can include only lowercase letters, uppercase letters, digits, hyphens, and underscores.

Properties
defaultInStockFlag  :  boolean  (Read Only)
The default in-stock flag of the inventory list.
description  :  String  (Read Only)
The description of the inventory list.
ID  :  String  (Read Only)
The ID of the inventory list.
Constructor Summary
This class does not have a constructor, so you cannot create it directly.
Method Summary
getDefaultInStockFlag() : boolean
Returns the default in-stock flag of the inventory list.
getDescription() : String
Returns the description of the inventory list.
getID() : String
Returns the ID of the inventory list.
getRecord(product : Product) : ProductInventoryRecord
Returns the inventory record for the specified product or null if there is no record for the product in this list.
getRecord(productID : String) : ProductInventoryRecord
Returns the inventory record for the specified product ID or null if there is no record for the product id in this list.
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
getDefaultInStockFlag
getDefaultInStockFlag() : boolean
Returns the default in-stock flag of the inventory list.
Returns:
Default in-stock flag of inventory list.
getDescription
getDescription() : String
Returns the description of the inventory list.
Returns:
Description of inventory list.
getID
getID() : String
Returns the ID of the inventory list.
Returns:
ID of inventory list.
getRecord
getRecord(product : Product) : ProductInventoryRecord
Returns the inventory record for the specified product or null if there is no record for the product in this list.
Parameters:
product - The product to lookup inventory record.
Returns:
Inventory record or null if not found.
getRecord
getRecord(productID : String) : ProductInventoryRecord
Returns the inventory record for the specified product ID or null if there is no record for the product id in this list.
Parameters:
productID - The product ID to lookup inventory record.
Returns:
Inventory record or null if not found.