Class: AmznSpApi::SellersApiModel::SellersApi

Inherits:
Object
  • Object
show all
Defined in:
lib/sellers_api_model/api/sellers_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SellersApi

Returns a new instance of SellersApi.



14
15
16
 
# File 'lib/sellers_api_model/api/sellers_api.rb', line 14

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



12
13
14
 
# File 'lib/sellers_api_model/api/sellers_api.rb', line 12

def api_client
  @api_client
end

Instance Method Details

#get_marketplace_participations(opts = {}) ⇒ GetMarketplaceParticipationsResponse

Returns a list of marketplaces that the seller submitting the request can sell in and information about the seller’s participation in those marketplaces. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 0.016 | 15 | 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](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



21
22
23
24
 
# File 'lib/sellers_api_model/api/sellers_api.rb', line 21

def get_marketplace_participations(opts = {})
  data, _status_code, _headers = get_marketplace_participations_with_http_info(opts)
  data
end

#get_marketplace_participations_with_http_info(opts = {}) ⇒ Array<(GetMarketplaceParticipationsResponse, Integer, Hash)>

Returns a list of marketplaces that the seller submitting the request can sell in and information about the seller&#x27;s participation in those marketplaces. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 0.016 | 15 | The &#x60;x-amzn-RateLimit-Limit&#x60; 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](developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/sellers_api_model/api/sellers_api.rb', line 29

def get_marketplace_participations_with_http_info(opts = {})
  @api_client.config.logger.debug 'Calling API: SellersApi.get_marketplace_participations ...' if @api_client.config.debugging
  # resource path
  local_var_path = '/sellers/v1/marketplaceParticipations'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'payload'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body]

  return_type = opts[:return_type] || 'GetMarketplaceParticipationsResponse'

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
                                                    header_params: header_params,
                                                    query_params: query_params,
                                                    form_params: form_params,
                                                    body: post_body,
                                                    auth_names: auth_names,
                                                    return_type: return_type)

  @api_client.config.logger.debug "API called: SellersApi#get_marketplace_participations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end