Call this endpoint to retrieve Simplified Shipping Settings on-time shipment (OTS) for the specified number of days. The default value is 30. 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 shipped on-time. You can use this API to review if shipments are consistently shipping on time. For more details about performance standards, refer to Seller Performance Standards.

This page describes an example using only the required parameters and inputs to retrieve on-time shipment summary. 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/ots/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

Sample request

This sample request demonstrates how to request metrics summary for orders that were shipped. The following example retrieves the metrics for orders from the past 30 days.

curl -X GET "https://marketplace.walmartapis.com/v3/insights/performance/sss/ots/summary" \ -d reportDuration=30 \ -H "Authorization: Basic <BASE64_CLIENTID_COLON_SECRET>" \ -H "WM_SEC.ACCESS_TOKEN: <ACCESS_TOKEN>" \ -H "WM_QOS.CORRELATION_ID: 123e4567-e89b-12d3-a456-426614174000" \ -H "WM_SVC.NAME: Walmart Marketplace"

import requests url = "https://marketplace.walmartapis.com/v3/insights/performance/sss/sfla/report" headers = { "Authorization": "Basic <BASIC_AUTH_B64>", "WM_SEC.ACCESS_TOKEN": "<ACCESS_TOKEN>", "WM_CONSUMER.CHANNEL.TYPE": "<CHANNEL_ID>", "WM_QOS.CORRELATION_ID": "9f5e7f67-dc5b-4c1f-9d3f-1a9a2bbf1a12", "WM_SVC.NAME": "Walmart Marketplace", "Accept": "application/octet-stream",
} params = {"reportDuration": 30} response = requests.get(url, headers=headers, params=params)
print(response.status_code) with open("sss-sfla-report.xlsx", "wb") as f: f.write(response.content)

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 includes cumulative OTS rate and trend, impacted order counts and trends, and key infraction drivers.

{ "payload": { "reportDuration": 30, "updatedTimestamp": "2025-02-02T19:49:56Z", "cumulativeRate": 100, "cumulativeRateTrend": "GREEN_UP", "impactedOrderCount": 0, "impactedOrderTrend": "GREEN_UP", "recommendedRate": 100, "infractionDrivers": { "markedAsShippedLateRate": 0, "lateHandoverToCarrierRate": 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 on-time shipment summary for orders in 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.