Seller Performance API endpoints
Overview
Seller Performance API endpoints make key business metrics readily accessible via APIs. Authorized users can quickly generate and download .xlsx file format datasets analyzing eCommerce metrics like:
- On-Time Delivery Rate
- Valid Tracking Rate
- Seller Response Rate
- Refund Rate
- Cancellation Rate
Users could download customized dataset files and retrieve metrics for single aspect of their business.
To ensure accuracy, datasets are refreshed every twenty-four (24) hours.
Reference guide
Seller Performance API Reference Guide
Prerequisites
- API Keys (clientID and clientSecret)
- Approved sellers retrieve API keys from the Developer Portal Key Generator
- Sellers need to generate or refresh Authentication tokens every twenty four (24) hours
- Seller Center Account Access (Create a Seller Center account)
Market availability
This collection of API endpoints is available for the US Marketplace.
Seller Performance endpoints
| Request | Description | Call Type | Type (SYNC/ASYNC) | Rates/Limits (Transactions per minute) |
|---|---|---|---|---|
| Valid Tracking Rate | Returns the valid tracking rate metrics | GET | SYNC | 1 call per minute per seller You may receive a HTTP 429 error if you exceed this limit. |
| Orders - Valid Tracking Rate | Downloads a file to your computer with all orders affecting the Valid Tracking Rate metrics. File format: Microsoft .xlsx file | GET | SYNC | 1 call per minute per seller You may receive a HTTP 429 error if you exceed this limit. |
| Simplified Shipping Settings - Ship from Location Accuracy | Returns metrics for how often the ship from locations are correct. | GET | SYNC | 1 call per minute per seller You may receive a HTTP 429 error if you exceed this limit. |
| Simplified Shipping Settings - Orders - Ship from Location Accuracy | Downloads a file to your computer with all orders affecting the Ship from Location Accuracy metrics. File format: Microsoft .xlsx file | GET | SYNC | 1 call per minute per seller You may receive a HTTP 429 error if you exceed this limit. |
| Simplified Shipping Settings - Orders - On Time Shipment | Downloads a file to your computer with all orders affecting the On Time Shipment metrics. File format: Microsoft .xlsx file | GET | ASYNC | 1 call per minute per seller You may receive a HTTP 429 error if you exceed this limit. |
| Simplified Shipping Settings - On Time Shipment | Returns metrics for how often the shipments are on time. | GET | SYNC | 1 call per minute per seller You may receive a HTTP 429 error if you exceed this limit. |
| Simplified Shipping Settings - Orders - Carrier Method Accuracy | Downloads a file to your computer with all orders affecting the Carrier Method Accuracy metrics. File format: Microsoft .xlsx file | GET | SYNC | 1 call per minute per seller You may receive a HTTP 429 error if you exceed this limit. |
| Simplified Shipping Settings - Carrier Method Accuracy | Returns metrics for how often the carrier methods are accurate. | GET | SYNC | 1 call per minute per seller You may receive a HTTP 429 error if you exceed this limit. |
| Seller Response Rate | Returns metrics of how often the seller responds to customer inquiries within 48 hours of receipt. | GET | SYNC | 1 call per minute per seller You may receive a HTTP 429 error if you exceed this limit. |
| Refund Performance Metrics | Returns a seller's percentage of returns metrics. | GET | SYNC | 1 call per minute per seller You may receive a HTTP 429 error if you exceed this limit. |
| Orders - Refunds | Downloads a file to your computer with all orders affecting the Orders Refunds Rate metrics. File format: Microsoft .xlsx file | GET | SYNC | 1 call per minute per seller You may receive a HTTP 429 error if you exceed this limit. |
| Orders - Seller Response Rate | Downloads a file to your computer with all orders affecting the Seller Response Rate metrics. File format: Microsoft .xlsx file | GET | SYNC | 1 call per minute per seller You may receive a HTTP 429 error if you exceed this limit. |
| Orders - On Time Delivery | Downloads a file to your computer with all orders affecting the On Time Delivery Rate metrics. File format: Microsoft .xlsx file | GET | SYNC | 1 call per minute per seller You may receive a HTTP 429 error if you exceed this limit. |
| On Time Delivery | Returns the metrics of percentage of orders delivered on time to the customer. | GET | SYNC | 1 call per minute per seller You may receive a HTTP 429 error if you exceed this limit. |
| Cancellations | Returns the percentage of canceled orders metrics. | GET | SYNC | 1 call per minute per seller You may receive a HTTP 429 error if you exceed this limit. |
| Orders - Cancellations | Downloads a file to your computer with all orders affecting the Orders Cancellation metrics. File format: Microsoft .xlsx file | GET | SYNC | 1 call per minute per seller You may receive a HTTP 429 error if you exceed this limit. |
Updated about 1 month ago