Skip to main content

Warehouse detail

1. API overview

  • Endpoint: /api/v6.1/warehouse
  • Method: GET
  • Description: Returns one warehouse by warehouse_id OR warehouse_code (exactly one — v6.1 public API rule).

Headers

HeaderRequiredDescription
X-API-KEYYesAPI key from CRM
Content-TypeRecommendedapplication/json

2. Request parameters

2.1. Identifier (required — pick one)

ParameterTypeDescription
warehouse_idintegerWarehouse id (≥ 1)
warehouse_codestringWarehouse 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 fieldsid only.


3. Sample response

{
"id": 2,
"store_name": "Binh Duong DC",
"total_quantity": 89432
}

4. Field reference

FieldTypeDescription
idintegerWarehouse id
store_namestringName
total_quantitynumberAggregated 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>'