Parameters
1 query
Query parameters
· 1onlyActivestringOptional"true" to hide inactive warehouses.
Example
example_onlyActiveWarehousegetBffWarehouseList
Response schema
1 status code documented
200Success
itemsobject[]RequiredEach array item:
idnumberRequiredcodestringRequirednamestringRequireddescriptionstring | nullRequiredOne of 2:
Variant 1
string
Variant 2
null
addressStreetstring | nullRequiredOne of 2:
Variant 1
string
Variant 2
null
addressCitystring | nullRequiredOne of 2:
Variant 1
string
Variant 2
null
addressZipstring | nullRequiredOne of 2:
Variant 1
string
Variant 2
null
addressCountrystring | nullRequiredOne of 2:
Variant 1
string
Variant 2
null
isDefaultbooleanRequiredisActivebooleanRequiredallowNegativeStockbooleanRequiredWhen true (default), outbound / transfer / adjustment may drive the cell to negative quantity.
managerMemberIdnumber | nullRequiredOne of 2:
Variant 1
number
Variant 2
null
stockItemCountnumberRequiredtotalQuantitynumberRequiredinsertedDatestringRequiredupdatedDatestringRequiredResponse example
application/json{
"items": [
{
"id": 0,
"code": "example_code",
"name": "example_name",
"isDefault": false,
"isActive": false,
"allowNegativeStock": false,
"stockItemCount": 0,
"totalQuantity": 0,
"insertedDate": "example_insertedDate",
"updatedDate": "example_updatedDate"
}
]
}Request example
GET /bff/warehouse/list
curl -X GET "https://api.bizkithub.com/bff/warehouse/list?onlyActive=example_onlyActive" \
-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.