Ship-from location accuracy summaries

Sellers can use this endpoint to track the percentage of their Simplified Shipping Settings orders that shipped from the same location configured in their Simplified Shipping Settings.

This endpoint uses metrics like cumulative trends, shipping methods, and number of orders that didn’t use the configured ship-from locations to calculate ship-from location accuracy metric.

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/sfla/summary specifies that you are requesting the metrics for the percentage of orders shipped from the same location set in your Simplified Shipping Settings.

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/sfla/summary?reportDuration={{REPLACE_WITH_YOUR_REPORT_DURATION}}' \ -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 ship-from location accuracy metrics.

Response Header

connection: keep-alive content-length: 314 content-type: application/json date: Tue,25 Feb 2025 22:24:58 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", "cumulativeAccuracy": 97.1, "cumulativeAccuracyTrend": "GREEN_UP", "impactedOrderCount": 1, "recommendedAccuracy": 100, "infractionDrivers": { "Mount Bethel, PA": 2.86 } }, "status": "OK"
} 

Next steps

This GET Ship-from location accuracy 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.