@sp-api-sdk/replenishment-api-2022-11-07 2.4.6 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/dist/cjs/api-model/models/metric.js +5 -1
  2. package/dist/es/api-model/models/metric.js +5 -1
  3. package/dist/types/api-model/models/get-selling-partner-metrics-response-metric.d.ts +70 -10
  4. package/dist/types/api-model/models/list-offer-metrics-response-offer.d.ts +19 -13
  5. package/dist/types/api-model/models/metric.d.ts +4 -0
  6. package/package.json +3 -3
package/dist/cjs/api-model/models/metric.js CHANGED
@@ -27,5 +27,9 @@ exports.Metric = {
27
27
  SubscriberNonSubscriberAverageRevenue: 'SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REVENUE',
28
28
  LostRevenueDueToOos: 'LOST_REVENUE_DUE_TO_OOS',
29
29
  SubscriberNonSubscriberAverageReorders: 'SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REORDERS',
30
- CouponsRevenuePenetration: 'COUPONS_REVENUE_PENETRATION'
30
+ CouponsRevenuePenetration: 'COUPONS_REVENUE_PENETRATION',
31
+ RevenueByDeliveries: 'REVENUE_BY_DELIVERIES',
32
+ SubscriberRetention: 'SUBSCRIBER_RETENTION',
33
+ RevenuePenetrationBySellerFunding: 'REVENUE_PENETRATION_BY_SELLER_FUNDING',
34
+ ShareOfCouponSubscriptions: 'SHARE_OF_COUPON_SUBSCRIPTIONS'
31
35
  };
package/dist/es/api-model/models/metric.js CHANGED
@@ -24,5 +24,9 @@ export const Metric = {
24
24
  SubscriberNonSubscriberAverageRevenue: 'SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REVENUE',
25
25
  LostRevenueDueToOos: 'LOST_REVENUE_DUE_TO_OOS',
26
26
  SubscriberNonSubscriberAverageReorders: 'SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REORDERS',
27
- CouponsRevenuePenetration: 'COUPONS_REVENUE_PENETRATION'
27
+ CouponsRevenuePenetration: 'COUPONS_REVENUE_PENETRATION',
28
+ RevenueByDeliveries: 'REVENUE_BY_DELIVERIES',
29
+ SubscriberRetention: 'SUBSCRIBER_RETENTION',
30
+ RevenuePenetrationBySellerFunding: 'REVENUE_PENETRATION_BY_SELLER_FUNDING',
31
+ ShareOfCouponSubscriptions: 'SHARE_OF_COUPON_SUBSCRIPTIONS'
28
32
  };
package/dist/types/api-model/models/get-selling-partner-metrics-response-metric.d.ts CHANGED
@@ -17,65 +17,125 @@ import type { TimeInterval } from './time-interval';
17
17
  */
