This guide is intended for customers with custom-built third-party API integrations. It provides an additional method for viewing stock levels, rather than the standard approach. You can view stock levels for products using the GET /api/Product/StockLevels call. You need to supply the API key and WarehouseID. There's also an optional parameter called Breakdown. If you want a breakdown of the stock held, for example, best before dates, batch number or serial number, set this to true.
With the breakdown parameter not set
[ { "ProductId": 1, "WarehouseId": 3, "ClientId": 3, "SKU": "MY-SKU", "Level": 10, "PreOrderable": true, "Bundle": false, "LowStockLevel": 0, "Breakdown": [] } ]With the breakdown parameter set to true
[ { "ProductId": 1, "WarehouseId": 3, "ClientId": 3, "SKU": "MY-SKU", "Level": 10, "PreOrderable": true, "Bundle": false, "LowStockLevel": 0, "Breakdown": [ { "Quantity": 5, "BatchNo": "BATCH-1", "SerialNo": "SERIAL1234", "BestBefore": "05-May-2019", "Type": "Allocation" },{ "Quantity": 5, "BatchNo": "BATCH-2", "SerialNo": "SERIAL123", "BestBefore": "01-June-2019", "Type": "Allocation" }] }]