replenishment_2022_11_07_models

type AggregationFrequency string

type AutoEnrollmentPreference string

type DiscountFunding struct {

	// Filters the results to only include offers with the percentage specified.
	// Max Items: 10
	// Min Items: 1
	// Unique: true
	Percentage []*int64 `json:"percentage"`
}

type EligibilityStatus string

type EnrollmentMethod string

type Error struct {

	// An error code that identifies the type of error that occurred.
	// Required: true
	Code *string `json:"code"`

	// Additional details that can help the caller understand or fix the issue.
	Details string `json:"details,omitempty"`

	// A message that describes the error condition.
	// Required: true
	Message *string `json:"message"`
}

type ErrorList struct {

	// errors
	// Required: true
	Errors []*Error `json:"errors"`
}

type GetSellingPartnerMetricsRequest struct {

	// aggregation frequency
	AggregationFrequency AggregationFrequency `json:"aggregationFrequency,omitempty"`

	// 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.
	// Required: true
	MarketplaceID *MarketplaceID `json:"marketplaceId"`

	// The list of metrics requested. If no metric value is provided, data for all of the metrics will be returned.
	// Min Items: 1
	// Unique: true
	Metrics []Metric `json:"metrics"`

	// The list of replenishment program types for which to return metrics.
	// Required: true
	ProgramTypes ProgramTypes `json:"programTypes"`

	// A time interval used to compute metrics.
	// Required: true
	TimeInterval *TimeInterval `json:"timeInterval"`

	// time period type
	// Required: true
	TimePeriodType *TimePeriodType `json:"timePeriodType"`
}

type GetSellingPartnerMetricsResponse struct {

	// A list of metrics data for the selling partner.
	Metrics []*GetSellingPartnerMetricsResponseMetric `json:"metrics"`
}

type GetSellingPartnerMetricsResponseMetric struct {

	// The number of active subscriptions present at the end of the period. Applicable only for the PERFORMANCE timePeriodType.
	// Minimum: 0
	ActiveSubscriptions *int64 `json:"activeSubscriptions,omitempty"`

	// The currency code in ISO 4217 format.
	CurrencyCode string `json:"currencyCode,omitempty"`

	// 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.
	// Minimum: 0
	NonSubscriberAverageRevenue *float64 `json:"nonSubscriberAverageRevenue,omitempty"`

	// 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.
	// Maximum: 100
	// Minimum: 0
	NotDeliveredDueToOOS *float64 `json:"notDeliveredDueToOOS,omitempty"`

	// The number of units shipped to the subscribers over a period of time. Applicable for both the PERFORMANCE and FORECAST timePeriodType.
	// Minimum: 0
	ShippedSubscriptionUnits *int64 `json:"shippedSubscriptionUnits,omitempty"`

	// 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.
	// Minimum: 0
	SubscriberAverageRevenue *float64 `json:"subscriberAverageRevenue,omitempty"`

	// A time interval used to compute metrics.
	TimeInterval *TimeInterval `json:"timeInterval,omitempty"`

	// The revenue generated from subscriptions over a period of time. Applicable for both the PERFORMANCE and FORECAST timePeriodType.
	// Minimum: 0
	TotalSubscriptionsRevenue *float64 `json:"totalSubscriptionsRevenue,omitempty"`
}

type ListOfferMetricsRequest struct {

	// Use these parameters to filter results. Any result must match all provided parameters. For any parameter that is an array, the result must match at least one element in the provided array.
	// Required: true
	Filters *ListOfferMetricsRequestFilters `json:"filters"`

	// Use these parameters to paginate through the response.
	// Required: true
	Pagination *ListOfferMetricsRequestPagination `json:"pagination"`

	// Use these parameters to sort the response.
	Sort *ListOfferMetricsRequestSort `json:"sort,omitempty"`
}

