Retrieve carrier method accuracy summary
Call this endpoint to get the carrier method accuracy summary metrics computed over a duration. You can use this API to review how often shipments are shipped using the same carrier method that is configured in Simplified Shipping Settings. 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 used the carrier method configured in Simplified Shipping Settings. For details on how to customize and configure carrier settings, refer to Simplified Shipping Settings.
This page describes an example using only the required parameters and inputs to retrieve on-time shipment reports. For a full list of customization options and additional capabilities, refer to the Marketplace Insights API Reference.
Endpoint
GET https://marketplace.walmartapis.com/v3/insights/performance/sss/cma/summary
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
| Color | Description |
|---|---|
| GREEN_UP GREEN_DOWN | A positive change or an improved performance in the metric compared to the previous report duration ending the day before. |
| NEUTRAL | Indicates 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. |
Sample request
This sample request demonstrates how to request the carrier method accuracy summary for the percentage of orders that shipped out using the carrier method configure in Simplified Shipping Settings.
curl -X GET 'https://marketplace.walmartapis.com/v3/insights/performance/sss/cma/summary?reportDuration=30' \ -H 'Authorization: Basic <BASE64_CLIENTID_SECRET>' \ -H 'WM_SEC.ACCESS_TOKEN: <ACCESS_TOKEN>' \ -H 'WM_CONSUMER.CHANNEL.TYPE: <CHANNEL_ID>' \ -H 'WM_QOS.CORRELATION_ID: 9a1a9b53-9d0b-4c2f-9cf2-3d7a1d0dbeac' \ -H 'WM_SVC.NAME: Walmart Marketplace' \ -H 'Accept: application/json'
import requests url = "https://marketplace.walmartapis.com/v3/insights/performance/sss/cma/summary" headers = { "Authorization": "Basic <BASE64_CLIENTID_SECRET>", "WM_SEC.ACCESS_TOKEN": "<ACCESS_TOKEN>", "WM_CONSUMER.CHANNEL.TYPE": "<CHANNEL_ID>", "WM_QOS.CORRELATION_ID": "9a1a9b53-9d0b-4c2f-9cf2-3d7a1d0dbeac", "WM_SVC.NAME": "Walmart Marketplace", "Accept": "application/json",
} params = {"reportDuration": 30} response = requests.get(url, headers=headers, params=params)
print(response.status_code)
print(response.text)
Modify your code
- Use a unique
WM_QOS.CORRELATION_IDfor each request. - Replace
WM_SEC.ACCESS_TOKENwith your valid access token obtained through authentication. - Replace
reportDurationwith the number of days (14, 30, 60, 90) of order data that you want to include in metric calculations.
Sample response
This sample response includes a summary of the cumulative accuracy, trend indicators, and infraction drivers.
{ "payload": { "reportDuration": 30, "updatedTimestamp": "2025-02-02T19:49:56Z", "cumulativeAccuracy": 100, "cumulativeAccuracyTrend": "GREEN_UP", "impactedOrderCount": 0, "impactedOrderTrend": "GREEN_UP", "recommendedAccuracy": 100, "infractionDrivers": { "USPS GROUND": 0 } }, "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. The metrics reflect carrier method accuracy summary for orders in the specified time 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.
Updated about 11 hours ago
