Warehouse detail
1. API overview
- Endpoint:
/api/v6.1/warehouse - Method:
GET - Description: Returns one warehouse by
warehouse_idORwarehouse_code(exactly one — v6.1 public API rule).
Headers
| Header | Required | Description |
|---|---|---|
X-API-KEY | Yes | API key from CRM |
Content-Type | Recommended | application/json |
2. Request parameters
2.1. Identifier (required — pick one)
| Parameter | Type | Description |
|---|---|---|
warehouse_id | integer | Warehouse id (≥ 1) |
warehouse_code | string | Warehouse code (store_code) |
Do not send both warehouse_id and warehouse_code.
2.2. Fields
Same whitelist as List warehouses: id, store_name, total_quantity (CSV). Default without fields → id only.
3. Sample response
{
"id": 2,
"store_name": "Binh Duong DC",
"total_quantity": 89432
}
4. Field reference
| Field | Type | Description |
|---|---|---|
id | integer | Warehouse id |
store_name | string | Name |
total_quantity | number | Aggregated stock |
5. Notes
Query string or JSON body is allowed; query is most common.
Example curl
curl --location 'https://example.getflycrm.com/api/v6.1/warehouse?warehouse_id=1&fields=id,store_name,total_quantity' \
--header 'X-API-KEY: <your_api_key>'