VUZDevelopers

Get warehouse stock

GET
/inventory/stock/warehouse/{warehouseId}

Get all stock levels in a specific warehouse

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

Path Parameters

warehouseId*string

Warehouse ID

Query Parameters

productId?string

Filter by product ID

classification?string

Filter by classification

Value in

  • "available"
  • "damaged"
  • "slow_moving"
  • "obsolete"
  • "reserved"
  • "consignment_in"
  • "consignment_out"
lowStockOnly?boolean

Only show low stock items

needsReorderOnly?boolean

Only show items needing reorder

search?string

Search by product name or SKU

page?number

Page number

Default1
limit?number

Items per page

Default50

Header Parameters

x-business-id*string

Business ID

Response Body

application/json

curl -X GET "https://example.com/inventory/stock/warehouse/string" \  -H "x-business-id: string"
{  "items": [    {      "id": "string",      "warehouseId": "string",      "warehouseName": "string",      "productId": "string",      "productName": "string",      "productSku": "string",      "productBarcode": "string",      "quantity": 0,      "reservedQuantity": 0,      "availableQuantity": 0,      "incomingQuantity": 0,      "classification": "available",      "averageCost": 0,      "lastPurchaseCost": 0,      "totalCostValue": 0,      "minStockLevel": 0,      "maxStockLevel": 0,      "reorderPoint": 0,      "isLowStock": true,      "needsReorder": true,      "lastMovementAt": "2019-08-24T14:15:22Z",      "lastCountDate": "2019-08-24T14:15:22Z"    }  ],  "total": 0}