Get Purple Dot Summary
GET/api/purple-dot/:instance/summary
Returns the dashboard numbers of a Purple Dot connection: held pre-orders, units and shoppers; units covered by open purchase orders, uncovered, allocated and waiting for Purple Dot to export, and on unmapped variants; pre-orders exported, cancelled and refunded in the last 30 days; per purchase order, the units pre-sold next to its open quantity and other backorders; the counts that need attention (pending ETA reviews, exported orders unmatched for over an hour, unmapped variants, over-committed Waitlists, failed refunds, errors in the last 24 hours); and the last release-budget push and reconcile. Dates are Y-m-d in the account timezone; times are ISO 8601 UTC. Requires integrations.show.
inventory:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
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.