VUZDevelopers

Get stock summary

GET
/inventory/stock/summary

Get overall stock summary including total value and warehouse breakdown

Authorization

X-Api-Key<token>

Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.

In: header

Header Parameters

x-business-id*string

Business ID

Response Body

application/json

curl -X GET "https://example.com/inventory/stock/summary" \  -H "x-business-id: string"
{  "totalProducts": 0,  "totalValue": 0,  "lowStockCount": 0,  "needsReorderCount": 0,  "warehouseBreakdown": [    {      "warehouseId": "string",      "warehouseName": "string",      "productCount": 0,      "totalValue": 0    }  ]}