Get Store Stats
GET/api/v2/stores/:store/stats
Dashboard KPIs for the Store detail page: connected sales-channel count, assigned-customer count, 90-day order count and revenue, the store's outbound-sending identity (email/PO email, sender domain and its verification status), and the store's linked sales channels, email templates (each with a friendly context_label, e.g. "Bulk Sales Order"), and PDF templates.
settings:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
sending.domain_verification_status is one of pending, verifying, verified, failed (null when the store has no email). sending.is_default_sender is true when this store is the tenant default sender.
Authentication: Requires Bearer token (PAT).
orders.count_90d and orders.revenue_90d cover the store's orders dated in the last 90 days, leaving out draft and cancelled orders. revenue_90d is the sum of those orders' line revenue in the account's base currency (the same figure the sales reports use), rounded to 2 decimals.
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.