Reference: Global Inventory Visibility REST APIs

The following table shows how Order Hub uses the IBM Global Inventory Visibility (GIV) REST APIs in OMS. This information does not apply if you are using Sterling™ Intelligent Promising Inventory Visibility instead of GIV.

Table 1. Item and SKU information
Metrics	OMS GIV APIs used
Total available	The sum of all the total available rows from the table metrics. This is the aggregation of the total available of all the items across all the nodes that is currently being looked at.
Total units	Total units is the sum of on-hand inventory and future inventory of the items listed in the table. GIV uses the getSupplyDetails API to get the total units. Note: The total on-hand information in the modal is arrived from getSupplyDetails API per item at node. In the API response. use the TotalQuantity for all the supply types that are defined as supplies for on hand inventory.
Most active SKU	The most sold variation within the item. It is calculated using the getItemNodeVelocity API to retrieve the highest average of all returned QuantityInMaxWindow across all the variations. You must configure GIV to use the velocity feature.
Least active SKU	The least sold variation within the item. It is calculated using the getItemNodeVelocity API to retrieve the lowest average of all returned QuantityInMaxWindow across all the variations. You must configure GIV to use the velocity feature.
Ship from store	The item's fulfillment option that is allowed to ship from store. The API used to retrieve this information is getItemList.
Pickup from store	The item's fulfillment option that is allowed to pickup from store. The API used to retrieve this information is getItemList.
SKU safety stock default	GIV uses the getItemList to retrieve the default safety stock value for the SKU and it uses the manageItem API to update the default safety stock value for the SKU.

Table 2. Table metrics
Metrics	OMS GIV APIs used
Total available	It is derived from supply on hand minus committed.
Supply on hand/Total on hand	The total on hand information is arrived from getSupplyDetails API per item at node. In the API response use the TotalQuantity for all the supply types that are defined as supplies for on hand inventory.
Committed	GIV uses the getDemandSummary API. This returns a list of `DemandTypes` per `shipNode`. Therefore all the quantities for each `DemandType` is summed up to determine the committed units.
Available to sell (future inventory)	GIV uses the getAvailableInventory API to calculate the units that are available to sell. Available to sell units that are for future dates other than the current day will account for available to sell from future inventory.
Available to sell (on hand)	GIV uses the getAvailableInventory API to calculate the units that are available to sell. Available to sell (on hand) is the minimum units that are available to sell from available to sell (pickup from store) and available to sell (ship from store).
Available to sell (pickup from store)	GIV uses the getAvailableInventory API per delivery method (`PICK`).
Available to sell (ship from store)	GIV uses the getAvailableInventory API per delivery method (`SHP`).
Safety stock (pickup from store)	GIV uses the getItemNodeDefnDetails API. See the response at `ItemNodeDefn` > `SafectyFactorDefinitions` > `SafetyFactorDefinition` > `OnhandSafetyFactorQuantity`. Also see the `DeliveryMethod` associated with the safety factor definition.
Safety stock (ship from store)	GIV uses the getItemNodeDefnDetails API. See the response at `ItemNodeDefn` > `SafectyFactorDefinitions` > `SafetyFactorDefinition` > `OnhandSafetyFactorQuantity`. Also see the `DeliveryMethod` associated with the safety factor definition.

Table 3. Save actions
Metrics	OMS GIV APIs used
Move action for moving inventory	GIV uses the createOrder API to move the inventory.
Save action for SKU at node level	GIV uses the createItemNodeDEFN or modifyItemNodeDEFN API.
Save action for fulfillment	GIV uses the manageItem or modifyItem API.

Table 4. Graphs
Metrics	OMS GIV APIs used
Inventory supply	Use the getATP API with the time horizon as the end date. In the response section, review AvailableToPromiseInventory API and get all the supply type quantities and sort it in descending order. Display the top 3 quantities as individual supply type in the pie chart. The rest of the supply types are added up to show up as `OTHER`.
Inventory demand	Use the getATP API with the time horizon as the end date. In the response section, review the AvailableToPromiseInventory API and get all the demand type quantities and sort it in descending order. Display the top 3 quantities as individual demand type in the pie chart. The rest of the demand types are added up to show up as `OTHER`.
Future supply/demand	Use the getATP API with start date as current day and end date based on the date provided in the graph (7, 14, or 30 days). Then in the response section, reviewAvailableToPromiseInventory API that displays demand and supply data.