Docs API Reference Warehouse/bff/warehouse/reports/days-of-stock

getWarehouseAdmin BFF

/bff/warehouse/reports/days-of-stock

Per-cell "how many days does current available last given the moving-average consumption".

WarehousegetBffWarehouseReportsDays-of-stock

Parameters

3 query

Query parameters

· 3

windowDaysstringOptional

Moving-average window in days. Default 30.

Exampleexample_windowDays

warehouseIdstringOptional

Exampleexample_warehouseId

limitstringOptional

Exampleexample_limit

Response schema

1 status code documented

200Success

itemsobject[]Required

Each array item:

stockItemIdnumberRequired

warehouseIdnumberRequired

warehouseNamestringRequired

productIdnumber | nullRequired

One of 2:

Variant 1

number

Variant 2

null

productCodestring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

productNamestring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

productVariantIdnumber | nullRequired

One of 2:

Variant 1

number

Variant 2

null

variantCodestring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

variantNamestring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

virtualItemSkustring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

itemLabelstringRequired

quantitynumberRequired

quantityReservednumberRequired

availablenumberRequired

avgDailyConsumptionnumberRequired

daysOfStocknumber | nullRequired

One of 2:

Variant 1

number

Variant 2

null

reorderPointnumber | nullRequired

One of 2:

Variant 1

number

Variant 2

null

itemCountnumberRequired

Response example

application/json

{
  "items": [
    {
      "stockItemId": 0,
      "warehouseId": 0,
      "warehouseName": "example_warehouseName",
      "itemLabel": "example_itemLabel",
      "quantity": 0,
      "quantityReserved": 0,
      "available": 0,
      "avgDailyConsumption": 0
    }
  ],
  "itemCount": 0
}

Request example

GET /bff/warehouse/reports/days-of-stock

get

curl -X GET "https://api.bizkithub.com/bff/warehouse/reports/days-of-stock?windowDays=example_windowDays&warehouseId=example_warehouseId&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.

Get API Key