Get Walmart Dashboard Metrics

GET 
/api/walmart/dashboard

Get aggregated dashboard metrics across all Walmart integration instances.

Authorization

Any valid API token can call this endpoint — no specific scope required. Manage tokens.

Returns order counts, revenue metrics, and sync status per instance.

Period validation: Must be one of today, 7d, or 30d. Invalid values return a 422 error.

Sync summary: the response includes sync_summary.auto_sync.schedules with one entry per sync type — orders (300s interval), products (86400s), and inventory (900s) — each carrying interval_seconds and seconds_until_next, which the frontend uses to render the "Next auto-sync in ..." countdown. Orders/products countdowns derive from the sync cursor's last completion; inventory runs on a splayed every-15-minutes cron (ScheduleSplay::offset('walmart') minutes past each quarter-hour, currently :04/:19/:34/:49), so its countdown targets those offset boundaries.

Route name: walmart.dashboard

Request

Responses

200

Successful response

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.