Class: AmznSpApi::FbaSmallAndLightApiModel::SmallAndLightApi
- Inherits:
-
Object
- Object
- AmznSpApi::FbaSmallAndLightApiModel::SmallAndLightApi
- Defined in:
- lib/fba_small_and_light_api_model/api/small_and_light_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#delete_small_and_light_enrollment_by_seller_sku(seller_sku, marketplace_ids, opts = {}) ⇒ nil
Removes the item indicated by the specified seller SKU from the Small and Light program in the specified marketplace.
-
#delete_small_and_light_enrollment_by_seller_sku_with_http_info(seller_sku, marketplace_ids, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Removes the item indicated by the specified seller SKU from the Small and Light program in the specified marketplace.
-
#get_small_and_light_eligibility_by_seller_sku(seller_sku, marketplace_ids, opts = {}) ⇒ SmallAndLightEligibility
Returns the Small and Light program eligibility status of the item indicated by the specified seller SKU in the specified marketplace.
-
#get_small_and_light_eligibility_by_seller_sku_with_http_info(seller_sku, marketplace_ids, opts = {}) ⇒ Array<(SmallAndLightEligibility, Integer, Hash)>
Returns the Small and Light program eligibility status of the item indicated by the specified seller SKU in the specified marketplace.
-
#get_small_and_light_enrollment_by_seller_sku(seller_sku, marketplace_ids, opts = {}) ⇒ SmallAndLightEnrollment
Returns the Small and Light enrollment status for the item indicated by the specified seller SKU in the specified marketplace.
-
#get_small_and_light_enrollment_by_seller_sku_with_http_info(seller_sku, marketplace_ids, opts = {}) ⇒ Array<(SmallAndLightEnrollment, Integer, Hash)>
Returns the Small and Light enrollment status for the item indicated by the specified seller SKU in the specified marketplace.
-
#get_small_and_light_fee_preview(body, opts = {}) ⇒ SmallAndLightFeePreviews
Returns the Small and Light fee estimates for the specified items.
-
#get_small_and_light_fee_preview_with_http_info(body, opts = {}) ⇒ Array<(SmallAndLightFeePreviews, Integer, Hash)>
Returns the Small and Light fee estimates for the specified items.
-
#initialize(api_client = ApiClient.default) ⇒ SmallAndLightApi
constructor
A new instance of SmallAndLightApi.
-
#put_small_and_light_enrollment_by_seller_sku(seller_sku, marketplace_ids, opts = {}) ⇒ SmallAndLightEnrollment
Enrolls the item indicated by the specified seller SKU in the Small and Light program in the specified marketplace.
-
#put_small_and_light_enrollment_by_seller_sku_with_http_info(seller_sku, marketplace_ids, opts = {}) ⇒ Array<(SmallAndLightEnrollment, Integer, Hash)>
Enrolls the item indicated by the specified seller SKU in the Small and Light program in the specified marketplace.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ SmallAndLightApi
Returns a new instance of SmallAndLightApi.
14 15 16 |
# File 'lib/fba_small_and_light_api_model/api/small_and_light_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_small_and_light_api_model/api/small_and_light_api.rb', line 12 def api_client @api_client end |
Instance Method Details
#delete_small_and_light_enrollment_by_seller_sku(seller_sku, marketplace_ids, opts = {}) ⇒ nil
Removes the item indicated by the specified seller SKU from the Small and Light program in the specified marketplace. If the item is not eligible for disenrollment, the ineligibility reasons are returned. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 5 | 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).
23 24 25 26 |
# File 'lib/fba_small_and_light_api_model/api/small_and_light_api.rb', line 23 def delete_small_and_light_enrollment_by_seller_sku(seller_sku, marketplace_ids, opts = {}) delete_small_and_light_enrollment_by_seller_sku_with_http_info(seller_sku, marketplace_ids, opts) nil end |
#delete_small_and_light_enrollment_by_seller_sku_with_http_info(seller_sku, marketplace_ids, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Removes the item indicated by the specified seller SKU from the Small and Light program in the specified marketplace. If the item is not eligible for disenrollment, the ineligibility reasons are returned. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 5 | 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).
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 62 63 64 65 66 67 68 69 70 71 |
# File 'lib/fba_small_and_light_api_model/api/small_and_light_api.rb', line 33 def delete_small_and_light_enrollment_by_seller_sku_with_http_info(seller_sku, marketplace_ids, opts = {}) @api_client.config.logger.debug 'Calling API: SmallAndLightApi.delete_small_and_light_enrollment_by_seller_sku ...' if @api_client.config.debugging # verify the required parameter 'seller_sku' is set raise ArgumentError, "Missing the required parameter 'seller_sku' when calling SmallAndLightApi.delete_small_and_light_enrollment_by_seller_sku" if @api_client.config.client_side_validation && seller_sku.nil? # verify the required parameter 'marketplace_ids' is set raise ArgumentError, "Missing the required parameter 'marketplace_ids' when calling SmallAndLightApi.delete_small_and_light_enrollment_by_seller_sku" if @api_client.config.client_side_validation && marketplace_ids.nil? # resource path local_var_path = '/fba/smallAndLight/v1/enrollments/{sellerSKU}'.sub('{' + 'sellerSKU' + '}', seller_sku.to_s) # query parameters query_params = opts[:query_params] || {} query_params[:marketplaceIds] = @api_client.build_collection_param(marketplace_ids, :csv) # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] return_type = opts[:return_type] auth_names = opts[:auth_names] || [] data, status_code, headers = @api_client.call_api(:DELETE, 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: SmallAndLightApi#delete_small_and_light_enrollment_by_seller_sku\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging [data, status_code, headers] end |
#get_small_and_light_eligibility_by_seller_sku(seller_sku, marketplace_ids, opts = {}) ⇒ SmallAndLightEligibility
Returns the Small and Light program eligibility status of the item indicated by the specified seller SKU in the specified marketplace. If the item is not eligible, the ineligibility reasons are returned. Note: The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](developer-docs.amazon.com/sp-api/docs/url-encoding). **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 10 | 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).
78 79 80 81 |
# File 'lib/fba_small_and_light_api_model/api/small_and_light_api.rb', line 78 def get_small_and_light_eligibility_by_seller_sku(seller_sku, marketplace_ids, opts = {}) data, _status_code, _headers = get_small_and_light_eligibility_by_seller_sku_with_http_info(seller_sku, marketplace_ids, opts) data end |
#get_small_and_light_eligibility_by_seller_sku_with_http_info(seller_sku, marketplace_ids, opts = {}) ⇒ Array<(SmallAndLightEligibility, Integer, Hash)>
Returns the Small and Light program eligibility status of the item indicated by the specified seller SKU in the specified marketplace. If the item is not eligible, the ineligibility reasons are returned. Note: The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](developer-docs.amazon.com/sp-api/docs/url-encoding). **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 10 | 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).
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 |
# File 'lib/fba_small_and_light_api_model/api/small_and_light_api.rb', line 88 def get_small_and_light_eligibility_by_seller_sku_with_http_info(seller_sku, marketplace_ids, opts = {}) @api_client.config.logger.debug 'Calling API: SmallAndLightApi.get_small_and_light_eligibility_by_seller_sku ...' if @api_client.config.debugging # verify the required parameter 'seller_sku' is set raise ArgumentError, "Missing the required parameter 'seller_sku' when calling SmallAndLightApi.get_small_and_light_eligibility_by_seller_sku" if @api_client.config.client_side_validation && seller_sku.nil? # verify the required parameter 'marketplace_ids' is set raise ArgumentError, "Missing the required parameter 'marketplace_ids' when calling SmallAndLightApi.get_small_and_light_eligibility_by_seller_sku" if @api_client.config.client_side_validation && marketplace_ids.nil? # resource path local_var_path = '/fba/smallAndLight/v1/eligibilities/{sellerSKU}'.sub('{' + 'sellerSKU' + '}', seller_sku.to_s) # query parameters query_params = opts[:query_params] || {} query_params[:marketplaceIds] = @api_client.build_collection_param(marketplace_ids, :csv) # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] return_type = opts[:return_type] || 'SmallAndLightEligibility' 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: SmallAndLightApi#get_small_and_light_eligibility_by_seller_sku\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging [data, status_code, headers] end |
#get_small_and_light_enrollment_by_seller_sku(seller_sku, marketplace_ids, opts = {}) ⇒ SmallAndLightEnrollment
Returns the Small and Light enrollment status for the item indicated by the specified seller SKU in the specified marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 10 | 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).
133 134 135 136 |
# File 'lib/fba_small_and_light_api_model/api/small_and_light_api.rb', line 133 def get_small_and_light_enrollment_by_seller_sku(seller_sku, marketplace_ids, opts = {}) data, _status_code, _headers = get_small_and_light_enrollment_by_seller_sku_with_http_info(seller_sku, marketplace_ids, opts) data end |
#get_small_and_light_enrollment_by_seller_sku_with_http_info(seller_sku, marketplace_ids, opts = {}) ⇒ Array<(SmallAndLightEnrollment, Integer, Hash)>
Returns the Small and Light enrollment status for the item indicated by the specified seller SKU in the specified marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 10 | 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).
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 |
# File 'lib/fba_small_and_light_api_model/api/small_and_light_api.rb', line 143 def get_small_and_light_enrollment_by_seller_sku_with_http_info(seller_sku, marketplace_ids, opts = {}) @api_client.config.logger.debug 'Calling API: SmallAndLightApi.get_small_and_light_enrollment_by_seller_sku ...' if @api_client.config.debugging # verify the required parameter 'seller_sku' is set raise ArgumentError, "Missing the required parameter 'seller_sku' when calling SmallAndLightApi.get_small_and_light_enrollment_by_seller_sku" if @api_client.config.client_side_validation && seller_sku.nil? # verify the required parameter 'marketplace_ids' is set raise ArgumentError, "Missing the required parameter 'marketplace_ids' when calling SmallAndLightApi.get_small_and_light_enrollment_by_seller_sku" if @api_client.config.client_side_validation && marketplace_ids.nil? # resource path local_var_path = '/fba/smallAndLight/v1/enrollments/{sellerSKU}'.sub('{' + 'sellerSKU' + '}', seller_sku.to_s) # query parameters query_params = opts[:query_params] || {} query_params[:marketplaceIds] = @api_client.build_collection_param(marketplace_ids, :csv) # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] return_type = opts[:return_type] || 'SmallAndLightEnrollment' 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: SmallAndLightApi#get_small_and_light_enrollment_by_seller_sku\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging [data, status_code, headers] end |
#get_small_and_light_fee_preview(body, opts = {}) ⇒ SmallAndLightFeePreviews
Returns the Small and Light fee estimates for the specified items. You must include a marketplaceId parameter to retrieve the proper fee estimates for items to be sold in that marketplace. The ordering of items in the response will mirror the order of the items in the request. Duplicate ASIN/price combinations are removed. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 3 | 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).
187 188 189 190 |
# File 'lib/fba_small_and_light_api_model/api/small_and_light_api.rb', line 187 def get_small_and_light_fee_preview(body, opts = {}) data, _status_code, _headers = get_small_and_light_fee_preview_with_http_info(body, opts) data end |
#get_small_and_light_fee_preview_with_http_info(body, opts = {}) ⇒ Array<(SmallAndLightFeePreviews, Integer, Hash)>
Returns the Small and Light fee estimates for the specified items. You must include a marketplaceId parameter to retrieve the proper fee estimates for items to be sold in that marketplace. The ordering of items in the response will mirror the order of the items in the request. Duplicate ASIN/price combinations are removed. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 1 | 3 | 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).
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 |
# File 'lib/fba_small_and_light_api_model/api/small_and_light_api.rb', line 196 def get_small_and_light_fee_preview_with_http_info(body, opts = {}) @api_client.config.logger.debug 'Calling API: SmallAndLightApi.get_small_and_light_fee_preview ...' if @api_client.config.debugging # verify the required parameter 'body' is set raise ArgumentError, "Missing the required parameter 'body' when calling SmallAndLightApi.get_small_and_light_fee_preview" if @api_client.config.client_side_validation && body.nil? # resource path local_var_path = '/fba/smallAndLight/v1/feePreviews' # 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']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(body) return_type = opts[:return_type] || 'SmallAndLightFeePreviews' auth_names = opts[:auth_names] || [] data, status_code, headers = @api_client.call_api(:POST, 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: SmallAndLightApi#get_small_and_light_fee_preview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging [data, status_code, headers] end |
#put_small_and_light_enrollment_by_seller_sku(seller_sku, marketplace_ids, opts = {}) ⇒ SmallAndLightEnrollment
Enrolls the item indicated by the specified seller SKU in the Small and Light program in the specified marketplace. If the item is not eligible, the ineligibility reasons are returned. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 5 | 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).
240 241 242 243 |
# File 'lib/fba_small_and_light_api_model/api/small_and_light_api.rb', line 240 def put_small_and_light_enrollment_by_seller_sku(seller_sku, marketplace_ids, opts = {}) data, _status_code, _headers = put_small_and_light_enrollment_by_seller_sku_with_http_info(seller_sku, marketplace_ids, opts) data end |
#put_small_and_light_enrollment_by_seller_sku_with_http_info(seller_sku, marketplace_ids, opts = {}) ⇒ Array<(SmallAndLightEnrollment, Integer, Hash)>
Enrolls the item indicated by the specified seller SKU in the Small and Light program in the specified marketplace. If the item is not eligible, the ineligibility reasons are returned. **Usage Plan:** | Rate (requests per second) | Burst | | —- | —- | | 2 | 5 | 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).
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 |
# File 'lib/fba_small_and_light_api_model/api/small_and_light_api.rb', line 250 def put_small_and_light_enrollment_by_seller_sku_with_http_info(seller_sku, marketplace_ids, opts = {}) @api_client.config.logger.debug 'Calling API: SmallAndLightApi.put_small_and_light_enrollment_by_seller_sku ...' if @api_client.config.debugging # verify the required parameter 'seller_sku' is set raise ArgumentError, "Missing the required parameter 'seller_sku' when calling SmallAndLightApi.put_small_and_light_enrollment_by_seller_sku" if @api_client.config.client_side_validation && seller_sku.nil? # verify the required parameter 'marketplace_ids' is set raise ArgumentError, "Missing the required parameter 'marketplace_ids' when calling SmallAndLightApi.put_small_and_light_enrollment_by_seller_sku" if @api_client.config.client_side_validation && marketplace_ids.nil? # resource path local_var_path = '/fba/smallAndLight/v1/enrollments/{sellerSKU}'.sub('{' + 'sellerSKU' + '}', seller_sku.to_s) # query parameters query_params = opts[:query_params] || {} query_params[:marketplaceIds] = @api_client.build_collection_param(marketplace_ids, :csv) # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] return_type = opts[:return_type] || 'SmallAndLightEnrollment' auth_names = opts[:auth_names] || [] data, status_code, headers = @api_client.call_api(:PUT, 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: SmallAndLightApi#put_small_and_light_enrollment_by_seller_sku\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging [data, status_code, headers] end |