Call this endpoint to retrieve your current on-time shipment (OTS) report at the order level as an Excel (.xlsx) file. You can use this endpoint when you want to review your current on-time shipment (OTS) metric at the order-level. This metric tracks the percentage of their Simplified Shipping Settings orders that were shipped 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 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/ots/report

Sample request

This sample request demonstrates how to request a report containing the orders used to calculate your on-time shipment metrics.

curl -X 'GET' \ 'https://marketplace.walmartapis.com/v3/insights/performance/sss/ots/report?reportDuration=={{REPLACE_WITH_YOUR_REPORT_DURATION}' \ -H 'accept: application/octet-stream' \ -H ‘WM_SEC.ACCESS_TOKEN: eyABCDEFGHI123456789…’ \ -H 'WM_QOS.CORRELATION_ID: AAAAAAAA-1111-BBBB-2222-CCCC3333DDDD' \ -H 'WM_SVC.NAME: Walmart Service Name'

import requests url = "https://marketplace.walmartapis.com/v3/insights/performance/sss/ots/report" headers = { "Accept": "application/octet-stream", "WM_SEC.ACCESS_TOKEN": "eyABCDEFGHI123456789…", "WM_QOS.CORRELATION_ID": "AAAAAAAA-1111-BBBB-2222-CCCC3333DDDD", "WM_SVC.NAME": "Walmart Service Name",
} params = { "reportDuration": "{{REPLACE_WITH_YOUR_REPORT_DURATION}",
} response = requests.get(url, headers=headers, params=params)
print(response.status_code)
print(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

The following sample response shows the message displayed on successful file download.

string

Result

This call returns 200 OK with Excel file in body of the response.

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.