Call this endpoint to retrieve the cancellation summary including cumulative cancellation rate, impacted orders, and trend indicators for a defined report duration (14 days, 30 days, 60 days, 90 days). You can can use this endpoint to understand the percentage of their orders that are canceled. Walmart Marketplace requires sellers to keep the cancel rate within the specified standard to ensure a positive customer experience. For more details about performance standards, refer to Seller Performance Standards.

This endpoint uses metrics like cumulative trends, shipping methods, and number of orders affected by invalid tracking information to calculate the percentage of orders that are canceled.

This page describes an example using only the required parameters and inputs to retrieve valid order cancellations 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

Endpoint

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

Sample request

This sample request gets a summary of the orders that were cancelled.

curl -X GET "https://marketplace.walmartapis.com/v3/insights/performance/cancellations/summary?reportDuration=30" \ -H "Authorization: Basic <BASE64_CLIENTID_SECRET>" \ -H "WM_SEC.ACCESS_TOKEN: <ACCESS_TOKEN>" \ -H "WM_QOS.CORRELATION_ID: 8c2b0d4a-0b6b-4e80-b3a8-0f9ad6c4b9d0" \ -H "WM_SVC.NAME: Walmart Marketplace" \ -H "WM_CONSUMER.CHANNEL.TYPE: your-channel-id"

import requests url = "https://marketplace.walmartapis.com/v3/insights/performance/cancellations/summary"
params = {"reportDuration": "30"}
headers = { "Authorization": "Basic <BASE64_CLIENTID_SECRET>", "WM_SEC.ACCESS_TOKEN": "<ACCESS_TOKEN>", "WM_QOS.CORRELATION_ID": "8c2b0d4a-0b6b-4e80-b3a8-0f9ad6c4b9d0", "WM_SVC.NAME": "Walmart Marketplace", "WM_CONSUMER.CHANNEL.TYPE": "your-channel-id",
} 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": 2, "cumulativeRateTrend": "Green_UP", "gmvLoss": 822.51, "ordersImpacted": 4, "ordersImpactedTrend": "GREEN_UP", "standard": "below 2%", "performanceStandard": "2% or below", "riskLevel": "MEETS STANDARD", "performanceRiskLevel": "Good", "sellerAccountableDrivers": { "outOfStockRate": 1.55, "pricingErrorRate": 0.52, "incMrkdAddNotSvcbleRate": 0, "shipWindowExpRate": 0 }, "nonAccountableDrivers": { "customerReqRate": 2.06, "customerFraudRate": 0, "miscellaneousRate": 0 }, "recommendations": [ { "recommendation": "Make sure you can make customers happy", "moreInfoLink": "https://sellerhelp.walmart.com/seller/s/guide?language=en_US&article=000007709" }, { "recommendation": "Running a promotion?", "moreInfoLink": "https://sellerhelp.walmart.com/s/guide?article=000006414&language=en_US" }, { "recommendation": "Don’t rush repricing", "moreInfoLink": "https://sellerhelp.walmart.com/seller/s/guide?article=000007695&language=en_US" } ] }, "status": "OK"
}

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, which indicates cancelled orders during the specified time duration were retrieved successfully.

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.