Get summary inventory report (all stores and locations).

For more detailed data, use getProductStock instead.

Input parameters

Parameter name Description Possible value Required
date    ISO date (yyyy-mm-dd)  yes  


Field name Type Description
warehouseID  Integer  Warehouse ID  
amount  decimal  Amount in stock  
totalPurchaseValue  Decimal  Total value of inventory in purchase prices (wholesale prices). Does not include shipping or other extra costs.  
totalCostValue  Decimal  Total cost value of inventory. Cost includes purchase prices + shipping and other extra costs.  
totalSalesValue  Decimal  Total value of inventory in sales prices.