Skip to main content

Get Inventory Aging Report

GET 

/api/inventory-aging

Paginated inventory aging report.

Required scope: inventory:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Two views:

  • view=product_summary — one row per product aggregated across its FIFO layers, enriched with listings, sales velocity (7/14/30/90 days), days of supply, channel sales, margin, bracket-scoped aged_value (dollars in the active bracket, or 181+ days when no bracket filter is set), an estimated 90-day holding_cost_90d, a rule-based suggested_action, and the recorded action state.
  • view=fifo_detail — raw cost layers (one row per layer) with age bracket, layer date, source document and value.

Sorting (product summary): pass sort_by + sort_dir; sorting runs server-side over the full filtered dataset. Allowed sorts: sku, total_quantity, avg_unit_cost, total_value, aged_value, max_days_old, holding_cost, velocity_30d.

Action scope (product summary): action_scope partitions rows by their recorded action state; metrics and distribution deliberately ignore it so totals keep counting accepted/resolved stock.

All other filters apply identically to this endpoint, the metrics, the distribution and the CSV export. sales_period governs every sales-window filter (has_sales, channel sold-on / no-sales-on, margin).

Product lifecycle: product-summary rows carry lifecycle_state (the product's lifecycle state key, or null). filter_groups accepts a lifecycle_state column (text operators). For products in a sell-through state (Discontinued by default) the suggested action is a markdown — {"action": "reduce_price", "label": "Add to clearance plan", "reason": "Discontinued — it will not be reordered, so clear the remaining stock with a markdown"} — and channel-visibility suggestions (list_on_channels, expand_channels) are not offered.

Request​

Responses​

OK

Response Headers
    Content-Type