Retrieve order refunds summary

Call this endpoint to retrieve a high level summary of refund performance for your catalog over a recent window of time (14 days, 30 days, 60 days, 90 days). The API returns cumulative refund rate and trend, GMV loss and trend, order impact and trend, risk level, and top drivers (seller accountable and non accountable), plus actionable recommendations.

You can use this API to track the percentage of orders that are refunded. Walmart requires you to keep the refund rates within the specified standards, to ensure a positive customer experience. For more information, refer to Seller Performance Standards.

This endpoint uses metrics like cumulative trends, item defective rates, and number of delivered orders that were damaged to calculate your refunds metrics.

This page describes an example using only the required parameters and inputs to retrieve order refunds summary For a full list of customization options and additional capabilities, refer to the Marketplace Insights API Reference.

The cumulativeRateTrend response parameter uses the statuses in the table below to explain if a trend is a positive or negative change. Trend indicates how this metric has changed compared to the previous report duration ending the day before

ColorDescription
GREEN_UP
GREEN_DOWN
A positive change or an improved performance in the metric compared to the previous report duration ending the day before.
NEUTRALIndicates no change in the metric compared to the previous report duration ending the day before.
RED_UP
RED_DOWN
A negative change or decreased performance in the metric compared to the previous report duration ending the day before. It is urgent and needs to be resolved.

Endpoint

GET https://marketplace.walmartapis.com/v3/insights/performance/refunds/summary

Sample request

This sample request retrieves performance metrics for the percentage of orders that required a refund.

curl -X 'GET' \ 'https://marketplace.walmartapis.com/v3/insights/performance/refunds/summary?reportDuration=30' \ -H 'Authorization: Basic <BASE64_CLIENTID_COLON_CLIENTSECRET>' \ -H 'WM_SEC.ACCESS_TOKEN: <ACCESS_TOKEN>' \ -H 'WM_QOS.CORRELATION_ID: b3261d2d-028a-4ef7-8602-633c23200af6' \ -H 'WM_SVC.NAME: Walmart Marketplace'
import requests url = "https://marketplace.walmartapis.com/v3/insights/performance/refunds/summary"
params = {"reportDuration": "30"}
headers = { "Authorization": "Basic <BASE64_CLIENTID_COLON_CLIENTSECRET>", "WM_SEC.ACCESS_TOKEN": "<ACCESS_TOKEN>", "WM_QOS.CORRELATION_ID": "b3261d2d-028a-4ef7-8602-633c23200af6", "WM_SVC.NAME": "Walmart Marketplace",
} response = requests.get(url, headers=headers, params=params, timeout=30)
response.raise_for_status()
print(response.json())

Modify your code

  • Use a unique WM_QOS.CORRELATION_ID for each request.
  • Replace WM_SEC.ACCESS_TOKEN with your valid access token obtained through authentication.
  • Replace reportDuration with the number of days (14, 30, 60, 90) of order data that you want to include in metric calculations.

Sample response

This sample response details the payload, nonAccountableDrivers, and sellerAccountableDrivers maps containing the various metrics used to calculate the on-time delivery metrics.

  • nonAccountableVtrDrivers - Metrics that do not affect the Seller Performance Standards.
  • sellerAccountableVtrDrivers - Metrics that affect the Seller Performance Standards.
{ "payload": { "reportDuration": 30, "updatedTimestamp": "2025-02-02T19:49:56Z", "cumulativeRate": 8.8, "cumulativeRateTrend": "GREEN_UP", "gmvLoss": 1940, "gmvLossTrend": "GREEN_UP", "ordersImpacted": 19, "ordersImpactedTrend": "GREEN_UP", "performanceStandard": "6% or below", "riskLevel": "NEEDS ATTENTION", "performanceRiskLevel": "Monitor", "sellerAccountableDrivers": { "incorrectItemsRate": 6.98, "arrivedLateRate": 1.03, "defectiveRate": 0.72, "damagedRate": 0.12, "lostRate": 0 }, "nonAccountableDrivers": { "customerChangedMindRate": 20.97, "miscellaneousRate": 0.36, "undeliveredRate": 0 }, "recommendations": [ { "recommendation": "Meet customer expectations", "moreInfoLink": "https://sellerhelp.walmart.com/seller/s/guide?language=en_US&article=000007440#Overview" }, { "recommendation": "Monitor your assortment", "moreInfoLink": "https://sellerhelp.walmart.com/seller/s/guide?language=en_US&article=000007440#Overview" } ] }, "status": "OK"
}

Modify your code

  • Use a unique WM_QOS.CORRELATION_ID for each request.
  • Replace WM_SEC.ACCESS_TOKEN with your valid access token obtained through authentication.
  • Replace reportDuration with the number of days (14, 30, 60, 90) of order data that you want to include in metric calculations.

Result

This call returns a summary object with payload (metrics) and status (request state). If successful, the API returns an HTTP status 200 OK with a JSON response. The metrics reflect the order refunds summary for orders in the specified duration.

Rate limits

If you submit too many feeds in a short period of time, you may exceed Walmart’s rate limits and receive HTTP 429 (Too Many Requests) responses. For more details on throttling and best practices, refer to the Rate Limiting Guide.