Get API platform status
The API Platform Status endpoint provides a consolidated view of Walmart Marketplace API health by API group. Use it to quickly triage whether an issue is likely platform-wide (for example, Items, Orders, Returns) or isolated to your integration.
The JSON response returns the operational health status for each API group queried, including the last time the status was updated. Statuses are refreshed every 30 minutes or less, so lastUpdatedTime helps you understand how recent the current status is.
Endpoint
GET /v3/utilities/apiStatus
Request sample
curl -X GET \ "https://marketplace.walmartapis.com/v3/utilities/apiStatus" \ -H "WM_SEC.ACCESS_TOKEN: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM....." \ -H "WM_QOS.CORRELATION_ID: b3261d2d-028a-4ef7-8602-633c23200af6" \ -H "WM_SVC.NAME: Walmart Service Name"
Modify your code
- Use the sample cURL exactly as shown. No query parameters are required for this endpoint.
- Replace
WM_SEC.ACCESS_TOKENwith your current access token. - Replace
WM_QOS.CORRELATION_IDwith a new UUID each time you retry. - Poll on a reasonable interval (for example every 1–5 minutes) and record status changes.
- After calling the endpoint, scan
apiStatuses []for theapiGroupyou're currently using (for example: Items, Orders, Returns, Authorization, Promos). - Use the returned
statusvalue to decide whether to decide how to proceed. UselastUpdatedTimeto determine how recent the current status is. - Rate limits are separate from platform health. If you receive HTTP 429 Too Many Requests, reduce request volume and apply backoff. Refer to the Rate Limiting guide for more information.
Response sample
{ "apiStatuses": [ { "apiGroup": "Returns", "status": "OPERATIONAL", "lastUpdatedTime": "2022-01-06T12:30:39.884Z" }, { "apiGroup": "Authorization", "status": "SERVICE_DEGRADATION", "lastUpdatedTime": "2022-01-06T12:30:39.884Z" }, { "apiGroup": "Promos", "status": "SERVICE_OUTAGE", "lastUpdatedTime": "2022-01-06T12:30:39.884Z" } ]
}
Status meanings and recommended actions
| Status | What it means | How to interpret results | Recommended next steps |
|---|---|---|---|
OPERATIONAL | The API group is performing as expected (monitoring reports no outages). | Issues are less likely platform-wide for that API group. Errors may be integration-specific (auth, request format, rate limits) or transient. | Continue normal retries/backoff for transient errors. If errors persist, create a support ticket and include correlation IDs and timestamps. |
SERVICE_DEGRADATION | The API group is performing less optimally; you may see intermittent issues or higher failure rates. | Elevated error rates are likely platform-related for that group. | Use exponential backoff and retries. Consider pausing non-critical workflows. Monitor for recovery before escalating; avoid duplicate tickets for known incidents. |
SERVICE_OUTAGE | The API group may be down and not serving requests; you may see complete failures. | Failures are likely platform-wide for that API group. | Pause non-critical workflows and retry later. Monitor for recovery; avoid duplicate tickets for known incidents unless you have additional details to provide. |
Result
You get a list of API groups with their current status and last updated timestamp, enabling quicker diagnosis of platform-wide issues.
Next steps
- Add API status checks to your runbooks.
- When you detect non-operational status, retry with backoff and consider pausing non-critical workflows until the platform recovers.
Updated about 10 hours ago
