Get Inventory Planning Column Totals
GET/api/reporting/inventory-planning/aggregates
Column-summary totals for the report's "Calculate" footer — computes Sum, Average, Min, Max, Range, or a Count variant per column over the FULL filtered set (not just the current page), in one query.
reports:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Aggregatable columns: available_qty, available_to_sell, total_stock_qty, reserved_qty, in_transit_qty, inbound_qty, projected_total, active_backorder_qty, net_available, stock_value, min_stock_level, qty_sold_30d, qty_sold_60d, qty_sold_90d, qty_sold_180d, revenue_180d. Supported calcs: sum, avg, min, max, range, count_all, count_values, count_unique, count_empty, count_not_empty. Pass them as aggregates[<column>]=<calc>. Totals cover the stock-quantity, stock-value and sales columns.
Apply the same filters and search as the list endpoint to scope the totals. An unknown calc returns 422. Authentication: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.