Skip to main content

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.

Required scope: inventory:read

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

Request​

Responses​

OK

Response Headers
    Content-Type