Class: AmznSpApi::FbaInboundEligibilityApiModel::FbaInboundApi

Inherits:
Object
  • Object
show all
Defined in:
lib/fba_inbound_eligibility_api_model/api/fba_inbound_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FbaInboundApi

Returns a new instance of FbaInboundApi.



14
15
16
 
# File 'lib/fba_inbound_eligibility_api_model/api/fba_inbound_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/fba_inbound_eligibility_api_model/api/fba_inbound_api.rb', line 12

def api_client
  @api_client
end

Instance Method Details

#get_item_eligibility_preview(asin, program, opts = {}) ⇒ GetItemEligibilityPreviewResponse

This operation gets an eligibility preview for an item that you specify. You can specify the type of eligibility preview that you want (INBOUND or COMMINGLING). For INBOUND previews, you can specify the marketplace in which you want to determine the item’s eligibility. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 1 | 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:

  • asin —

    The ASIN of the item for which you want an eligibility preview.

  • program —

    The program that you want to check eligibility against.

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

    the optional parameters

Options Hash (opts):

  • :marketplace_ids (Array<String>) —

    The identifier for the marketplace in which you want to determine eligibility. Required only when program&#x3D;INBOUND.

Returns:



24
25
26
27
 
# File 'lib/fba_inbound_eligibility_api_model/api/fba_inbound_api.rb', line 24

def get_item_eligibility_preview(asin, program, opts = {})
  data, _status_code, _headers = get_item_eligibility_preview_with_http_info(asin, program, opts)
  data
end

#get_item_eligibility_preview_with_http_info(asin, program, opts = {}) ⇒ Array<(GetItemEligibilityPreviewResponse, Integer, Hash)>

This operation gets an eligibility preview for an item that you specify. You can specify the type of eligibility preview that you want (INBOUND or COMMINGLING). For INBOUND previews, you can specify the marketplace in which you want to determine the item&#x27;s eligibility. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 1 | 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:

  • asin —

    The ASIN of the item for which you want an eligibility preview.

  • program —

    The program that you want to check eligibility against.

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

    the optional parameters

Options Hash (opts):

  • :marketplace_ids (Array<String>) —

    The identifier for the marketplace in which you want to determine eligibility. Required only when program&#x3D;INBOUND.

Returns:

Raises:

  • (ArgumentError) 


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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/fba_inbound_eligibility_api_model/api/fba_inbound_api.rb', line 35

def get_item_eligibility_preview_with_http_info(asin, program, opts = {})
  @api_client.config.logger.debug 'Calling API: FbaInboundApi.get_item_eligibility_preview ...' if @api_client.config.debugging
  # verify the required parameter 'asin' is set
  raise ArgumentError, "Missing the required parameter 'asin' when calling FbaInboundApi.get_item_eligibility_preview" if @api_client.config.client_side_validation && asin.nil?
  # verify the required parameter 'program' is set
  raise ArgumentError, "Missing the required parameter 'program' when calling FbaInboundApi.get_item_eligibility_preview" if @api_client.config.client_side_validation && program.nil?
  # verify enum value
  raise ArgumentError, "invalid value for 'program', must be one of INBOUND, COMMINGLING" if @api_client.config.client_side_validation && !%w[INBOUND COMMINGLING].include?(program)

  # resource path
  local_var_path = '/fba/inbound/v1/eligibility/itemPreview'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:asin] = asin
  query_params[:program] = program
  query_params[:marketplaceIds] = @api_client.build_collection_param(opts[:marketplace_ids], :csv) unless opts[:marketplace_ids].nil?

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

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

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

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

  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: FbaInboundApi#get_item_eligibility_preview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end