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

Market availability

This collection of API endpoints is available for the US Marketplace.

Seller Performance endpoints

RequestDescriptionCall TypeType (SYNC/ASYNC)Rates/Limits (Transactions per minute)
Valid Tracking RateReturns the valid tracking rate metricsGETSYNC1 call per minute per seller

You may receive a HTTP 429 error if you exceed this limit.
Orders - Valid Tracking RateDownloads a file to your computer with all orders affecting the Valid Tracking Rate metrics.

File format: Microsoft .xlsx file
GETSYNC1 call per minute per seller

You may receive a HTTP 429 error if you exceed this limit.
Simplified Shipping Settings - Ship from Location AccuracyReturns metrics for how often the ship from locations are correct.GETSYNC1 call per minute per seller

You may receive a HTTP 429 error if you exceed this limit.
Simplified Shipping Settings - Orders - Ship from Location AccuracyDownloads a file to your computer with all orders affecting the Ship from Location Accuracy metrics.

File format: Microsoft .xlsx file
GETSYNC1 call per minute per seller

You may receive a HTTP 429 error if you exceed this limit.
Simplified Shipping Settings - Orders - On Time ShipmentDownloads a file to your computer with all orders affecting the On Time Shipment metrics.

File format: Microsoft .xlsx file
GETASYNC1 call per minute per seller

You may receive a HTTP 429 error if you exceed this limit.
Simplified Shipping Settings - On Time ShipmentReturns metrics for how often the shipments are on time.GETSYNC1 call per minute per seller

You may receive a HTTP 429 error if you exceed this limit.
Simplified Shipping Settings - Orders - Carrier Method AccuracyDownloads a file to your computer with all orders affecting the Carrier Method Accuracy metrics.

File format: Microsoft .xlsx file
GETSYNC1 call per minute per seller

You may receive a HTTP 429 error if you exceed this limit.
Simplified Shipping Settings - Carrier Method AccuracyReturns metrics for how often the carrier methods are accurate.GETSYNC1 call per minute per seller

You may receive a HTTP 429 error if you exceed this limit.
Seller Response RateReturns metrics of how often the seller responds to customer inquiries within 48 hours of receipt.GETSYNC1 call per minute per seller

You may receive a HTTP 429 error if you exceed this limit.
Refund Performance MetricsReturns a seller's percentage of returns metrics.GETSYNC1 call per minute per seller

You may receive a HTTP 429 error if you exceed this limit.
Orders - RefundsDownloads a file to your computer with all orders affecting the Orders Refunds Rate metrics.

File format: Microsoft .xlsx file
GETSYNC1 call per minute per seller

You may receive a HTTP 429 error if you exceed this limit.
Orders - Seller Response RateDownloads a file to your computer with all orders affecting the Seller Response Rate metrics.

File format: Microsoft .xlsx file
GETSYNC1 call per minute per seller

You may receive a HTTP 429 error if you exceed this limit.
Orders - On Time DeliveryDownloads a file to your computer with all orders affecting the On Time Delivery Rate metrics.

File format: Microsoft .xlsx file
GETSYNC1 call per minute per seller

You may receive a HTTP 429 error if you exceed this limit.
On Time DeliveryReturns the metrics of percentage of orders delivered on time to the customer.GETSYNC1 call per minute per seller

You may receive a HTTP 429 error if you exceed this limit.
CancellationsReturns the percentage of canceled orders metrics.GETSYNC1 call per minute per seller

You may receive a HTTP 429 error if you exceed this limit.
Orders - CancellationsDownloads a file to your computer with all orders affecting the Orders Cancellation metrics.

File format: Microsoft .xlsx file
GETSYNC1 call per minute per seller

You may receive a HTTP 429 error if you exceed this limit.