Skip to main content

Warehouse detail

Returns one warehouse by id or code.

Endpoint

URL: /api/v6.1/warehouse
Method: GET

Request headers

X-API-KEY: <your_api_key>

Query parameters

Provide exactly one of the following (query or JSON body, depending on client):

ParameterTypeDescription
warehouse_idintegerWarehouse id (≥ 1).
warehouse_codestringWarehouse code (maps to store_code in CRM).
fieldsstringFields to return (per public API Warehouse configuration; e.g. id, store_name, total_quantity — not every CRM field may be exposed).

Example request

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>'
GET /api/v6.1/warehouse?warehouse_code=KHO-A HTTP/1.1
Host: example.getflycrm.com
X-API-KEY: your-api-key

Response

A single warehouse object; fields depend on fields and public API configuration.