DocsAPI ReferenceWarehouse/bff/warehouse/stock/list
getWarehouseAdmin BFF

/bff/warehouse/stock/list

List stock items

WarehousegetBffWarehouseStockList

Parameters

8 query

8 total
Query · 8
warehouseIdstring
locationIdstring
productIdstring
productVariantIdstring
searchstring
onlyPositivestring
limitstring
offsetstring

Request

GET /bff/warehouse/stock/list

get
curl -X GET "https://api.bizkithub.com/bff/warehouse/stock/list?warehouseId=example_warehouseId&locationId=example_locationId&productId=example_productId&productVariantId=example_productVariantId&search=example_search&onlyPositive=example_onlyPositive&limit=example_limit&offset=example_offset" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

JSON payload

{
  "items": [
    {
      "id": 0,
      "warehouseId": 0,
      "warehouseName": "example_warehouseName",
      "warehouseCode": "example_warehouseCode",
      "itemLabel": "example_itemLabel",
      "quantity": 0,
      "quantityReserved": 0,
      "available": 0,
      "insertedDate": "example_insertedDate",
      "updatedDate": "example_updatedDate"
    }
  ],
  "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