Order refunds reports

Sellers can use this endpoint to review all orders used to calculate the percentage of orders that were refunded. You can call the endpoint to specify the number of days (14, 30, 60, 90) of order data to include in metric calculations. Walmart Marketplace requires sellers to maintain refund percentages that are 6% or lower. Else, the Walmart Marketplace may suppress, suspend, or terminate your seller account.

Call this endpoint to download an Excel file with the orders used to calculate the percentage of orders that were refunded.

Throttling

Request limits: One call per minute per seller. You may receive an HTTP 429 error if you exceed this limit. You can refer to the throttling guide to learn more about the throttling guidelines.

Request example

The request requires authentication with an API token (WM_SEC.ACCESS_TOKEN), consumer ID, and channel type.

The endpoint https://marketplace.walmartapis.com/v3/insights/performance/refunds/report specifies that you are requesting a report containing the orders used to calculate the percentage of orders that were refunded.

The following example retrieves the metrics for orders from the past 30 days.

reportDuration: Number of days used to calculate the metric. For example, 30.

Encoding for spaces: This request requires encoding if spaces are present in the query. The endpoint uses %20 for spaces.

Before you use the example code, replace the example access token and correlation ID (a randomly generated GUID used to track and debug issues) with your own values.

curl -X 'GET' \ 'https://marketplace.walmartapis.com/v3/insights/performance/refunds/report?reportDuration=30' \ -H 'accept: application/octet-stream' \ -H ‘WM_SEC.ACCESS_TOKEN: eyABCDEFGHI123456789…’ \ -H ‘WM_QOS.CORRELATION_ID: AAAAAAAA-1111-BBBB-2222-CCCC3333DDDD’ \ -H 'WM_SVC.NAME: Walmart Service Name' 

Response example

Response Body

string file data application/octet-stream 

Next steps

This GET Refunds report overview guide explains the basic parameters required to call this endpoint. You can refer to the full Reference guide to learn about optional parameters.