Skip to main content

Inventory reports

Aggregated stock report (as-of date)

Endpoint

URL: /api/v6/inventory_reports
Method: GET

Request headers

X-API-KEY: <your_api_key>

Query parameters

ParameterRequiredDescription
filtering[store_id]YesStore/warehouse id.
filtering[date]NoYYYY-MM-DD or YYYY-MM-DD HH:MM:SS.
Brackets in query strings

On the shell, quote the URL or use curl -g.

Example request

GET /api/v6/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/inventory_reports/by_warehouse
Method: GET

Query parameters

ParameterRequiredDescription
filtering[warehouse_id]YesWarehouse id.
filtering[date]NoSame as above.

Example request

GET /api/v6/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