listOfferMetrics

post https://sellingpartnerapi-na.amazon.com/replenishment/2022-11-07/offers/metrics/search

Returns aggregated replenishment program metrics for a selling partner's offers.

Usage Plan:

Rate (requests per second)	Burst
1	1

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Responses

Response body

object

offers

array of objects

A list of offers and associated metrics.

offers

object

asin

string

The Amazon Standard Identification Number (ASIN).

notDeliveredDueToOOS

double

0 to 100

The percentage of items that were not shipped out of the total shipped units over a period of time due to being out of stock. Applicable to PERFORMANCE timePeriodType.

totalSubscriptionsRevenue

double

≥ 0

The revenue generated from subscriptions over a period of time. Applicable to PERFORMANCE timePeriodType.

shippedSubscriptionUnits

number

≥ 0

The number of units shipped to the subscribers over a period of time. Applicable to PERFORMANCE timePeriodType.

activeSubscriptions

number

≥ 0

The number of active subscriptions present at the end of the period. Applicable to PERFORMANCE timePeriodType.

revenuePenetration

double

0 to 100

The percentage of total program revenue out of total product revenue. Applicable to PERFORMANCE timePeriodType.

lostRevenueDueToOOS

double

≥ 0

The revenue that would have been generated had there not been out of stock. Applicable to PERFORMANCE timePeriodType.

couponsRevenuePenetration

double

0 to 100

The percentage of revenue from ASINs with coupons out of total revenue from all ASINs. Applicable to PERFORMANCE timePeriodType.

shareOfCouponSubscriptions

double

0 to 100

The percentage of new subscriptions acquired through coupons. Applicable to PERFORMANCE timePeriodType.

next30DayTotalSubscriptionsRevenue

double

≥ 0

The forecasted total subscription revenue for the next 30 days. Applicable to FORECAST timePeriodType.

next60DayTotalSubscriptionsRevenue

double

≥ 0

The forecasted total subscription revenue for the next 60 days. Applicable to FORECAST timePeriodType.

next90DayTotalSubscriptionsRevenue

double

≥ 0

The forecasted total subscription revenue for the next 90 days. Applicable to FORECAST timePeriodType.

next30DayShippedSubscriptionUnits

number

≥ 0

The forecasted shipped subscription units for the next 30 days. Applicable to FORECAST timePeriodType.

next60DayShippedSubscriptionUnits

number

≥ 0

The forecasted shipped subscription units for the next 60 days. Applicable to FORECAST timePeriodType.

next90DayShippedSubscriptionUnits

number

≥ 0

The forecasted shipped subscription units for the next 90 days. Applicable to FORECAST timePeriodType.

timeInterval

object

A date-time interval in ISO 8601 format which is used to compute metrics. Only the date is required, but you must pass the complete date and time value. For example, November 11, 2022 should be passed as "2022-11-07T00:00:00Z". Note that only data for the trailing 2 years is supported.

Note: 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 1 month.

currencyCode

string

The currency code in ISO 4217 format.

pagination

object

Use these parameters to paginate through the response.

totalResults

int64

≥ 0

Total number of results matching the given filter criteria.

Headers

object

x-amzn-RateLimit-Limit

string

Your rate limit (requests per second) for this operation.

x-amzn-RequestId

string

Unique request reference identifier.

Language


xxxxxxxxxx
15
1
curl --request POST \
2
     --url https://sellingpartnerapi-na.amazon.com/replenishment/2022-11-07/offers/metrics/search \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "sort": {
8
    "order": "ASC",
9
    "key": "SHIPPED_SUBSCRIPTION_UNITS"
10
  },
11
  "filters": {
12
    "timePeriodType": "PERFORMANCE"
13
  }
14
}
15
'


xxxxxxxxxx
37
}
1
{
2
  "offers": [
3
    {
4
      "notDeliveredDueToOOS": 30.78,
5
      "shippedSubscriptionUnits": 20,
6
      "totalSubscriptionsRevenue": 12.89,
7
      "asin": "B000TMUDOW",
8
      "revenuePenetration": 10.34,
9
      "lostRevenueDueToOOS": 12.32,
10
      "couponsRevenuePenetration": 10,
11
      "shareOfCouponSubscriptions": 24.04,
12
      "timeInterval": {
13
        "endDate": "2023-03-11T00:00:00Z",
14
        "startDate": "2023-03-05T00:00:00Z"
15
      },
16
      "currencyCode": "USD"
17
    },
18
    {
19
      "notDeliveredDueToOOS": 40.78,
20
      "shippedSubscriptionUnits": 40,
21
      "totalSubscriptionsRevenue": 34.03,
22
      "asin": "B004CLH5CY",
23
      "revenuePenetration": 9.87,
24
      "lostRevenueDueToOOS": 17.82,
25
      "couponsRevenuePenetration": 17,

200Success.

400Request has missing or invalid parameters and cannot be parsed.

401The request's Authorization header is not formatted correctly or does not contain a valid token.

403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.

404The specified resource does not exist.

413The request size exceeded the maximum accepted size.

415The request payload is in an unsupported format.

429The frequency of requests was greater than allowed.

500An unexpected condition occurred that prevented the server from fulfilling the request.

503Temporary overloading or maintenance of the server.