The InventoryLookup servlet bean returns inventory information based on the input parameters. The inventory information returned by this servlet bean includes:
availabilityStatus: the numerical availability statusavailabilityStatusMsg: a string that maps to the numericalavailabilityStatuswith the following:1000: INSTOCK
1001: OUTOFSTOCK
1002: PREORDERABLE
1003: BACKORDERABLE
1005: DISCONTINUEDavailabilityDate: The date on which the item will become available.stockLevel: The total number of units currently in stock.preoderLevel: The total number of units that are available for preorder.backorderLevel: The total number of units that are available for backorder.stockThreshold: The threshold for the stock level.preorderThreshold: The threshold for the preorder level.backorderThreshold: The threshold for the backorder level.
If there is an error retrieving this information, then the error oparam will be rendered. All of this information is contained within a single inventoryInfo object, which will be rendered within the output oparam.
This servlet bean takes one required parameter and one optional parameter.
The required parameter is
itemId. TheitemIdis thecatalogRefIdof the product catalog SKU whose inventory information will be retrieved.The optional parameter is
useCache. If set to true, cached data will be retrieved. This data may be out of date, depending on how the inventory is updated, so it should be used with caution. For general store browsing, where performance is critical,useCacheshould be true. If it is essential that the information matches the latest information in the repository, thenuseCacheshould be false.
The following code sample is an example of using the InventoryLookup servlet bean:
<dsp:droplet name="/atg/commerce/inventory/InventoryLookup"> <dsp:param param="link.item.repositoryId" name="itemId"/> <dsp:param value="true" name="useCache"/> <dsp:oparam name="output"> This item is <dsp:valueof param="inventoryInfo.availabilityStatusMsg"/><br> There are <dsp:valueof param="inventoryInfo.stockLevel"/> left in the inventory.<br> </dsp:oparam> </dsp:droplet>
Note: The Inventory Framework can also be configured to use the LocalizingInventoryDroplet, which is similar to InventoryLookup, but can also include a localeKey parameter.