type ListOfferMetricsRequestFilters struct {

	// aggregation frequency
	AggregationFrequency AggregationFrequency `json:"aggregationFrequency,omitempty"`

	// A list of Amazon Standard Identification Numbers (ASINs).
	// Max Items: 20
	// Min Items: 1
	// Unique: true
	Asins []string `json:"asins"`

	// 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.
	// Required: true
	MarketplaceID *MarketplaceID `json:"marketplaceId"`

	// program types
	// Required: true
	ProgramTypes ProgramTypes `json:"programTypes"`

	// A time interval used to compute metrics.
	// Required: true
	TimeInterval *TimeInterval `json:"timeInterval"`

	// time period type
	// Required: true
	TimePeriodType *TimePeriodType `json:"timePeriodType"`
}

type ListOfferMetricsRequestPagination struct {

	// The maximum number of results to return in the response.
	// Required: true
	// Maximum: 500
	// Minimum: 1
	Limit *int64 `json:"limit"`

	// The offset from which to retrieve the number of results specified by the `limit` value. The first result is at offset 0.
	// Required: true
	// Maximum: 9000
	// Minimum: 0
	Offset *int64 `json:"offset"`
}

type ListOfferMetricsRequestSort struct {

	// key
	// Required: true
	Key *ListOfferMetricsSortKey `json:"key"`

	// The sort order.
	// Required: true
	Order *SortOrder `json:"order"`
}

type ListOfferMetricsResponse struct {

	// A list of offers and associated metrics.
	Offers []*ListOfferMetricsResponseOffer `json:"offers"`

	// Use these parameters to paginate through the response.
	Pagination *PaginationResponse `json:"pagination,omitempty"`
}

type ListOfferMetricsResponseOffer struct {

	// The number of active subscriptions present at the end of the period. Applicable only for the PERFORMANCE timePeriodType.
	// Minimum: 0
	ActiveSubscriptions *int64 `json:"activeSubscriptions,omitempty"`

	// The Amazon Standard Identification Number (ASIN).
	Asin string `json:"asin,omitempty"`

	// The currency code in ISO 4217 format.
	CurrencyCode string `json:"currencyCode,omitempty"`

	// The forecasted shipped subscription units for the next 30 days. Applicable only for the FORECAST timePeriodType.
	// Minimum: 0
	Next30DayShippedSubscriptionUnits *int64 `json:"next30DayShippedSubscriptionUnits,omitempty"`

	// The forecasted total subscription revenue for the next 30 days. Applicable only for the FORECAST timePeriodType.
	// Minimum: 0
	Next30DayTotalSubscriptionsRevenue *float64 `json:"next30DayTotalSubscriptionsRevenue,omitempty"`

	// The forecasted shipped subscription units for the next 60 days. Applicable only for the FORECAST timePeriodType.
	// Minimum: 0
	Next60DayShippedSubscriptionUnits *int64 `json:"next60DayShippedSubscriptionUnits,omitempty"`

	// The forecasted total subscription revenue for the next 60 days. Applicable only for the FORECAST timePeriodType.
	// Minimum: 0
	Next60DayTotalSubscriptionsRevenue *float64 `json:"next60DayTotalSubscriptionsRevenue,omitempty"`

	// The forecasted shipped subscription units for the next 90 days. Applicable only for the FORECAST timePeriodType.
	// Minimum: 0
	Next90DayShippedSubscriptionUnits *int64 `json:"next90DayShippedSubscriptionUnits,omitempty"`

	// The forecasted total subscription revenue for the next 90 days. Applicable only for the FORECAST timePeriodType.
	// Minimum: 0
	Next90DayTotalSubscriptionsRevenue *float64 `json:"next90DayTotalSubscriptionsRevenue,omitempty"`

	// 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.
	// Maximum: 100
	// Minimum: 0
	NotDeliveredDueToOOS *float64 `json:"notDeliveredDueToOOS,omitempty"`

	// The percentage of total program revenue out of total product revenue. Applicable only for the PERFORMANCE timePeriodType.
	// Maximum: 100
	// Minimum: 0
	RevenuePenetration *float64 `json:"revenuePenetration,omitempty"`

	// The number of units shipped to the subscribers over a period of time. Applicable only for the PERFORMANCE timePeriodType.
	// Minimum: 0
	ShippedSubscriptionUnits *int64 `json:"shippedSubscriptionUnits,omitempty"`

	// A time interval used to compute metrics.
	TimeInterval *TimeInterval `json:"timeInterval,omitempty"`

	// The revenue generated from subscriptions over a period of time. Applicable only for the PERFORMANCE timePeriodType.
	// Minimum: 0
	TotalSubscriptionsRevenue *float64 `json:"totalSubscriptionsRevenue,omitempty"`
}

