BizKitHub
DocsAPI ReferenceWarehouse/bff/warehouse/product-stock
getWarehouseAdmin BFF

/bff/warehouse/product-stock

Returns total + per-warehouse + per-variant stock for a product. The Product detail "Stock" tab uses this as a single round-trip.

WarehousegetBffWarehouseProduct-stock

Parameters

2 query

2 total
Query · 2
productIdstring

Numeric product id (alternative to productCode).

productCodestring

Human-readable product code, e.g. from /bff/product/product-detail.

Request

GET /bff/warehouse/product-stock

get
curl -X GET "https://api.bizkithub.com/bff/warehouse/product-stock?productId=example_productId&productCode=example_productCode" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

JSON payload

{
  "productId": 0,
  "productCode": "example_productCode",
  "productName": "example_productName",
  "hasVariants": false,
  "totalQuantity": 0,
  "totalReserved": 0,
  "totalAvailable": 0,
  "perWarehouse": [
    {
      "warehouseId": 0,
      "warehouseCode": "example_warehouseCode",
      "warehouseName": "example_warehouseName",
      "quantity": 0,
      "quantityReserved": 0,
      "available": 0,
      "isDefault": false
    }
  ],
  "variants": [
    {
      "variantId": 0,
      "variantCode": "example_variantCode",
      "totalQuantity": 0,
      "totalReserved": 0,
      "totalAvailable": 0,
      "perWarehouse": [
        {
          "warehouseId": 0,
          "warehouseCode": "example_warehouseCode",
          "warehouseName": "example_warehouseName",
          "quantity": 0,
          "isDefault": false
        }
      ]
    }
  ],
  "lowStockWarnings": [
    {
      "warehouseId": 0,
      "warehouseName": "example_warehouseName",
      "quantity": 0,
      "threshold": 0
    }
  ]
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key