On-time shipment summaries

Sellers can use this endpoint to understand if their shipments are consistently shipping on-time. 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 are shipped on-time.

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 endpoint https://marketplace.walmartapis.com/v3/insights/performance/sss/ots/summary specifies that you are requesting the metrics summary for the percentage of orders that were shipped on-time.

The following example retrieves the metrics for orders from the past 30 days.

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/ots/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 on-time shipping metrics.

Response Header

connection: keep-alive content-length: 343 content-type: application/json date: Tue,25 Feb 2025 22:41:00 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", "cumulativeRate": 100, "cumulativeRateTrend": "GREEN_UP", "impactedOrderCount": 0, "recommendedRate": 100, "infractionDrivers": { "markedAsShippedLateRate": 0, "lateHandoverToCarrierRate": 0 } }, "status": "OK"
} 

Next steps

This GET On-time shipment summary guide explains how to use the basic configurations for make this API endpoint call. You can refer to the full Reference guide to understand how to customize the parameters for your specific use case.