BizKitHub
DocsAPI ReferenceWarehouse/bff/warehouse/detail
getWarehouseAdmin BFF

/bff/warehouse/detail

Get warehouse detail by id or code

WarehousegetBffWarehouseDetail

Parameters

2 query

Query parameters

· 2
idstringOptional

Numeric id.

Exampleexample_id
codestringOptional

String code.

Exampleexample_code

Response schema

1 status code documented

200Success
idnumberRequired
codestringRequired
namestringRequired
descriptionstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
addressStreetstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
addressCitystring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
addressZipstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
addressCountrystring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
isDefaultbooleanRequired
isActivebooleanRequired
allowNegativeStockbooleanRequired

When true (default), outbound / transfer / adjustment may drive the cell to negative quantity.

managerMemberIdnumber | nullRequired
One of 2:
Variant 1
number
Variant 2
null
stockItemCountnumberRequired
totalQuantitynumberRequired
insertedDatestringRequired
updatedDatestringRequired

Response example

application/json
{
  "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/detail

get
curl -X GET "https://api.bizkithub.com/bff/warehouse/detail?id=example_id&code=example_code" \
  -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