Class: Peddler::APIs::Replenishment20221107

Inherits:
Peddler::API show all
Defined in:
lib/peddler/apis/replenishment_2022_11_07.rb,
lib/peddler/apis/replenishment_2022_11_07/error.rb,
lib/peddler/apis/replenishment_2022_11_07/promotion.rb,
lib/peddler/apis/replenishment_2022_11_07/error_list.rb,
lib/peddler/apis/replenishment_2022_11_07/preference.rb,
lib/peddler/apis/replenishment_2022_11_07/program_types.rb,
lib/peddler/apis/replenishment_2022_11_07/time_interval.rb,
lib/peddler/apis/replenishment_2022_11_07/discount_funding.rb,
lib/peddler/apis/replenishment_2022_11_07/forecast_deliveries.rb,
lib/peddler/apis/replenishment_2022_11_07/list_offers_request.rb,
lib/peddler/apis/replenishment_2022_11_07/pagination_response.rb,
lib/peddler/apis/replenishment_2022_11_07/deliveries_condition.rb,
lib/peddler/apis/replenishment_2022_11_07/list_offers_response.rb,
lib/peddler/apis/replenishment_2022_11_07/list_offers_request_sort.rb,
lib/peddler/apis/replenishment_2022_11_07/list_offer_metrics_request.rb,
lib/peddler/apis/replenishment_2022_11_07/list_offers_response_offer.rb,
lib/peddler/apis/replenishment_2022_11_07/list_offer_metrics_response.rb,
lib/peddler/apis/replenishment_2022_11_07/list_offers_request_filters.rb,
lib/peddler/apis/replenishment_2022_11_07/offer_program_configuration.rb,
lib/peddler/apis/replenishment_2022_11_07/list_offers_request_pagination.rb,
lib/peddler/apis/replenishment_2022_11_07/list_offer_metrics_request_sort.rb,
lib/peddler/apis/replenishment_2022_11_07/list_offer_metrics_response_offer.rb,
lib/peddler/apis/replenishment_2022_11_07/list_offer_metrics_request_filters.rb,
lib/peddler/apis/replenishment_2022_11_07/get_selling_partner_metrics_request.rb,
lib/peddler/apis/replenishment_2022_11_07/get_selling_partner_metrics_response.rb,
lib/peddler/apis/replenishment_2022_11_07/list_offer_metrics_request_pagination.rb,
lib/peddler/apis/replenishment_2022_11_07/offer_program_configuration_promotions.rb,
lib/peddler/apis/replenishment_2022_11_07/offer_program_configuration_preferences.rb,
lib/peddler/apis/replenishment_2022_11_07/get_selling_partner_metrics_response_metric.rb,
lib/peddler/apis/replenishment_2022_11_07/offer_program_configuration_promotions_discount_funding.rb,
sig/peddler/apis/replenishment_2022_11_07.rbs

Overview

Selling Partner API for Replenishment

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.

See Also:

Defined Under Namespace

Classes: DeliveriesCondition, DiscountFunding, Error, ErrorList, ForecastDeliveries, GetSellingPartnerMetricsRequest, GetSellingPartnerMetricsResponse, GetSellingPartnerMetricsResponseMetric, ListOfferMetricsRequest, ListOfferMetricsRequestFilters, ListOfferMetricsRequestPagination, ListOfferMetricsRequestSort, ListOfferMetricsResponse, ListOfferMetricsResponseOffer, ListOffersRequest, ListOffersRequestFilters, ListOffersRequestPagination, ListOffersRequestSort, ListOffersResponse, ListOffersResponseOffer, OfferProgramConfiguration, OfferProgramConfigurationPreferences, OfferProgramConfigurationPromotions, OfferProgramConfigurationPromotionsDiscountFunding, PaginationResponse, Preference, ProgramTypes, Promotion, TimeInterval

Instance Attribute Summary

Attributes inherited from Peddler::API

#access_token, #endpoint, #retries

Instance Method Summary collapse

Methods inherited from Peddler::API

#cannot_sandbox!, #delete, #endpoint_uri, #get, #http, #initialize, #must_sandbox!, #patch, #percent_encode, #post, #put, #request, #sandbox, #sandbox?, #stringify_array, #timestamp, #user_agent

Constructor Details

This class inherits a constructor from Peddler::API

Instance Method Details

#get_selling_partner_metrics(body: nil, rate_limit: 1.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Returns aggregated replenishment program metrics for a selling partner.

Parameters:

  • body (Hash) (defaults to: nil) —

    The request body for the getSellingPartnerMetrics operation.

  • rate_limit (Float) (defaults to: 1.0) —

    Requests per second

  • body: (Hash[untyped, untyped], nil) (defaults to: nil)
  • rate_limit: (Float) (defaults to: 1.0)

Returns:



24
25
26
27
28
 
# File 'lib/peddler/apis/replenishment_2022_11_07.rb', line 24

def get_selling_partner_metrics(body: nil, rate_limit: 1.0)
  path = "/replenishment/2022-11-07/sellingPartners/metrics/search"
  parser = -> { GetSellingPartnerMetricsResponse }
  post(path, body:, rate_limit:, parser:)
end

#list_offer_metrics(body: nil, rate_limit: 1.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

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

Parameters:

  • body (Hash) (defaults to: nil) —

    The request body for the listOfferMetrics operation.

  • rate_limit (Float) (defaults to: 1.0) —

    Requests per second

  • body: (Hash[untyped, untyped], nil) (defaults to: nil)
  • rate_limit: (Float) (defaults to: 1.0)

Returns:



36
37
38
39
40
 
# File 'lib/peddler/apis/replenishment_2022_11_07.rb', line 36

def list_offer_metrics(body: nil, rate_limit: 1.0)
  path = "/replenishment/2022-11-07/offers/metrics/search"
  parser = -> { ListOfferMetricsResponse }
  post(path, body:, rate_limit:, parser:)
end

#list_offers(body: nil, rate_limit: 1.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Returns the details of a selling partner's replenishment program offers.

Parameters:

  • body (Hash) (defaults to: nil) —

    The request body for the listOffers operation.

  • rate_limit (Float) (defaults to: 1.0) —

    Requests per second

  • body: (Hash[untyped, untyped], nil) (defaults to: nil)
  • rate_limit: (Float) (defaults to: 1.0)

Returns:



48
49
50
51
52
 
# File 'lib/peddler/apis/replenishment_2022_11_07.rb', line 48

def list_offers(body: nil, rate_limit: 1.0)
  path = "/replenishment/2022-11-07/offers/search"
  parser = -> { ListOffersResponse }
  post(path, body:, rate_limit:, parser:)
end