Parameters
1 query
Query parameters
· 1limitstringOptionalExample
example_limit/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
Response schema
1 status code documented
200Success
itemsobject[]RequiredEach array item:
organisationIdnumberRequiredorganisationNamestringRequiredstockItemIdnumberRequiredwarehouseIdnumberRequiredwarehouseNamestringRequiredproductIdnumber | nullRequiredOne of 2:
Variant 1
number
Variant 2
null
productCodestring | nullRequiredOne of 2:
Variant 1
string
Variant 2
null
productNamestring | nullRequiredOne of 2:
Variant 1
string
Variant 2
null
productVariantIdnumber | nullRequiredOne of 2:
Variant 1
number
Variant 2
null
variantCodestring | nullRequiredOne of 2:
Variant 1
string
Variant 2
null
variantNamestring | nullRequiredOne of 2:
Variant 1
string
Variant 2
null
virtualItemSkustring | nullRequiredOne of 2:
Variant 1
string
Variant 2
null
itemLabelstringRequiredquantitynumberRequiredquantityReservednumberRequiredavailablenumberRequiredthresholdnumberRequiredfromPolicybooleanRequiredreorderPointnumber | nullRequiredOne of 2:
Variant 1
number
Variant 2
null
itemCountnumberRequiredResponse example
application/json{
"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
}Request example
GET /bff/warehouse/alerts/low-stock
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"Need an API key?
All BizKitHub public API endpoints require authentication via API key.