Replenishment API
Learn how to return a selling partner's replenishment program metrics and offer information.
You use the Replenishment API to retrieve information about a selling partner's replenishment program business. Currently, the <<glossary:Subscribe & Save>> replenishment program is supported. With the Replenishment API, you can create applications that return metrics about a selling partner's replenishment business performance and information about their replenishment program offers.
Some attributes or use cases might not be applicable to both sellers and vendors. Refer to the Replenishment API v2022-11-07 reference for details.
The Replenishment API is available wherever Amazon Subscribe & Save is live. The API is also available to vendors and Fulfillment by Amazon (FBA) selling partners.
Release notes
To learn more about the terms that are used on this page, refer to Terminology.
Use cases
- Get all of a selling partner's replenishment offers filtered by specific criteria: Return a selling partner's replenishment (currently Subscribe & Save) offers based on filtering criteria.
- Get a selling partner's replenishment business metrics: Return a selling partner's replenishment program (currently Subscribe & Save) business metrics.
- Get replenishment business metrics for each of a selling partner's offers: Return a selling partner's replenishment metrics at an ASIN level.
Roles
getSellingPartnerMetrics
| Attribute | Value |
|---|---|
| Regions | NA, EU, FE |
| Required roles (need at least one) | Brand Analytics Inventory and Order Tracking |
listOfferMetrics
| Attribute | Value |
|---|---|
| Regions | NA, EU, FE |
| Required roles (need at least one) | Brand Analytics Inventory and Order Tracking |
listOffers
| Attribute | Value |
|---|---|
| Regions | NA, EU, FE |
| Required roles (need at least one) | Brand Analytics Inventory and Order Tracking |
Updated about 3 hours ago