type ListOfferMetricsSortKey string

type ListOffersRequest struct {

	// Use these parameters to filter results. Any result must match all provided parameters. For any parameter that is an array, the result must match at least one element in the provided array.
	// Required: true
	Filters *ListOffersRequestFilters `json:"filters"`

	// Use these parameters to paginate through the response.
	// Required: true
	Pagination *ListOffersRequestPagination `json:"pagination"`

	// Use these parameters to sort the response.
	Sort *ListOffersRequestSort `json:"sort,omitempty"`
}

type ListOffersRequestFilters struct {

	// A list of Amazon Standard Identification Numbers (ASINs).
	// Max Items: 20
	// Min Items: 1
	// Unique: true
	Asins []string `json:"asins"`

	// A list of eligibilities associated with an offer.
	// Min Items: 1
	// Unique: true
	Eligibilities []EligibilityStatus `json:"eligibilities"`

	// 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.
	// Required: true
	MarketplaceID *MarketplaceID `json:"marketplaceId"`

	// Offer preferences to include in the result filter criteria.
	Preferences *Preference `json:"preferences,omitempty"`

	// program types
	// Required: true
	ProgramTypes ProgramTypes `json:"programTypes"`

	// Offer promotions to include in the result filter criteria.
	Promotions *Promotion `json:"promotions,omitempty"`

	// A list of SKUs to filter. This filter is only supported for sellers and not for vendors.
	// Max Items: 20
	// Min Items: 1
	// Unique: true
	Skus []string `json:"skus"`
}

type ListOffersRequestPagination struct {

	// The maximum number of results to return in the response.
	// Required: true
	// Maximum: 100
	// Minimum: 1
	Limit *int64 `json:"limit"`

	// The offset from which to retrieve the number of results specified by the `limit` value. The first result is at offset 0.
	// Required: true
	// Maximum: 9000
	// Minimum: 0
	Offset *int64 `json:"offset"`
}

type ListOffersRequestSort struct {

	// The attribute to use to sort the results.
	// Required: true
	Key *ListOffersSortKey `json:"key"`

	// The sort order.
	// Required: true
	Order *SortOrder `json:"order"`
}

type ListOffersResponse struct {

	// A list of offers.
	Offers []*ListOffersResponseOffer `json:"offers"`

	// Use these parameters to paginate through the response.
	Pagination *PaginationResponse `json:"pagination,omitempty"`
}

type ListOffersResponseOffer struct {

	// The Amazon Standard Identification Number (ASIN).
	Asin string `json:"asin,omitempty"`

	// The offer eligibility status.
	Eligibility EligibilityStatus `json:"eligibility,omitempty"`

	// 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.
	MarketplaceID MarketplaceID `json:"marketplaceId,omitempty"`

	// offer program configuration
	OfferProgramConfiguration *OfferProgramConfiguration `json:"offerProgramConfiguration,omitempty"`

	// The replenishment program for the offer.
	ProgramType ProgramType `json:"programType,omitempty"`

	// The SKU. This property is only supported for sellers and not for vendors.
	Sku string `json:"sku,omitempty"`

	// A list of vendor codes associated with the offer.
	VendorCodes []string `json:"vendorCodes"`
}

type ListOffersSortKey string

type MarketplaceID string

type Metric string

type OfferProgramConfiguration struct {

	// Determines whether the offer was automatically or manually enrolled in the program. This property is only supported for sellers and not vendors.
	EnrollmentMethod EnrollmentMethod `json:"enrollmentMethod,omitempty"`

	// An object which contains the preferences applied to the offer.
	Preferences *OfferProgramConfigurationPreferences `json:"preferences,omitempty"`

	// An object which contains the promotions applied to the offer.
	Promotions *OfferProgramConfigurationPromotions `json:"promotions,omitempty"`
}

