Get Inventory Planning Summary
GET/api/reporting/inventory-planning/summary
Returns summary metrics for the inventory planning report header cards (counts of items at risk, overstocked, out of stock, etc.).
reports:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token
needs_reorder_count: products whose Suggested Qty is above 0 — the same rule the report's "Suggested Qty > 0" filter applies, so the Need Reorder count always equals the rows that filter returns (products with no default supplier included). supplier_consolidation_totals.item_count is the per-supplier subset only.
Days of stock / days until stockout are floored at 0: a product oversold into negative availability reports 0 days, not a negative number.
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.