Get a selling partner's replenishment business metrics

Learn how to use the Replenishment API to return a selling partner's replenishment program (currently Subscribe & Save) business metrics. The following metrics are supported:

• SHIPPED_SUBSCRIPTION_UNITS
• TOTAL_SUBSCRIPTIONS_REVENUE
• ACTIVE_SUBSCRIPTIONS
• NOT_DELIVERED_DUE_TO_OOS
• SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REVENUE
• LOST_REVENUE_DUE_TO_OOS
• SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REORDERS
• COUPONS_REVENUE_PENETRATION
• REVENUE_BY_DELIVERIES
• SUBSCRIBER_RETENTION
• REVENUE_PENETRATION_BY_SELLER_FUNDING
• SHARE_OF_COUPON_SUBSCRIPTIONS

Refer to Metric for the metric names and descriptions.

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 all performance metrics aggregated over the specified frequency

To return a selling partner's past performance metrics, call the getSellingPartnerMetrics operation.

Step 2. Get a specific performance metric aggregated over the specified frequency

You can request specific metrics instead of returning all available metrics by providing the optional metrics parameter.

To return a selling partner's past performance metrics, call the getSellingPartnerMetrics operation.

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

To return forecast metrics for the next 30, 60, or 90 days, call the getSellingPartnerMetrics operation.

When you call the getSellingPartnerMetrics 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 parameter.

Data is available for the next 30, 60 and 90 days. To return forecast data you must represent a 30, 60, or 90 day period in the requested date-time range values that you provide for the timeInterval parameter. If the timeInterval you provide does not have a duration that exactly matches 30, 60, or 90 days, it is rounded up to provide the next higher number of forecast days.

For example, if the duration of the interval is 91 days, the response contains forecast metrics for the next 30, 60, and 90 days. If the duration is 89 days, the response contains forecast metrics for the next 30, 60, and 90 days. If the interval duration is 59 days, the response contains forecast metrics for the next 30 and 60 days.

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

Forecast metrics are available for sellers only.