On-time delivery summaries

Sellers can use this endpoint to understand if their shipments are consistently delivered to their customers 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 that were delivered on-time to calculate the on-time delivery metrics.

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/otd/summary specifies that you are requesting the metrics summary for the percentage of orders that were delivered on-time.

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 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/otd/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 contain payload, sellerAccountableDrivers, and nonAccountableDrivers maps containing the various metrics used to calculate the on-time shipping 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: 1302 content-type: application/json date: Tue,25 Feb 2025 22:54:15 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", "overallRate": 89, "overallTrend": "RED_DOWN", "sellerAccountableRate": 96, "sellerAccountableTrend": "GREEN_UP", "impactedCustomerCount": 4, "standard": "above 95%", "riskLevel": "Monitor", "sellerAccountableDrivers": { "lateShipmentRate": 2, "carrierEDDLaterThanEDDRate": 2, "lateHandoverToCarrierRate": 0, "noCarrierScanRate": 0, "carrierMethodMismatchRate": 0, "shipLocationMismatchRate": 0 }, "nonAccountableDrivers": { "carrierDelaysRate": 4, "carrierExceptionRate": 3, "miscellaneousRate": 0 }, "recommendations": [ { "recommendation": "Work with your carriers", "moreInfoLink": "https://sellerhelp.walmart.com/seller/s/guide?article=000009473&language=en_US" }, { "recommendation": "Don’t push your deadlines", "moreInfoLink": "https://sellerhelp.walmart.com/seller/s/guide?language=en_US&article=000007893" }, { "recommendation": "Let us handle fulfillment", "moreInfoLink": "https://seller.walmart.com/walmart-fulfillment" } ] }, "status": "OK"
} 

Next steps

This GET On-time delivery 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.