Inventory reports

Product stock at a point in time (or scoped to one warehouse). Domain: InventoryReport.

---

1. Summary report (as-of date)

1.1. API

• Endpoint: /api/v6.1/inventory_reports
• Method: GET
• Authentication: X-API-KEY

1.2. Request

Filtering (required / common)

Field	Required	Operators	Type	Description
store_id	Yes	eq, in	integer	Warehouse id(s)
date	No	—	string	As-of: YYYY-MM-DD or YYYY-MM-DD HH:MM:SS (filtering[date])

Optional filters (domain)

Field	Operators	Type	Description
product_id	eq	integer	Product id
product_name	eq, contains	string	Name
product_code	eq	string	Code
category_id	eq	integer	Category
quantity	eq, ne, gte, lte, gt, lt	number	Quantity filter

Product custom fields may be merged into filters like other public APIs.

Search

• search — product_name, product_code

Sorting

Field	Direction
id	asc, desc

Default: id DESC.

Fields

• Format: fields=id,product_code,... (CSV). See Needed info.
• Default when fields is omitted: id only.

Important retrievable fields:

Field	Note
inventories	Expansion: per-warehouse balances (store_id, inventory, available_inventory, …). Include in fields when you need per-warehouse quantities.
variants	Variants — if you request variants, you must also include inventories (domain validation).

Pagination

limit, offset.

1.3. Sample response

{
  "data": [
    {
      "id": 501,
      "product_code": "SKU001",
      "product_name": "Sample product",
      "unit_name": "pcs",
      "inventories": [
        { "store_id": 1, "inventory": 120, "available_inventory": 118 }
      ]
    }
  ],
  "has_more": true,
  "offset": 0,
  "limited": 100,
  "sorted": { "id": "DESC" }
}

1.4. Example curl

curl -g --location 'https://example.getflycrm.com/api/v6.1/inventory_reports?filtering[store_id]=1&filtering[date]=2026-03-31&fields=id,product_code,product_name,unit_name,inventories&limit=100' \
  --header 'X-API-KEY: <your_api_key>'

---

2. By single warehouse

2.1. API

• Endpoint: /api/v6.1/inventory_reports/by_warehouse
• Method: GET

2.2. Parameters

Field	Required	Description
filtering[warehouse_id]	Yes	Positive warehouse id (mapped to store_id server-side).
filtering[date]	No	Same as §1.
fields, search, sort, direction, limit, offset	No	Same as §1.

2.3. Sample curl

curl -g --location 'https://example.getflycrm.com/api/v6.1/inventory_reports/by_warehouse?filtering[warehouse_id]=2&filtering[date]=2026-03-31&fields=id,product_code,product_name,inventories' \
  --header 'X-API-KEY: <your_api_key>'

---

3. Notes

• Send explicit fields (product_* + inventories) if you need more than default id.