Inventory reports
Aggregated stock report (as-of date)
Endpoint
URL: /api/v6.1/inventory_reports
Method: GET
Request headers
X-API-KEY: <your_api_key>
Query parameters
| Parameter | Required | Description |
|---|---|---|
filtering[store_id] | Yes | Store/warehouse id. |
filtering[date] | No | As-of: YYYY-MM-DD or YYYY-MM-DD HH:MM:SS. |
fields, limit, offset, … | No | Per public API InventoryReport domain and Needed info. |
Brackets in query strings
On the shell, quote the URL or use curl -g so [ ] are not treated as globs.
Example request
GET /api/v6.1/inventory_reports?filtering[store_id]=1&filtering[date]=2025-03-31&limit=100 HTTP/1.1
Host: example.getflycrm.com
X-API-KEY: your-api-key
Detailed stock by warehouse
Endpoint
URL: /api/v6.1/inventory_reports/by_warehouse
Method: GET
Query parameters
| Parameter | Required | Description |
|---|---|---|
filtering[warehouse_id] | Yes | Warehouse id (positive integer). |
filtering[date] | No | Same as aggregated report. |
Example request
GET /api/v6.1/inventory_reports/by_warehouse?filtering[warehouse_id]=2&filtering[date]=2025-03-31 HTTP/1.1
Host: example.getflycrm.com
X-API-KEY: your-api-key