Get summary inventory report (all stores and locations).

For more detailed data, use getProductStock instead.

Input parameters

Parameter nameDescriptionPossible valueRequired
dateISO date (yyyy-mm-dd) yes


Field nameTypeDescription
warehouseIDIntegerWarehouse ID
amountdecimalAmount in stock
totalPurchaseValueDecimalTotal value of inventory in purchase prices (wholesale prices). Does not include shipping or other extra costs.
totalCostValueDecimalTotal cost value of inventory. Cost includes purchase prices + shipping and other extra costs.
totalSalesValueDecimalTotal value of inventory in sales prices.