Get Realtime Inventory Summary

GET 
/api/reporting/realtime-inventory/summary

Returns aggregate summary totals for the realtime inventory report, over the same filtered set as the list endpoint: pass the same filter[...] parameters (e.g. filter[warehouse_id], filter[search]) to total one warehouse or search result. With no filters, totals cover all warehouses.

Required scope: reports:read

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

Authentication: Requires Bearer token

Request

Responses

200

OK

Response Headers

Content-Type

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.