Valid tracking rate summaries

Sellers can use this endpoint to understand if they are consistently providing customers with accurate order tracking information. Sellers need to maintain a percentage rate higher than 99% to ensure a positive customer experience. You can call the endpoint to specify the number of days (14, 30, 60, 90) of order data to include in metric calculations.

The endpoint returns metrics like cumulative trends, shipping methods, and number of orders affected by invalid tracking information to calculate the percentage of orders with valid tracking information.

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

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/vtr/summary specifies that you are requesting the metrics summary for the percentage of orders with valid tracking information.
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 this 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/vtr/summary?reportDuration={{REPLACE_WITH_YOUR_REPORT_DURATION}}' \ -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 contain payload, nonAccountableDrivers, and sellerAccountableDrivers maps containing the various metrics used to calculate the valid tracking rate metrics.

nonAccountableDrivers are metrics that will not affect the Seller Performance Standards metrics.
sellerAccountableDrivers are metrics that will affect the Seller Performance Standards metrics.

Response Header

connection: keep-alive content-length: 598 content-type: application/json date: Tue,25 Feb 2025 22:14:32 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", "shippingMethod": "ALL_METHODS", "cumulativeRate": 96.5, "cumulativeRateTrend": "RED_DOWN", "impactedCustomerCount": 3, "standard": "above 99%", "riskLevel": "Monitor", "sellerAccountableDrivers": { "misleadingTrackingRate": 0, "nonIntegratedCarrierRate": 1.13, "invalidTrackingIdRate": 0, "invalidTrackingUrlRate": 0, "noCarrierScanRate": 2.27 }, "nonAccountableDrivers": { "miscellaneousRate": 0 } }, "status": "OK"
} 

Next steps

This GET Valid tracking rate 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.