Get replenishment business metrics for each of a selling partner's offers

Learn how to use the Replenishment API to return a selling partner's replenishment metrics at the offer level.

Prerequisites

To successfully complete this tutorial, you must have:

• Authorization from the selling partner for whom you are making calls. Refer to the Authorizing Selling Partner API applications for more information.
• The Brand Analytics role assigned to your developer profile.
• The Brand Analytics role selected in the app registration page for your application.
• The marketplace identifier for the marketplace for which to return data. Refer to Marketplace IDs to find the identifier for a marketplace. Refer to the Replenishment API v2022-11-07 reference for details about supported marketplaces.

Step 1. Get performance metrics data aggregated over the specified frequency

To return a selling partner's performance metrics for every offer, call the listOfferMetrics operation.

Step 2. Get forecast metrics data for the next 30, 60, or 90 days (applicable only for sellers)

To return forecast metrics data for every offer, call the listOfferMetrics operation.

When you call the listOfferMetrics operation you can choose to return forward-looking forecast metrics instead of past performance metrics. To request forecast metrics, specify FORECAST as the value for the timePeriodType property in the filters parameter.

The listOfferMetrics operation only supports a time interval which covers a single unit of the aggregation frequency. For example, for a MONTH aggregation frequency, the duration of the interval between the startDate and endDate can not be more than one month.

The TOTAL_SUBSCRIPTIONS_REVENUE and SHIPPED_SUBSCRIPTION_UNITS metrics are the only forecast metrics supported.

Forecast metrics are available for sellers only.