Class: AmznSpApi::ListingsItemsApiModel::ListingsApi
- Inherits:
-
Object
- Object
- AmznSpApi::ListingsItemsApiModel::ListingsApi
- Defined in:
- lib/listings_items_api_model/api/listings_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#delete_listings_item(seller_id, sku, marketplace_ids, opts = {}) ⇒ ListingsItemSubmissionResponse
Delete a listings item for a selling partner.
-
#delete_listings_item_with_http_info(seller_id, sku, marketplace_ids, opts = {}) ⇒ Array<(ListingsItemSubmissionResponse, Integer, Hash)>
Delete a listings item for a selling partner.
-
#get_listings_item(seller_id, sku, marketplace_ids, opts = {}) ⇒ Item
Returns details about a listings item for a selling partner.
-
#get_listings_item_with_http_info(seller_id, sku, marketplace_ids, opts = {}) ⇒ Array<(Item, Integer, Hash)>
Returns details about a listings item for a selling partner.
-
#initialize(api_client = ApiClient.default) ⇒ ListingsApi
constructor
A new instance of ListingsApi.
-
#patch_listings_item(body, marketplace_ids, seller_id, sku, opts = {}) ⇒ ListingsItemSubmissionResponse
Partially update (patch) a listings item for a selling partner.
-
#patch_listings_item_with_http_info(body, marketplace_ids, seller_id, sku, opts = {}) ⇒ Array<(ListingsItemSubmissionResponse, Integer, Hash)>
Partially update (patch) a listings item for a selling partner.
-
#put_listings_item(body, marketplace_ids, seller_id, sku, opts = {}) ⇒ ListingsItemSubmissionResponse
Creates a new or fully-updates an existing listings item for a selling partner.
-
#put_listings_item_with_http_info(body, marketplace_ids, seller_id, sku, opts = {}) ⇒ Array<(ListingsItemSubmissionResponse, Integer, Hash)>
Creates a new or fully-updates an existing listings item for a selling partner.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ ListingsApi
Returns a new instance of ListingsApi.
14 15 16 |
# File 'lib/listings_items_api_model/api/listings_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/listings_items_api_model/api/listings_api.rb', line 12 def api_client @api_client end |
Instance Method Details
#delete_listings_item(seller_id, sku, marketplace_ids, opts = {}) ⇒ ListingsItemSubmissionResponse
Delete a listings item for a selling partner. 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 | | —- | —- | | 5 | 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).
25 26 27 28 |
# File 'lib/listings_items_api_model/api/listings_api.rb', line 25 def delete_listings_item(seller_id, sku, marketplace_ids, opts = {}) data, _status_code, _headers = delete_listings_item_with_http_info(seller_id, sku, marketplace_ids, opts) data end |
#delete_listings_item_with_http_info(seller_id, sku, marketplace_ids, opts = {}) ⇒ Array<(ListingsItemSubmissionResponse, Integer, Hash)>
Delete a listings item for a selling partner. 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 | | —- | —- | | 5 | 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).
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 78 |
# File 'lib/listings_items_api_model/api/listings_api.rb', line 37 def delete_listings_item_with_http_info(seller_id, sku, marketplace_ids, opts = {}) @api_client.config.logger.debug 'Calling API: ListingsApi.delete_listings_item ...' if @api_client.config.debugging # verify the required parameter 'seller_id' is set raise ArgumentError, "Missing the required parameter 'seller_id' when calling ListingsApi.delete_listings_item" if @api_client.config.client_side_validation && seller_id.nil? # verify the required parameter 'sku' is set raise ArgumentError, "Missing the required parameter 'sku' when calling ListingsApi.delete_listings_item" if @api_client.config.client_side_validation && sku.nil? # verify the required parameter 'marketplace_ids' is set raise ArgumentError, "Missing the required parameter 'marketplace_ids' when calling ListingsApi.delete_listings_item" if @api_client.config.client_side_validation && marketplace_ids.nil? # resource path local_var_path = '/listings/2021-08-01/items/{sellerId}/{sku}'.sub('{' + 'sellerId' + '}', seller_id.to_s).sub('{' + 'sku' + '}', sku.to_s) # query parameters query_params = opts[:query_params] || {} query_params[:marketplaceIds] = @api_client.build_collection_param(marketplace_ids, :csv) query_params[:issueLocale] = opts[:issue_locale] unless opts[:issue_locale].nil? # 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] || 'ListingsItemSubmissionResponse' 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: ListingsApi#delete_listings_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging [data, status_code, headers] end |
#get_listings_item(seller_id, sku, marketplace_ids, opts = {}) ⇒ Item
Returns details about a listings item for a selling partner. 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 | | —- | —- | | 5 | 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 |
# File 'lib/listings_items_api_model/api/listings_api.rb', line 88 def get_listings_item(seller_id, sku, marketplace_ids, opts = {}) data, _status_code, _headers = get_listings_item_with_http_info(seller_id, sku, marketplace_ids, opts) data end |
#get_listings_item_with_http_info(seller_id, sku, marketplace_ids, opts = {}) ⇒ Array<(Item, Integer, Hash)>
Returns details about a listings item for a selling partner. 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 | | —- | —- | | 5 | 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).
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 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 |
# File 'lib/listings_items_api_model/api/listings_api.rb', line 101 def get_listings_item_with_http_info(seller_id, sku, marketplace_ids, opts = {}) @api_client.config.logger.debug 'Calling API: ListingsApi.get_listings_item ...' if @api_client.config.debugging # verify the required parameter 'seller_id' is set raise ArgumentError, "Missing the required parameter 'seller_id' when calling ListingsApi.get_listings_item" if @api_client.config.client_side_validation && seller_id.nil? # verify the required parameter 'sku' is set raise ArgumentError, "Missing the required parameter 'sku' when calling ListingsApi.get_listings_item" if @api_client.config.client_side_validation && sku.nil? # verify the required parameter 'marketplace_ids' is set raise ArgumentError, "Missing the required parameter 'marketplace_ids' when calling ListingsApi.get_listings_item" if @api_client.config.client_side_validation && marketplace_ids.nil? raise ArgumentError, 'invalid value for "included_data", must include one of summaries, attributes, issues, offers, fulfillmentAvailability, procurement' if @api_client.config.client_side_validation && opts[:included_data] && !opts[:included_data].all? { |item| %w[summaries attributes issues offers fulfillmentAvailability procurement].include?(item) } # resource path local_var_path = '/listings/2021-08-01/items/{sellerId}/{sku}'.sub('{' + 'sellerId' + '}', seller_id.to_s).sub('{' + 'sku' + '}', sku.to_s) # query parameters query_params = opts[:query_params] || {} query_params[:marketplaceIds] = @api_client.build_collection_param(marketplace_ids, :csv) query_params[:issueLocale] = opts[:issue_locale] unless opts[:issue_locale].nil? query_params[:includedData] = @api_client.build_collection_param(opts[:included_data], :csv) unless opts[:included_data].nil? # 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] || 'Item' 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: ListingsApi#get_listings_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging [data, status_code, headers] end |
#patch_listings_item(body, marketplace_ids, seller_id, sku, opts = {}) ⇒ ListingsItemSubmissionResponse
Partially update (patch) a listings item for a selling partner. Only top-level listings item attributes can be patched. Patching nested attributes is not supported. 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 | | —- | —- | | 5 | 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).
154 155 156 157 |
# File 'lib/listings_items_api_model/api/listings_api.rb', line 154 def patch_listings_item(body, marketplace_ids, seller_id, sku, opts = {}) data, _status_code, _headers = patch_listings_item_with_http_info(body, marketplace_ids, seller_id, sku, opts) data end |
#patch_listings_item_with_http_info(body, marketplace_ids, seller_id, sku, opts = {}) ⇒ Array<(ListingsItemSubmissionResponse, Integer, Hash)>
Partially update (patch) a listings item for a selling partner. Only top-level listings item attributes can be patched. Patching nested attributes is not supported. 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 | | —- | —- | | 5 | 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).
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 |
# File 'lib/listings_items_api_model/api/listings_api.rb', line 167 def patch_listings_item_with_http_info(body, marketplace_ids, seller_id, sku, opts = {}) @api_client.config.logger.debug 'Calling API: ListingsApi.patch_listings_item ...' if @api_client.config.debugging # verify the required parameter 'body' is set raise ArgumentError, "Missing the required parameter 'body' when calling ListingsApi.patch_listings_item" if @api_client.config.client_side_validation && body.nil? # verify the required parameter 'marketplace_ids' is set raise ArgumentError, "Missing the required parameter 'marketplace_ids' when calling ListingsApi.patch_listings_item" if @api_client.config.client_side_validation && marketplace_ids.nil? # verify the required parameter 'seller_id' is set raise ArgumentError, "Missing the required parameter 'seller_id' when calling ListingsApi.patch_listings_item" if @api_client.config.client_side_validation && seller_id.nil? # verify the required parameter 'sku' is set raise ArgumentError, "Missing the required parameter 'sku' when calling ListingsApi.patch_listings_item" if @api_client.config.client_side_validation && sku.nil? # resource path local_var_path = '/listings/2021-08-01/items/{sellerId}/{sku}'.sub('{' + 'sellerId' + '}', seller_id.to_s).sub('{' + 'sku' + '}', sku.to_s) # query parameters query_params = opts[:query_params] || {} query_params[:marketplaceIds] = @api_client.build_collection_param(marketplace_ids, :csv) query_params[:issueLocale] = opts[:issue_locale] unless opts[:issue_locale].nil? # 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] || 'ListingsItemSubmissionResponse' auth_names = opts[:auth_names] || [] data, status_code, headers = @api_client.call_api(:PATCH, 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: ListingsApi#patch_listings_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging [data, status_code, headers] end |
#put_listings_item(body, marketplace_ids, seller_id, sku, opts = {}) ⇒ ListingsItemSubmissionResponse
Creates a new or fully-updates an existing listings item for a selling partner. 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 | | —- | —- | | 5 | 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).
222 223 224 225 |
# File 'lib/listings_items_api_model/api/listings_api.rb', line 222 def put_listings_item(body, marketplace_ids, seller_id, sku, opts = {}) data, _status_code, _headers = put_listings_item_with_http_info(body, marketplace_ids, seller_id, sku, opts) data end |
#put_listings_item_with_http_info(body, marketplace_ids, seller_id, sku, opts = {}) ⇒ Array<(ListingsItemSubmissionResponse, Integer, Hash)>
Creates a new or fully-updates an existing listings item for a selling partner. 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 | | —- | —- | | 5 | 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).
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 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 |
# File 'lib/listings_items_api_model/api/listings_api.rb', line 235 def put_listings_item_with_http_info(body, marketplace_ids, seller_id, sku, opts = {}) @api_client.config.logger.debug 'Calling API: ListingsApi.put_listings_item ...' if @api_client.config.debugging # verify the required parameter 'body' is set raise ArgumentError, "Missing the required parameter 'body' when calling ListingsApi.put_listings_item" if @api_client.config.client_side_validation && body.nil? # verify the required parameter 'marketplace_ids' is set raise ArgumentError, "Missing the required parameter 'marketplace_ids' when calling ListingsApi.put_listings_item" if @api_client.config.client_side_validation && marketplace_ids.nil? # verify the required parameter 'seller_id' is set raise ArgumentError, "Missing the required parameter 'seller_id' when calling ListingsApi.put_listings_item" if @api_client.config.client_side_validation && seller_id.nil? # verify the required parameter 'sku' is set raise ArgumentError, "Missing the required parameter 'sku' when calling ListingsApi.put_listings_item" if @api_client.config.client_side_validation && sku.nil? # resource path local_var_path = '/listings/2021-08-01/items/{sellerId}/{sku}'.sub('{' + 'sellerId' + '}', seller_id.to_s).sub('{' + 'sku' + '}', sku.to_s) # query parameters query_params = opts[:query_params] || {} query_params[:marketplaceIds] = @api_client.build_collection_param(marketplace_ids, :csv) query_params[:issueLocale] = opts[:issue_locale] unless opts[:issue_locale].nil? # 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] || 'ListingsItemSubmissionResponse' 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: ListingsApi#put_listings_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging [data, status_code, headers] end |