Skip to main content

Inventory cards

Stock movements for a product over a period. Domain: InventoryCard.


1. API

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

2. Request

2.1. Filtering

FieldRequiredOperatorsTypeDescription
product_idYeseqintegerProduct id
sheet_date:gteNo*gtedatetimeStart (if omitted, public API defaults to 2000-01-01 00:00:00)
sheet_date:lteNo*ltedatetimeEnd (if omitted, defaults to now)

* Public service injects defaults before domain validation; you should still pass a meaningful window.

Optional: store_id (eq), category_id, product_name, product_code, other product_* + product custom fields.

  • searchproduct_name

2.3. Fields

CSV fields (Needed info). Default: id only.

FieldDescription
inventory_card_detailLine-level movements (heavy)
variantsRequires inventory_card_detail in fields

Other fields: product_code, product_name, product_featured_image, store_name, period_start_quantity, in_quantity, out_quantity, period_end_quantity, …

2.4. Pagination

limit, offset


3. Sample response

{
"data": [
{
"id": "101-1",
"product_code": "SKU001",
"product_name": "Sample",
"store_name": "Main warehouse",
"period_start_quantity": 50,
"in_quantity": 30,
"out_quantity": 10,
"period_end_quantity": 70
}
],
"has_more": false,
"offset": 0,
"limited": 100
}

4. Example curl

curl -g --location 'https://example.getflycrm.com/api/v6.1/inventory_cards?filtering[product_id]=101&filtering[sheet_date:gte]=2026-01-01&filtering[sheet_date:lte]=2026-03-31&fields=id,product_code,product_name,period_start_quantity,in_quantity,out_quantity,period_end_quantity&limit=100' \
--header 'X-API-KEY: <your_api_key>'