BizKitHub
DocsAPI ReferenceWarehouse/bff/warehouse/alerts/low-stock
getWarehouseAdmin BFF

/bff/warehouse/alerts/low-stock

Same data the cron daemon scans. Ordered by severity (how far below the threshold). The dashboard surfaces the count as a notification badge; the warehouse list page renders the full list as a dedicated tab.

WarehousegetBffWarehouseAlertsLow-stock

Parameters

1 query

1 total
Query · 1
limitstring

Request

GET /bff/warehouse/alerts/low-stock

get
curl -X GET "https://api.bizkithub.com/bff/warehouse/alerts/low-stock?limit=example_limit" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

JSON payload

{
  "items": [
    {
      "organisationId": 0,
      "organisationName": "example_organisationName",
      "stockItemId": 0,
      "warehouseId": 0,
      "warehouseName": "example_warehouseName",
      "itemLabel": "example_itemLabel",
      "quantity": 0,
      "quantityReserved": 0,
      "available": 0,
      "threshold": 0,
      "fromPolicy": false
    }
  ],
  "itemCount": 0
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key