diff --git a/models/replenishment-api-model/replenishment-2022-11-07.json b/models/replenishment-api-model/replenishment-2022-11-07.json index c61768d..b75ad3a 100644 --- a/models/replenishment-api-model/replenishment-2022-11-07.json +++ b/models/replenishment-api-model/replenishment-2022-11-07.json @@ -410,39 +410,39 @@ "x-docgen-enum-table-extension": [ { "value": "SHIPPED_SUBSCRIPTION_UNITS", - "description": "The number of units shipped to the subscribers over a period of time. Applicable only for the PERFORMANCE timePeriodType." + "description": "The number of units shipped to the subscribers over a period of time. Applicable only for the `PERFORMANCE` `timePeriodType`." }, { "value": "TOTAL_SUBSCRIPTIONS_REVENUE", - "description": "The revenue generated from subscriptions over a period of time. Applicable only for the PERFORMANCE timePeriodType." + "description": "The revenue generated from subscriptions over a period of time. Applicable only for the `PERFORMANCE` `timePeriodType`." }, { "value": "ACTIVE_SUBSCRIPTIONS", - "description": "The number of active subscriptions present at the end of the period. Applicable only for the PERFORMANCE timePeriodType." + "description": "The number of active subscriptions present at the end of the period. Applicable only for the `PERFORMANCE` `timePeriodType`." }, { "value": "NEXT_90DAYS_SHIPPED_SUBSCRIPTION_UNITS", - "description": "The forecasted shipped subscription units for the next 90 days. Applicable only for the FORECAST timePeriodType." + "description": "The forecasted shipped subscription units for the next 90 days. Applicable only for the `FORECAST` `timePeriodType`." }, { "value": "NEXT_60DAYS_SHIPPED_SUBSCRIPTION_UNITS", - "description": "The forecasted shipped subscription units for the next 60 days. Applicable only for the FORECAST timePeriodType." + "description": "The forecasted shipped subscription units for the next 60 days. Applicable only for the `FORECAST` `timePeriodType`." }, { "value": "NEXT_30DAYS_SHIPPED_SUBSCRIPTION_UNITS", - "description": "The forecasted shipped subscription units for the next 30 days. Applicable only for the FORECAST timePeriodType." + "description": "The forecasted shipped subscription units for the next 30 days. Applicable only for the `FORECAST` `timePeriodType`." }, { "value": "NEXT_90DAYS_TOTAL_SUBSCRIPTIONS_REVENUE", - "description": "The forecasted total subscription revenue for the next 90 days. Applicable only for the FORECAST timePeriodType." + "description": "The forecasted total subscription revenue for the next 90 days. Applicable only for the `FORECAST` `timePeriodType`." }, { "value": "NEXT_60DAYS_TOTAL_SUBSCRIPTIONS_REVENUE", - "description": "The forecasted total subscription revenue for the next 60 days. Applicable only for the FORECAST timePeriodType." + "description": "The forecasted total subscription revenue for the next 60 days. Applicable only for the `FORECAST` `timePeriodType`." }, { "value": "NEXT_30DAYS_TOTAL_SUBSCRIPTIONS_REVENUE", - "description": "The forecasted total subscription revenue for the next 30 days. Applicable only for the FORECAST timePeriodType." + "description": "The forecasted total subscription revenue for the next 30 days. Applicable only for the `FORECAST` `timePeriodType`." } ] }, @@ -582,7 +582,7 @@ "description": "The marketplace identifier. The supported marketplaces for both sellers and vendors are US, CA, ES, UK, FR, IT, IN, DE and JP. The supported marketplaces for vendors only are BR, AU, MX, AE and NL. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) to find the identifier for the marketplace." }, "AggregationFrequency": { - "description": "The time period used to group data in the response. Note that this is only valid for the performance time period type.", + "description": "The time period used to group data in the response. Note that this is only valid for the `PERFORMANCE` time period type.", "type": "string", "enum": [ "WEEK", @@ -620,12 +620,12 @@ "startDate": { "type": "string", "format": "date-time", - "description": "When this object is used as a request parameter, the specified startDate is adjusted based on the aggregation frequency.\n\n* For WEEK the metric is computed from the first day of the week (that is, Sunday based on ISO 8601) that contains the startDate.\n* For MONTH the metric is computed from the first day of the month that contains the startDate.\n* For QUARTER the metric is computed from the first day of the quarter that contains the startDate.\n* For YEAR the metric is computed from the first day of the year that contains the startDate." + "description": "When this object is used as a request parameter, the specified `startDate` is adjusted based on the aggregation frequency.\n\n* For `WEEK` the metric is computed from the first day of the week (Sunday, based on ISO 8601) that contains the `startDate`.\n* For `MONTH` the metric is computed from the first day of the month that contains the `startDate`.\n* For `QUARTER` the metric is computed from the first day of the quarter that contains the `startDate`.\n* For `YEAR` the metric is computed from the first day of the year that contains the `startDate`." }, "endDate": { "type": "string", "format": "date-time", - "description": "When this object is used as a request parameter, the specified endDate is adjusted based on the aggregation frequency.\n\n* For WEEK the metric is computed up to the last day of the week (that is, Sunday based on ISO 8601) that contains the endDate.\n* For MONTH, the metric is computed up to the last day that contains the endDate.\n* For QUARTER the metric is computed up to the last day of the quarter that contains the endDate.\n* For YEAR the metric is computed up to the last day of the year that contains the endDate.\n Note: The end date may be adjusted to a lower value based on the data available in our system." + "description": "When this object is used as a request parameter, the specified `endDate` is adjusted based on the aggregation frequency.\n\n* For `WEEK` the metric is computed up to the last day of the week (Sunday, based on ISO 8601) that contains the `endDate`.\n* For `MONTH`, the metric is computed up to the last day that contains the `endDate`.\n* For `QUARTER` the metric is computed up to the last day of the quarter that contains the `endDate`.\n* For `YEAR` the metric is computed up to the last day of the year that contains the `endDate`.\n Note: The end date may be adjusted to a lower value based on the data available in our system." } } }, @@ -637,7 +637,10 @@ "TOTAL_SUBSCRIPTIONS_REVENUE", "ACTIVE_SUBSCRIPTIONS", "NOT_DELIVERED_DUE_TO_OOS", - "SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REVENUE" + "SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REVENUE", + "LOST_REVENUE_DUE_TO_OOS", + "SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REORDERS", + "COUPONS_REVENUE_PENETRATION" ], "x-docgen-enum-table-extension": [ { @@ -659,6 +662,18 @@ { "value": "SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REVENUE", "description": "The average revenue per subscriber and non-subscriber over the past 12 months for sellers and 6 months for vendors." + }, + { + "value": "LOST_REVENUE_DUE_TO_OOS", + "description": "The revenue that would have been generated had there not been out of stock." + }, + { + "value": "SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REORDERS", + "description": "The average reorders per subscriber and non-subscriber over the last 12 months." + }, + { + "value": "COUPONS_REVENUE_PENETRATION", + "description": "The percentage of revenue from ASINs with coupons out of total revenue from all ASINs." } ] }, @@ -694,7 +709,7 @@ }, { "value": "FORECAST", - "description": "Indicates forecasted metrics. Only TOTAL_SUBSCRIPTIONS_REVENUE and SHIPPED_SUBSCRIPTION_UNITS are supported. Forecast data is supported for sellers but not for vendors." + "description": "Indicates forecasted metrics. Only `TOTAL_SUBSCRIPTIONS_REVENUE` and `SHIPPED_SUBSCRIPTION_UNITS` are supported. Forecast data is supported for sellers but not for vendors." } ] }, @@ -716,42 +731,67 @@ "description": "An object which contains metric data for a selling partner.", "properties": { "notDeliveredDueToOOS": { - "description": "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.", + "description": "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`.", "type": "number", "format": "double", "minimum": 0, "maximum": 100 }, "totalSubscriptionsRevenue": { - "description": "The revenue generated from subscriptions over a period of time. Applicable for both the PERFORMANCE and FORECAST timePeriodType.", + "description": "The revenue generated from subscriptions over a period of time. Applicable for both the `PERFORMANCE` and `FORECAST` `timePeriodType`.", "type": "number", "format": "double", "minimum": 0 }, "shippedSubscriptionUnits": { - "description": "The number of units shipped to the subscribers over a period of time. Applicable for both the PERFORMANCE and FORECAST timePeriodType.", + "description": "The number of units shipped to the subscribers over a period of time. Applicable for both the `PERFORMANCE` and `FORECAST` `timePeriodType`.", "type": "number", "format": "int64", "minimum": 0 }, "activeSubscriptions": { - "description": "The number of active subscriptions present at the end of the period. Applicable only for the PERFORMANCE timePeriodType.", + "description": "The number of active subscriptions present at the end of the period. Applicable only for the `PERFORMANCE` `timePeriodType`.", "type": "number", "format": "int64", "minimum": 0 }, "subscriberAverageRevenue": { - "description": "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.", + "description": "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`.", "type": "number", "format": "double", "minimum": 0 }, "nonSubscriberAverageRevenue": { - "description": "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.", + "description": "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`.", "type": "number", "format": "double", "minimum": 0 }, + "lostRevenueDueToOOS": { + "description": "The revenue that would have been generated had there not been out of stock. Applicable only for the PERFORMANCE timePeriodType.", + "type": "number", + "format": "double", + "minimum": 0 + }, + "subscriberAverageReorders": { + "description": "The average reorders per subscriber of the program over a period of 12 months. Applicable only for the PERFORMANCE timePeriodType.", + "type": "number", + "format": "double", + "minimum": 0 + }, + "nonSubscriberAverageReorders": { + "description": "The average reorders per non-subscriber of the program over a period of past 12 months. Applicable only for the PERFORMANCE timePeriodType.", + "type": "number", + "format": "double", + "minimum": 0 + }, + "couponsRevenuePenetration": { + "description": "The percentage of revenue from ASINs with coupons out of total revenue from all ASINs. Applicable only for the PERFORMANCE timePeriodType.", + "type": "number", + "format": "double", + "minimum": 0, + "maximum": 100 + }, "timeInterval": { "description": "A time interval used to compute metrics.", "$ref": "#/definitions/TimeInterval" @@ -854,69 +894,82 @@ "description": "The Amazon Standard Identification Number (ASIN)." }, "notDeliveredDueToOOS": { - "description": "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.", + "description": "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`.", "type": "number", "format": "double", "minimum": 0, "maximum": 100 }, "totalSubscriptionsRevenue": { - "description": "The revenue generated from subscriptions over a period of time. Applicable only for the PERFORMANCE timePeriodType.", + "description": "The revenue generated from subscriptions over a period of time. Applicable only for the `PERFORMANCE` `timePeriodType`.", "type": "number", "format": "double", "minimum": 0 }, "shippedSubscriptionUnits": { - "description": "The number of units shipped to the subscribers over a period of time. Applicable only for the PERFORMANCE timePeriodType.", + "description": "The number of units shipped to the subscribers over a period of time. Applicable only for the `PERFORMANCE` `timePeriodType`.", "type": "number", "format": "int64", "minimum": 0 }, "activeSubscriptions": { - "description": "The number of active subscriptions present at the end of the period. Applicable only for the PERFORMANCE timePeriodType.", + "description": "The number of active subscriptions present at the end of the period. Applicable only for the `PERFORMANCE` `timePeriodType`.", "type": "number", "format": "int64", "minimum": 0 }, "revenuePenetration": { - "description": "The percentage of total program revenue out of total product revenue. Applicable only for the PERFORMANCE timePeriodType.", + "description": "The percentage of total program revenue out of total product revenue. Applicable only for the `PERFORMANCE` `timePeriodType`.", + "type": "number", + "format": "double", + "minimum": 0, + "maximum": 100 + }, + "lostRevenueDueToOOS": { + "description": "The revenue that would have been generated had there not been out of stock. Applicable only for the PERFORMANCE timePeriodType.", + "type": "number", + "format": "double", + "minimum": 0 + }, + "couponsRevenuePenetration": { + "description": "The percentage of revenue from ASINs with coupons out of total revenue from all ASINs. Applicable only for the PERFORMANCE timePeriodType.", "type": "number", "format": "double", "minimum": 0, "maximum": 100 }, "next30DayTotalSubscriptionsRevenue": { - "description": "The forecasted total subscription revenue for the next 30 days. Applicable only for the FORECAST timePeriodType.", + "description": "The forecasted total subscription revenue for the next 30 days. Applicable only for the `FORECAST` `timePeriodType`.", "type": "number", "format": "double", "minimum": 0 }, "next60DayTotalSubscriptionsRevenue": { - "description": "The forecasted total subscription revenue for the next 60 days. Applicable only for the FORECAST timePeriodType.", + "description": "The forecasted total subscription revenue for the next 60 days. Applicable only for the `FORECAST` `timePeriodType`.", "type": "number", "format": "double", "minimum": 0 }, "next90DayTotalSubscriptionsRevenue": { - "description": "The forecasted total subscription revenue for the next 90 days. Applicable only for the FORECAST timePeriodType.", + "description": "The forecasted total subscription revenue for the next 90 days. Applicable only for the `FORECAST` `timePeriodType`.", "type": "number", "format": "double", "minimum": 0 }, "next30DayShippedSubscriptionUnits": { - "description": "The forecasted shipped subscription units for the next 30 days. Applicable only for the FORECAST timePeriodType.", + "description": "The forecasted shipped subscription units for the next 30 days. Applicable only for the `FORECAST` `timePeriodType`.", "type": "number", "format": "int64", "minimum": 0 }, "next60DayShippedSubscriptionUnits": { - "description": "The forecasted shipped subscription units for the next 60 days. Applicable only for the FORECAST timePeriodType.", + "description": "The forecasted shipped subscription units for the next 60 days. Applicable only for the `FORECAST` `timePeriodType`.", "type": "number", "format": "int64", "minimum": 0 }, "next90DayShippedSubscriptionUnits": { - "description": "The forecasted shipped subscription units for the next 90 days. Applicable only for the FORECAST timePeriodType.", + "description": "The forecasted shipped subscription units for the next 90 days. Applicable only for the `FORECAST` `timePeriodType`.", "type": "number", "format": "int64", "minimum": 0 @@ -940,6 +993,7 @@ "properties": { "errors": { "type": "array", + "description": "A list of error responses returned when a request is unsuccessful.", "items": { "$ref": "#/definitions/Error" } @@ -980,6 +1034,7 @@ "parameters": [ { "name": "body", + "description": "The request body for the `getSellingPartnerMetrics` operation.", "in": "body", "schema": { "$ref": "#/definitions/GetSellingPartnerMetricsRequest" @@ -1012,6 +1067,10 @@ "notDeliveredDueToOOS": 5.54, "totalSubscriptionsRevenue": 131340.24, "activeSubscriptions": 0, + "lostRevenueDueToOOS": 38493.29, + "subscriberAverageReorders": 3.25, + "nonSubscriberAverageReorders": 1.11, + "couponsRevenuePenetration": 0.0, "currencyCode": "USD", "timeInterval": { "endDate": "2023-05-09T22:36:56Z", @@ -1054,6 +1113,10 @@ "notDeliveredDueToOOS": 5.54, "totalSubscriptionsRevenue": 131340.24, "activeSubscriptions": 0, + "lostRevenueDueToOOS": 38493.29, + "subscriberAverageReorders": 3.25, + "nonSubscriberAverageReorders": 1.11, + "couponsRevenuePenetration": 0.0, "currencyCode": "USD", "timeInterval": { "endDate": "2023-05-09T22:36:56Z", @@ -1098,7 +1161,10 @@ "TOTAL_SUBSCRIPTIONS_REVENUE", "NOT_DELIVERED_DUE_TO_OOS", "ACTIVE_SUBSCRIPTIONS", - "SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REVENUE" + "SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REVENUE", + "LOST_REVENUE_DUE_TO_OOS", + "SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REORDERS", + "COUPONS_REVENUE_PENETRATION" ], "timePeriodType": "PERFORMANCE", "marketplaceId": "ATVPDKIKX0DER", @@ -1161,6 +1227,18 @@ } } }, + "413": { + "description": "The request size exceeded the maximum accepted size.", + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + }, + "schema": { + "$ref": "#/definitions/ErrorList" + } + }, "415": { "description": "The request payload is in an unsupported format.", "schema": { @@ -1254,6 +1332,8 @@ "totalSubscriptionsRevenue": 12.89, "asin": "B000TMUDOW", "revenuePenetration": 10.34, + "lostRevenueDueToOOS": 12.32, + "couponsRevenuePenetration": 10, "timeInterval": { "endDate": "2023-03-11T00:00:00Z", "startDate": "2023-03-05T00:00:00Z" @@ -1266,6 +1346,8 @@ "totalSubscriptionsRevenue": 34.03, "asin": "B004CLH5CY", "revenuePenetration": 9.87, + "lostRevenueDueToOOS": 17.82, + "couponsRevenuePenetration": 17, "timeInterval": { "endDate": "2023-03-11T00:00:00Z", "startDate": "2023-03-05T00:00:00Z" @@ -1322,6 +1404,8 @@ "revenuePenetration": 23.6, "shippedSubscriptionUnits": 100, "activeSubscriptions": 100, + "lostRevenueDueToOOS": 12.32, + "couponsRevenuePenetration": 10, "timeInterval": { "startDate": "2022-01-01T00:00:00Z", "endDate": "2022-12-31T00:00:00Z" @@ -1335,6 +1419,8 @@ "revenuePenetration": 35.90, "shippedSubscriptionUnits": 100, "activeSubscriptions": 100, + "lostRevenueDueToOOS": 17.82, + "couponsRevenuePenetration": 17, "timeInterval": { "startDate": "2022-01-01T00:00:00Z", "endDate": "2022-12-31T00:00:00Z" @@ -1451,6 +1537,18 @@ } } }, + "413": { + "description": "The request size exceeded the maximum accepted size.", + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + }, + "schema": { + "$ref": "#/definitions/ErrorList" + } + }, "415": { "description": "The request payload is in an unsupported format.", "schema": { @@ -1507,11 +1605,12 @@ "tags": [ "offers" ], - "description": "Returns the details of a selling partner's replenishment program offers. Note that this operation only supports sellers at this time.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 1 |\n\nThe `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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", + "description": "Returns the details of a selling partner's replenishment program offers.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 1 |\n\nThe `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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "listOffers", "parameters": [ { "name": "body", + "description": "The request body for the `listOffers` operation.", "in": "body", "schema": { "$ref": "#/definitions/ListOffersRequest" @@ -1768,6 +1867,18 @@ } } }, + "413": { + "description": "The request size exceeded the maximum accepted size.", + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + }, + "schema": { + "$ref": "#/definitions/ErrorList" + } + }, "415": { "description": "The request payload is in an unsupported format.", "schema": {