Get Inventory Movement Aggregates

GET 
/api/v2/inventory-movements/aggregates

Column-summary aggregates for the list'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.

Required scope: inventory:read

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

Aggregatable columns: quantity, unit_cost, value_impact. Supported calcs: sum, avg, min, max, range, count_all, count_values, count_unique, count_empty, count_not_empty. Pass them as aggregates[<column>]=<calc>. Value Impact rounds per movement, so its sum equals the sum of the displayed Value Impact cells.

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

OK

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

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.

429

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.