Dev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideGitHubNuGetDev CommunityDoc feedbackLog In
GitHubNuGetDev CommunityDoc feedback


**HTTP Verb** – GET

**URL** – /api/v1/realtimeinventory

**Description** – Gets the specified real time inventory parameter.

**Base** – HandlerBase\<GetRealtimeInventoryParameter, GetRealtimeInventoryResult>

**Handlers**

<table class="TableStyle-Borders" style="margin-left: 0; margin-right: auto; width: 100%;" data-cellspacing="0"> <thead> <tr class="header TableStyle-Borders-Head-Header1"> <th class="TableStyle-Borders-HeadE-Regular-Header1">Order</th> <th class="TableStyle-Borders-HeadE-Regular-Header1">Handler</th> <th class="TableStyle-Borders-HeadD-Regular-Header1">Description</th> </tr> </thead> <tbody> <tr class="odd TableStyle-Borders-Body-Row1"> <td class="TableStyle-Borders-BodyE-Regular-Row1">500</td> <td class="TableStyle-Borders-BodyE-Regular-Row1">ValidateContext</td> <td class="TableStyle-Borders-BodyD-Regular-Row1">Retrieves product settings by GetProductSettingsHandler. Validates CanSeeProducts setting, if it equals "false", returns error.</td> </tr> <tr class="even TableStyle-Borders-Body-Row1"> <td class="TableStyle-Borders-BodyE-Regular-Row1">600</td> <td class="TableStyle-Borders-BodyE-Regular-Row1">GetDisplayableGetInventoryParameter</td> <td class="TableStyle-Borders-BodyD-Regular-Row1">Store GetInventoryParameter property from the parameter object to DisplayableGetInventoryParameter property on the result object. If DisplayableGetInventoryParameter property doesn't contain any product id, returns error.</td> </tr> <tr class="odd TableStyle-Borders-Body-Row1"> <td class="TableStyle-Borders-BodyE-Regular-Row1">700</td> <td class="TableStyle-Borders-BodyE-Regular-Row1">GetInventoryResults</td> <td class="TableStyle-Borders-BodyD-Regular-Row1">Retrieves a inventoryServiceResults using the RealTimeInventory engine. If the inventoryServiceResults contains any Inventories, stores them in the RealTimeInventoryResults property on the result object.</td> </tr> <tr class="even TableStyle-Borders-Body-Row1"> <td class="TableStyle-Borders-BodyB-Regular-Row1">800</td> <td class="TableStyle-Borders-BodyB-Regular-Row1">GetAvailability</td> <td class="TableStyle-Borders-BodyA-Regular-Row1"><p>Iterates over RealTimeInventoryResults and gets a product and a productInventory from each RealTimeInventoryResult.</p> <p>Iterates over each product's unit of measure, if productInventory does not have availability information for selected unit of measure, calls GetAvailability catalog pipeline for it. Updates product's availability and availability in warehouses.</p></td> </tr> </tbody> </table>