Get Low Stock Metrics
GET/api/low-stock-items/metrics
Returns summary counts for the low-stock report: how many products are low on stock, how many are critically low (below the configured days-of-supply threshold), how many are out of stock, and how many have no minimum stock level configured, along with the threshold in days. Accepts the same filters as the low-stock list so the metrics match the filtered view.
inventory:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
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.