Overview
Optimize your business with metrics from Seller Performance API endpoints. Sellers and approved Solution Providers can generate and download datasets in Microsoft Excel (.xlsx) file format to analyze eCommerce metrics, such as:
- On-time delivery rate
- Valid tracking rate
- Seller response rate
- Refund rate
- Cancellation rate
- Carrier method accuracy
- On-time shipment
- Ship-from location accuracy
You can download customized datasets and get metrics for their business.
To ensure accuracy, datasets refresh every 24 hours.
Consider the following prerequisites to use Marketplace APIs
- API Keys (clientID and clientSecret):
- Sellers can retrieve API keys from the Developer Portal and use the keys to call Marketplace APIs.
- Sellers must generate or refresh Authentication tokens every 24 hours.
- If you are a solution provider, refer to the Getting Started Guide for approved Solution Providers.
- OAuth 2.0 authentication is required to access the Walmart Marketplace APIs. Ensure that you have obtained the necessary credentials and tokens before making API requests. For more information, refer to OAuth 2.0 authorization.
Market availability
The Walmart Seller Performance API is available for sellers listing in the U.S. marketplace.
Refer to the links below for additional guidance
- Review the Seller Performance Standards to keep your account in good standing.
- Review our guide on Order and fulfillment performance to understand how order and fulfillment performance affect your seller performance metrics.
How to use Seller Performance API endpoints
There are two sets of endpoints a seller can use to monitor their Seller Performance metrics. The standard metrics provide the seller with data they require to understand if they are consistently meeting their customers’ expectations and providing quality service to them. The Simplified Shipping Settings API offers sellers valuable insights into their adherence to the configurations established within the Simplified Shipping Settings.
Report and summary endpoints
There are two types of Seller Performance Standards endpoints.
The report endpoint downloads an Excel file with the orders used to calculate the metric percentages for a set number of days and specified order types.
The summary endpoint calculates the metric percentages and provides a summary for a set number of days and specified order types.
Both types of endpoints support using orders spanning 14, 30, 60, or 90 days.
Standard metric endpoints
- GET | On-time delivery summary
- GET | On-time delivery report
- GET | Cancelations summary
- GET | Cancelations report
- GET | Valid tracking rate summary
- GET | Valid tracking rate report
- GET | Seller response rate summary
- GET | Seller response rate report
- GET | Refunds summary
- GET | Refunds report
Simplified Shipping Settings metric endpoints
Updated about 17 hours ago