Retrieve valid tracking rate summary

Call this endpoint to retrieve valid tracking rate performance for a specified duration (14 days, 30 days, 90 days), including cumulative rate, trend indicators, impacted customer counts, seller accountable valid tracking rate, and risk level. This endpoint uses cumulative trends, shipping methods, and number of orders affected by invalid tracking information to calculate the percentage of orders with valid tracking information. For more details about performance standards, refer to Seller Performance Standards.

You can filter by shipping method and optionally set a custom report duration (days). Use the response to monitor valid tracking rate as defined by Walmart standards and prioritize fixes (for example, invalid tracking IDs or no carrier scans).

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

ColorDescription
GREEN_UP
GREEN_DOWN
A positive change or an improved performance in the metric compared to the previous report duration ending the day before.
NEUTRALIndicates 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.

Endpoint

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

Sample request

This sample request demonstrates how to request metric summary for orders from the past 30 days that were shipped.

curl -X GET "https://marketplace.walmartapis.com/v3/insights/performance/vtr/summary?reportDuration=30&shippingMethod=ALL_METHODS" \ -H "Authorization: Basic <BASE64_CLIENTID_SECRET>" \ -H "WM_SEC.ACCESS_TOKEN: <ACCESS_TOKEN>" \ -H "WM_QOS.CORRELATION_ID: 3a6aa0c5-6b1b-4f89-9c65-1e28a0b9a001" \ -H "WM_SVC.NAME: Walmart Marketplace"
import requests url = "https://marketplace.walmartapis.com/v3/insights/performance/vtr/summary"
params = {"reportDuration": "30", "shippingMethod": "ALL_METHODS"}
headers = { "Authorization": "Basic <BASE64_CLIENTID_SECRET>", "WM_SEC.ACCESS_TOKEN": "<ACCESS_TOKEN>", "WM_QOS.CORRELATION_ID": "3a6aa0c5-6b1b-4f89-9c65-1e28a0b9a001", "WM_SVC.NAME": "Walmart Marketplace", "Accept": "application/json",
} resp = requests.get(url, headers=headers, params=params, timeout=30)
resp.raise_for_status()
print(resp.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 days, 30 days, 90 days) 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 valid tracking rate metrics.

  • nonAccountableVtrDrivers - Metrics that do not affect the Seller Performance Standards.
  • sellerAccountableVtrDrivers - Metrics that affect the Seller Performance Standards.
{ "payload": { "updatedTimestamp": "1747279869000", "reportDuration": 30, "standard": "Above 99%", "performanceStandard": "99% or above", "riskLevel": "URGENT REVIEW", "performanceRiskLevel": "Urgent", "shippingMethod": "All methods", "cumulativeRate": 93.05, "cumulativeRateTrend": "neutral", "impactedCustomerCount": 21, "impactedCustomerTrend": "neutral", "sellerAccountableVtrDrivers": { "misleadingTrackingRate": 0.0, "nonIntegratedCarrierRate": 0.0, "invalidTrackingIdRate": 0.0, "invalidTrackingUrlRate": 0.0, "noCarrierScanRate": 6.95 }, "nonAccountableVtrDrivers": { "miscellaneousRate": 0.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 the valid tracking rate summary for orders in the specified duration.

The call returns a HTTP status of 204 if no data is available for the specified 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.