Carrier method accuracy summaries

Sellers can use this endpoint to review how often their shipments are shipped using the same carrier method that is configured in their Simplified Shipping Settings. You can call the endpoint to specify the number of days (14, 30, 60, 90) of order data to include in metric calculations.

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 their Simplified Shipping Settings.

The cumulativeRateTrend response parameter uses the statuses in the table below to explain if a trend is a positive or negative change.

Color	Description
GREEN GREEN_UP GREEN_DOWN	A positive change. The seller demonstrates strong performance and has a clear understanding of how to excel in this aspect of customer experience.
YELLOW YELLOW_UP YELLOW_DOWN	A negative change. The seller should monitor the metrics and improve their customers’ experiences.
RED RED_UP RED_DOWN	A critical change. It is urgent and needs to be resolved. The seller may face repercussions from the Marketplace team.

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 endpoint https://marketplace.walmartapis.com/v3/insights/performance/sss/cma/summary specifies that you are requesting the metrics summary for the percentage of orders that shipped out using the carrier method configure in your Simplified Shipping Settings.

The following example retrieves the metrics for orders from the past 30 days that were shipped using all shipping methods.

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/sss/cma/summary?reportDuration=30' \ -H 'accept: application/json' \ -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

This API endpoint responds with both a header and a body. The header response provides the details regarding the type of connection to the API server and when it received API call from the seller. The body response contains a payload map containing the various metrics used to calculate the valid tracking rate metrics.

Response Header

connection: keep-alive content-length: 305 content-type: application/json date: Tue,25 Feb 2025 22:42:59 GMT keep-alive: timeout=60 vary: Origin,Access-Control-Request-Method,Access-Control-Request-Headers

Response Body

{ "payload": { "reportDuration": 30, "updatedTimestamp": "2025-02-02T19:49:56Z", "cumulativeAccuracy": 100, "cumulativeAccuracyTrend": "GREEN_UP", "impactedOrderCount": 0, "recommendedAccuracy": 100, "infractionDrivers": { "USPS GROUND": 0 } }, "status": "OK"
}

Next steps

This GET Carrier method accuracy summary overview guide explains the basic parameters required to call this endpoint. You can refer to the full Reference guide to learn about optional parameters.