18
18
  export interface GetSellingPartnerMetricsResponseMetric {
19
19
  /**
20
- * 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 only for the `PERFORMANCE` `timePeriodType`.
20
+ * 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.
21
21
  * @type {number}
22
22
  * @memberof GetSellingPartnerMetricsResponseMetric
23
23
  */
24
24
  'notDeliveredDueToOOS'?: number;
25
25
  /**
26
- * The revenue generated from subscriptions over a period of time. Applicable for both the `PERFORMANCE` and `FORECAST` `timePeriodType`.
26
+ * The revenue generated from subscriptions over a period of time. Applicable for both the PERFORMANCE and FORECAST timePeriodType.
27
27
  * @type {number}
28
28
  * @memberof GetSellingPartnerMetricsResponseMetric
29
29
  */
30
30
  'totalSubscriptionsRevenue'?: number;
31
31
  /**
32
- * The number of units shipped to the subscribers over a period of time. Applicable for both the `PERFORMANCE` and `FORECAST` `timePeriodType`.
32
+ * The number of units shipped to the subscribers over a period of time. Applicable for both the PERFORMANCE and FORECAST timePeriodType.
33
33
  * @type {number}
34
34
  * @memberof GetSellingPartnerMetricsResponseMetric
35
35
  */
36
36
  'shippedSubscriptionUnits'?: number;
37
37
  /**
38
- * The number of active subscriptions present at the end of the period. Applicable only for the `PERFORMANCE` `timePeriodType`.
38
+ * The number of active subscriptions present at the end of the period. Applicable to PERFORMANCE timePeriodType.
39
39
  * @type {number}
40
40
  * @memberof GetSellingPartnerMetricsResponseMetric
41
41
  */
42
42
  'activeSubscriptions'?: number;
43
43
  /**
44
- * The average revenue per subscriber of the program over a period of past 12 months for sellers and 6 months for vendors. Applicable only for the `PERFORMANCE` `timePeriodType`.
44
+ * The average revenue per subscriber of the program over a period of past 12 months for sellers and 6 months for vendors. Applicable to PERFORMANCE timePeriodType.
45
45
  * @type {number}
46
46
  * @memberof GetSellingPartnerMetricsResponseMetric
47
47
  */
48
48
  'subscriberAverageRevenue'?: number;
49
49
  /**
50
- * The average revenue per non-subscriber of the program over a period of past 12 months for sellers and 6 months for vendors. Applicable only for the `PERFORMANCE` `timePeriodType`.
50
+ * The average revenue per non-subscriber of the program over a period of past 12 months for sellers and 6 months for vendors. Applicable to PERFORMANCE timePeriodType.
51
51
  * @type {number}
52
52
  * @memberof GetSellingPartnerMetricsResponseMetric
53
53
  */
54
54
  'nonSubscriberAverageRevenue'?: number;
55
55
  /**
56
- * The revenue that would have been generated had there not been out of stock. Applicable only for the PERFORMANCE timePeriodType.
56
+ * The revenue that would have been generated had there not been out of stock. Applicable to PERFORMANCE timePeriodType.
57
57
  * @type {number}
58
58
  * @memberof GetSellingPartnerMetricsResponseMetric
59
59
  */
60
60
  'lostRevenueDueToOOS'?: number;
61
61
  /**
62
- * The average reorders per subscriber of the program over a period of 12 months. Applicable only for the PERFORMANCE timePeriodType.
62
+ * The average reorders per subscriber of the program over a period of 12 months. Applicable to PERFORMANCE timePeriodType.
63
63
  * @type {number}
64
64
  * @memberof GetSellingPartnerMetricsResponseMetric
65
65
  */
66
66
  'subscriberAverageReorders'?: number;
67
67
  /**
68
- * The average reorders per non-subscriber of the program over a period of past 12 months. Applicable only for the PERFORMANCE timePeriodType.
68
+ * The average reorders per non-subscriber of the program over a period of past 12 months. Applicable to PERFORMANCE timePeriodType.
69
69
  * @type {number}
70
70
  * @memberof GetSellingPartnerMetricsResponseMetric
71
71
  */
72
72
  'nonSubscriberAverageReorders'?: number;
73
73
  /**
74
- * The percentage of revenue from ASINs with coupons out of total revenue from all ASINs. Applicable only for the PERFORMANCE timePeriodType.
74
+ * The percentage of revenue from ASINs with coupons out of total revenue from all ASINs. Applicable to PERFORMANCE timePeriodType.
75
75
  * @type {number}
76
76
  * @memberof GetSellingPartnerMetricsResponseMetric
77
77
  */
78
78
  'couponsRevenuePenetration'?: number;
79
+ /**
80
+ * The subscription revenue generated from subscriptions with over two deliveries over the past 12 months. Applicable to PERFORMANCE timePeriodType.
81
+ * @type {number}
82
+ * @memberof GetSellingPartnerMetricsResponseMetric
83
+ */
84
+ 'revenueFromSubscriptionsWithMultipleDeliveries'?: number;
85
+ /**
86
+ * The subscription revenue generated from active subscriptions with one delivery over the past 12 months. Applicable to PERFORMANCE timePeriodType.
87
+ * @type {number}
88
+ * @memberof GetSellingPartnerMetricsResponseMetric
89
+ */
90
+ 'revenueFromActiveSubscriptionsWithSingleDelivery'?: number;
91
+ /**
92
+ * The subscription revenue generated from subscriptions which are cancelled after one delivery over the past 12 months. Applicable to PERFORMANCE timePeriodType.
93
+ * @type {number}
94
+ * @memberof GetSellingPartnerMetricsResponseMetric
95
+ */
96
+ 'revenueFromCancelledSubscriptionsAfterSingleDelivery'?: number;
97
+ /**
98
+ * The percentage of subscriptions retained after 30 days of subscription creation. Applicable to PERFORMANCE timePeriodType.
99
+ * @type {number}
100
+ * @memberof GetSellingPartnerMetricsResponseMetric
101
+ */
102
+ 'subscriberRetentionFor30Days'?: number;
103
+ /**
104
+ * The percentage of subscriptions retained after 90 days of subscription creation. Applicable to PERFORMANCE timePeriodType.
105
+ * @type {number}
106
+ * @memberof GetSellingPartnerMetricsResponseMetric
107
+ */
108
+ 'subscriberRetentionFor90Days'?: number;
109
+ /**
110
+ * The percentage of subscription revenue generated by offers with 0% seller-funded discount over the last 12 months. Applicable to PERFORMANCE timePeriodType.
111
+ * @type {number}
112
+ * @memberof GetSellingPartnerMetricsResponseMetric
113
+ */
114
+ 'revenuePenetrationFor0PercentSellerFunding'?: number;
115
+ /**
116
+ * [Applicable only for Sellers] The percentage of subscription revenue generated by offers with 5% seller-funded discount over the last 12 months. Applicable to PERFORMANCE timePeriodType.
117
+ * @type {number}
118
+ * @memberof GetSellingPartnerMetricsResponseMetric
119
+ */
120
+ 'revenuePenetrationFor5PercentSellerFunding'?: number;
121
+ /**
122
+ * [Applicable only for Sellers] The percentage of subscription revenue generated by offers with 10% seller-funded discount over the last 12 months. Applicable to PERFORMANCE timePeriodType.
123
+ * @type {number}
124
+ * @memberof GetSellingPartnerMetricsResponseMetric
125
+ */
126
+ 'revenuePenetrationFor10PercentSellerFunding'?: number;
127
+ /**
128
+ * [Applicable only for vendors] The percentage of subscription revenue generated by offers with 5% or above seller-funded discount over the last 12 months. Applicable to PERFORMANCE timePeriodType.
129
+ * @type {number}
130
+ * @memberof GetSellingPartnerMetricsResponseMetric
131
+ */
132
+ 'revenuePenetrationFor5PlusPercentSellerFunding'?: number;
133
+ /**
134
+ * The percentage of new subscriptions acquired through coupons. Applicable to PERFORMANCE timePeriodType.
135
+ * @type {number}
136
+ * @memberof GetSellingPartnerMetricsResponseMetric
137
+ */
138
+ 'shareOfCouponSubscriptions'?: number;
79
139
  /**
80
140
  *
81
141
  * @type {TimeInterval}
package/dist/types/api-model/models/list-offer-metrics-response-offer.d.ts CHANGED
@@ -23,79 +23,85 @@ export interface ListOfferMetricsResponseOffer {
23
23
  */
24
24
  'asin'?: string;
25
25
  /**
26
- * 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 only for the `PERFORMANCE` `timePeriodType`.
26
+ * 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.
27
27
  * @type {number}
28
28
  * @memberof ListOfferMetricsResponseOffer
29
29
  */
30
30
  'notDeliveredDueToOOS'?: number;
31
31
  /**
32
- * The revenue generated from subscriptions over a period of time. Applicable only for the `PERFORMANCE` `timePeriodType`.
32
+ * The revenue generated from subscriptions over a period of time. Applicable to PERFORMANCE timePeriodType.
33
33
  * @type {number}
34
34
  * @memberof ListOfferMetricsResponseOffer
35
35
  */
36
36
  'totalSubscriptionsRevenue'?: number;
37
37
  /**
38
- * The number of units shipped to the subscribers over a period of time. Applicable only for the `PERFORMANCE` `timePeriodType`.
38
+ * The number of units shipped to the subscribers over a period of time. Applicable to PERFORMANCE timePeriodType.
39
39
  * @type {number}
40
40
  * @memberof ListOfferMetricsResponseOffer
41
41
  */
42
42
  'shippedSubscriptionUnits'?: number;
43
43
  /**
44
- * The number of active subscriptions present at the end of the period. Applicable only for the `PERFORMANCE` `timePeriodType`.
44
+ * The number of active subscriptions present at the end of the period. Applicable to PERFORMANCE timePeriodType.
45
45
  * @type {number}
46
46
  * @memberof ListOfferMetricsResponseOffer
47
47
  */
48
48
  'activeSubscriptions'?: number;
49
49
  /**
50
- * The percentage of total program revenue out of total product revenue. Applicable only for the `PERFORMANCE` `timePeriodType`.
50
+ * The percentage of total program revenue out of total product revenue. Applicable to PERFORMANCE timePeriodType.
51
51
  * @type {number}
52
52
  * @memberof ListOfferMetricsResponseOffer
53
53
  */
54
54
  'revenuePenetration'?: number;
55
55
  /**
56
- * The revenue that would have been generated had there not been out of stock. Applicable only for the PERFORMANCE timePeriodType.
56
+ * The revenue that would have been generated had there not been out of stock. Applicable to PERFORMANCE timePeriodType.
57
57
  * @type {number}
58
58
  * @memberof ListOfferMetricsResponseOffer
59
59
  */
60
60
  'lostRevenueDueToOOS'?: number;
61
61
  /**
62
- * The percentage of revenue from ASINs with coupons out of total revenue from all ASINs. Applicable only for the PERFORMANCE timePeriodType.
62
+ * The percentage of revenue from ASINs with coupons out of total revenue from all ASINs. Applicable to PERFORMANCE timePeriodType.
63
63
  * @type {number}
64
64
  * @memberof ListOfferMetricsResponseOffer
65
65
  */
66
66
  'couponsRevenuePenetration'?: number;
67
67
  /**
68
- * The forecasted total subscription revenue for the next 30 days. Applicable only for the `FORECAST` `timePeriodType`.
68
+ * The percentage of new subscriptions acquired through coupons. Applicable to PERFORMANCE timePeriodType.
69
+ * @type {number}
70
+ * @memberof ListOfferMetricsResponseOffer
71
+ */
72
+ 'shareOfCouponSubscriptions'?: number;
73
+ /**
74
+ * The forecasted total subscription revenue for the next 30 days. Applicable to FORECAST timePeriodType.
69
75
  * @type {number}
70
76
  * @memberof ListOfferMetricsResponseOffer
71
77
  */
72
78
  'next30DayTotalSubscriptionsRevenue'?: number;
73
79
  /**
74
- * The forecasted total subscription revenue for the next 60 days. Applicable only for the `FORECAST` `timePeriodType`.
80
+ * The forecasted total subscription revenue for the next 60 days. Applicable to FORECAST timePeriodType.
75
81
  * @type {number}
76
82
  * @memberof ListOfferMetricsResponseOffer
77
83
  */
78
84
  'next60DayTotalSubscriptionsRevenue'?: number;
79
85
  /**
80
- * The forecasted total subscription revenue for the next 90 days. Applicable only for the `FORECAST` `timePeriodType`.
86
+ * The forecasted total subscription revenue for the next 90 days. Applicable to FORECAST timePeriodType.
81
87
  * @type {number}
82
88
  * @memberof ListOfferMetricsResponseOffer
83
89
  */
84
90
  'next90DayTotalSubscriptionsRevenue'?: number;
85
91
  /**
86
- * The forecasted shipped subscription units for the next 30 days. Applicable only for the `FORECAST` `timePeriodType`.
92
+ * The forecasted shipped subscription units for the next 30 days. Applicable to FORECAST timePeriodType.
87
93
  * @type {number}
88
94
  * @memberof ListOfferMetricsResponseOffer
89
95
  */
90
96
  'next30DayShippedSubscriptionUnits'?: number;
91
97
  /**
92
- * The forecasted shipped subscription units for the next 60 days. Applicable only for the `FORECAST` `timePeriodType`.
98
+ * The forecasted shipped subscription units for the next 60 days. Applicable to FORECAST timePeriodType.
93
99
  * @type {number}
94
100
  * @memberof ListOfferMetricsResponseOffer
95
101
  */
96
102
  'next60DayShippedSubscriptionUnits'?: number;
97
103
  /**
98
- * The forecasted shipped subscription units for the next 90 days. Applicable only for the `FORECAST` `timePeriodType`.
104
+ * The forecasted shipped subscription units for the next 90 days. Applicable to FORECAST timePeriodType.
99
105
  * @type {number}
100
106
  * @memberof ListOfferMetricsResponseOffer
101
107
  */
package/dist/types/api-model/models/metric.d.ts CHANGED
@@ -23,5 +23,9 @@ export declare const Metric: {
23
23
  readonly LostRevenueDueToOos: "LOST_REVENUE_DUE_TO_OOS";
24
24
  readonly SubscriberNonSubscriberAverageReorders: "SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REORDERS";
25
25
  readonly CouponsRevenuePenetration: "COUPONS_REVENUE_PENETRATION";
26
+ readonly RevenueByDeliveries: "REVENUE_BY_DELIVERIES";
27
+ readonly SubscriberRetention: "SUBSCRIBER_RETENTION";
28
+ readonly RevenuePenetrationBySellerFunding: "REVENUE_PENETRATION_BY_SELLER_FUNDING";
29
+ readonly ShareOfCouponSubscriptions: "SHARE_OF_COUPON_SUBSCRIPTIONS";
26
30
  };
27
31
  export type Metric = typeof Metric[keyof typeof Metric];
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@sp-api-sdk/replenishment-api-2022-11-07",
3
3
  "author": "Bertrand Marron <bertrand@bizon.solutions>",
4
4
  "description": "The Selling Partner API for Replenishment (Replenishment API) provides programmatic access to replenishment program metrics and offers. These programs provide recurring delivery of any replenishable item at a frequency chosen by the customer. The Replenishment API is available worldwide wherever Amazon Subscribe & Save is available or is supported. The API is available to vendors and FBA selling partners.",
5
- "version": "2.4.6",
5
+ "version": "3.0.0",
6
6
  "main": "dist/cjs/index.js",
7
7
  "module": "dist/es/index.js",
8
8
  "types": "dist/types/index.d.ts",
@@ -18,7 +18,7 @@
18
18
  "dist/**/*.d.ts"
19
19
  ],
20
20
  "dependencies": {
21
- "@sp-api-sdk/common": "2.1.6",
21
+ "@sp-api-sdk/common": "2.1.7",
22
22
  "axios": "^1.7.9"
23
23
  },
24
24
  "repository": {
@@ -40,5 +40,5 @@
40
40
  "sp sdk",
41
41
  "replenishment api"
42
42
  ],
43
- "gitHead": "e85bb462e81998418e804e49bb15f0f7d3b01e90"
43
+ "gitHead": "14dc1de3723e34f66b078e05f9c7044b22a46c43"
44
44
  }