type OfferProgramConfigurationPreferences struct {

	// The auto-enrollment preference indicates whether the offer is opted-in to or opted-out of Amazon's auto-enrollment feature.
	AutoEnrollment AutoEnrollmentPreference `json:"autoEnrollment,omitempty"`
}

type OfferProgramConfigurationPromotions struct {

	// A base discount set by Amazon on the offer.
	AmazonFundedBaseDiscount *OfferProgramConfigurationPromotionsDiscountFunding `json:"amazonFundedBaseDiscount,omitempty"`

	// A tiered discount set by Amazon on the offer.
	AmazonFundedTieredDiscount *OfferProgramConfigurationPromotionsDiscountFunding `json:"amazonFundedTieredDiscount,omitempty"`

	// A base discount set by the selling partner on the offer.
	SellingPartnerFundedBaseDiscount *OfferProgramConfigurationPromotionsDiscountFunding `json:"sellingPartnerFundedBaseDiscount,omitempty"`

	// A tiered discount set by the selling partner on the offer.
	SellingPartnerFundedTieredDiscount *OfferProgramConfigurationPromotionsDiscountFunding `json:"sellingPartnerFundedTieredDiscount,omitempty"`
}

type OfferProgramConfigurationPromotionsDiscountFunding struct {

	// The percentage discount on the offer.
	// Maximum: 100
	// Minimum: 0
	Percentage *int64 `json:"percentage,omitempty"`
}

type PaginationResponse struct {

	// Total number of results matching the given filter criteria.
	// Minimum: 0
	TotalResults *int64 `json:"totalResults,omitempty"`
}

type Preference struct {

	// Filters the results to only include offers with the auto-enrollment preference specified.
	// Min Items: 1
	// Unique: true
	AutoEnrollment []AutoEnrollmentPreference `json:"autoEnrollment"`
}

type ProgramType string

type ProgramTypes []ProgramType

type Promotion struct {

	// A base discount set by Amazon on the offer.
	AmazonFundedBaseDiscount *DiscountFunding `json:"amazonFundedBaseDiscount,omitempty"`

	// A tiered discount set by Amazon on the offer.
	AmazonFundedTieredDiscount *DiscountFunding `json:"amazonFundedTieredDiscount,omitempty"`

	// A base discount set by the selling partner on the offer.
	SellingPartnerFundedBaseDiscount *DiscountFunding `json:"sellingPartnerFundedBaseDiscount,omitempty"`

	// A tiered discount set by the selling partner on the offer.
	SellingPartnerFundedTieredDiscount *DiscountFunding `json:"sellingPartnerFundedTieredDiscount,omitempty"`
}

type SortOrder string

type TimeInterval struct {

	// When this object is used as a request parameter, the specified endDate is adjusted based on the aggregation frequency.
	//
	// * 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.
	// * For MONTH, the metric is computed up to the last day that contains the endDate.
	// * For QUARTER the metric is computed up to the last day of the quarter that contains the endDate.
	// * For YEAR the metric is computed up to the last day of the year that contains the endDate.
	//  Note: The end date may be adjusted to a lower value based on the data available in our system.
	// Required: true
	// Format: date-time
	EndDate *strfmt.DateTime `json:"endDate"`

	// When this object is used as a request parameter, the specified startDate is adjusted based on the aggregation frequency.
	//
	// * For WEEK the metric is computed from the first day of the week (that is, Sunday based on ISO 8601) that contains the startDate.
	// * For MONTH the metric is computed from the first day of the month that contains the startDate.
	// * For QUARTER the metric is computed from the first day of the quarter that contains the startDate.
	// * For YEAR the metric is computed from the first day of the year that contains the startDate.
	// Required: true
	// Format: date-time
	StartDate *strfmt.DateTime `json:"startDate"`
}

type TimePeriodType string