amz_sp_api 0.2.1 → 1.0.0

data/lib/catalog-items-api-model/api/catalog_api.rb

@@ -1,9 +1,9 @@
 =begin
 #Selling Partner API for Catalog Items
 
-#The Selling Partner API for Catalog Items helps you programmatically retrieve item details for items in the catalog.
+#The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog.  For more information, refer to the [Catalog Items API Use Case Guide](doc:catalog-items-api-v2022-04-01-use-case-guide).
 
-OpenAPI spec version: v0
+OpenAPI spec version: 2022-04-01
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 3.0.24
@@ -16,39 +16,48 @@ module AmzSpApi::CatalogItemsApiModel
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Returns a specified item and its attributes.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
-    # @param marketplace_id A marketplace identifier. Specifies the marketplace for the item.
+    # Retrieves details for an item in the Amazon catalog.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 |  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 observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).
     # @param asin The Amazon Standard Identification Number (ASIN) of the item.
+    # @param marketplace_ids A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces.
     # @param [Hash] opts the optional parameters
-    # @return [GetCatalogItemResponse]
-    def get_catalog_item(marketplace_id, asin, opts = {})
-      data, _status_code, _headers = get_catalog_item_with_http_info(marketplace_id, asin, opts)
+    # @option opts [Array<String>] :included_data A comma-delimited list of data sets to include in the response. Default: &#x60;summaries&#x60;.
+    # @option opts [String] :locale Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.
+    # @return [Item]
+    def get_catalog_item(asin, marketplace_ids, opts = {})
+      data, _status_code, _headers = get_catalog_item_with_http_info(asin, marketplace_ids, opts)
       data
     end
 
-    # Returns a specified item and its attributes.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  For more information, see \&quot;Usage Plans and Rate Limits\&quot; in the Selling Partner API documentation.
-    # @param marketplace_id A marketplace identifier. Specifies the marketplace for the item.
+    # Retrieves details for an item in the Amazon catalog.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 |  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 observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).
     # @param asin The Amazon Standard Identification Number (ASIN) of the item.
+    # @param marketplace_ids A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces.
     # @param [Hash] opts the optional parameters
-    # @return [Array<(GetCatalogItemResponse, Integer, Hash)>] GetCatalogItemResponse data, response status code and response headers
-    def get_catalog_item_with_http_info(marketplace_id, asin, opts = {})
+    # @option opts [Array<String>] :included_data A comma-delimited list of data sets to include in the response. Default: &#x60;summaries&#x60;.
+    # @option opts [String] :locale Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.
+    # @return [Array<(Item, Integer, Hash)>] Item data, response status code and response headers
+    def get_catalog_item_with_http_info(asin, marketplace_ids, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: CatalogApi.get_catalog_item ...'
       end
-      # verify the required parameter 'marketplace_id' is set
-      if @api_client.config.client_side_validation && marketplace_id.nil?
-        fail ArgumentError, "Missing the required parameter 'marketplace_id' when calling CatalogApi.get_catalog_item"
-      end
       # verify the required parameter 'asin' is set
       if @api_client.config.client_side_validation && asin.nil?
         fail ArgumentError, "Missing the required parameter 'asin' when calling CatalogApi.get_catalog_item"
       end
+      # verify the required parameter 'marketplace_ids' is set
+      if @api_client.config.client_side_validation && marketplace_ids.nil?
+        fail ArgumentError, "Missing the required parameter 'marketplace_ids' when calling CatalogApi.get_catalog_item"
+      end
+      if @api_client.config.client_side_validation && opts[:'included_data'] && !opts[:'included_data'].all? { |item| ['attributes', 'dimensions', 'identifiers', 'images', 'productTypes', 'relationships', 'salesRanks', 'summaries', 'vendorDetails'].include?(item) }
+        fail ArgumentError, 'invalid value for "included_data", must include one of attributes, dimensions, identifiers, images, productTypes, relationships, salesRanks, summaries, vendorDetails'
+      end
       # resource path
-      local_var_path = '/catalog/v0/items/{asin}'.sub('{' + 'asin' + '}', asin.to_s)
+      local_var_path = '/catalog/2022-04-01/items/{asin}'.sub('{' + 'asin' + '}', asin.to_s)
 
       # query parameters
       query_params = opts[:query_params] || {}
-      query_params[:'MarketplaceId'] = marketplace_id
+      query_params[:'marketplaceIds'] = @api_client.build_collection_param(marketplace_ids, :csv)
+      query_params[:'includedData'] = @api_client.build_collection_param(opts[:'included_data'], :csv) if !opts[:'included_data'].nil?
+      query_params[:'locale'] = opts[:'locale'] if !opts[:'locale'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -61,7 +70,7 @@ module AmzSpApi::CatalogItemsApiModel
       # http body (model)
       post_body = opts[:body] 
 
-      return_type = opts[:return_type] || 'GetCatalogItemResponse' 
+      return_type = opts[:return_type] || 'Item' 
 
       auth_names = opts[:auth_names] || []
       data, status_code, headers = @api_client.call_api(:GET, local_var_path,
@@ -77,115 +86,72 @@ module AmzSpApi::CatalogItemsApiModel
       end
       return data, status_code, headers
     end
-    # Returns the parent categories to which an item belongs, based on the specified ASIN or SellerSKU.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
-    # @param marketplace_id A marketplace identifier. Specifies the marketplace for the item.
+    # Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords.  **Usage Plans:**  | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 |  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 observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).
+    # @param marketplace_ids A comma-delimited list of Amazon marketplace identifiers for the request.
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :asin The Amazon Standard Identification Number (ASIN) of the item.
-    # @option opts [String] :seller_sku Used to identify items in the given marketplace. SellerSKU is qualified by the seller&#x27;s SellerId, which is included with every operation that you submit.
-    # @return [ListCatalogCategoriesResponse]
-    def list_catalog_categories(marketplace_id, opts = {})
-      data, _status_code, _headers = list_catalog_categories_with_http_info(marketplace_id, opts)
+    # @option opts [Array<String>] :identifiers A comma-delimited list of product identifiers to search the Amazon catalog for. **Note:** Cannot be used with &#x60;keywords&#x60;.
+    # @option opts [String] :identifiers_type Type of product identifiers to search the Amazon catalog for. **Note:** Required when &#x60;identifiers&#x60; are provided.
+    # @option opts [Array<String>] :included_data A comma-delimited list of data sets to include in the response. Default: &#x60;summaries&#x60;.
+    # @option opts [String] :locale Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.
+    # @option opts [String] :seller_id A selling partner identifier, such as a seller account or vendor code. **Note:** Required when &#x60;identifiersType&#x60; is &#x60;SKU&#x60;.
+    # @option opts [Array<String>] :keywords A comma-delimited list of words to search the Amazon catalog for. **Note:** Cannot be used with &#x60;identifiers&#x60;.
+    # @option opts [Array<String>] :brand_names A comma-delimited list of brand names to limit the search for &#x60;keywords&#x60;-based queries. **Note:** Cannot be used with &#x60;identifiers&#x60;.
+    # @option opts [Array<String>] :classification_ids A comma-delimited list of classification identifiers to limit the search for &#x60;keywords&#x60;-based queries. **Note:** Cannot be used with &#x60;identifiers&#x60;.
+    # @option opts [Integer] :page_size Number of results to be returned per page. (default to 10)
+    # @option opts [String] :page_token A token to fetch a certain page when there are multiple pages worth of results.
+    # @option opts [String] :keywords_locale The language of the keywords provided for &#x60;keywords&#x60;-based queries. Defaults to the primary locale of the marketplace. **Note:** Cannot be used with &#x60;identifiers&#x60;.
+    # @return [ItemSearchResults]
+    def search_catalog_items(marketplace_ids, opts = {})
+      data, _status_code, _headers = search_catalog_items_with_http_info(marketplace_ids, opts)
       data
     end
 
-    # Returns the parent categories to which an item belongs, based on the specified ASIN or SellerSKU.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  For more information, see \&quot;Usage Plans and Rate Limits\&quot; in the Selling Partner API documentation.
-    # @param marketplace_id A marketplace identifier. Specifies the marketplace for the item.
+    # Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords.  **Usage Plans:**  | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 |  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 observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).
+    # @param marketplace_ids A comma-delimited list of Amazon marketplace identifiers for the request.
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :asin The Amazon Standard Identification Number (ASIN) of the item.
-    # @option opts [String] :seller_sku Used to identify items in the given marketplace. SellerSKU is qualified by the seller&#x27;s SellerId, which is included with every operation that you submit.
-    # @return [Array<(ListCatalogCategoriesResponse, Integer, Hash)>] ListCatalogCategoriesResponse data, response status code and response headers
-    def list_catalog_categories_with_http_info(marketplace_id, opts = {})
+    # @option opts [Array<String>] :identifiers A comma-delimited list of product identifiers to search the Amazon catalog for. **Note:** Cannot be used with &#x60;keywords&#x60;.
+    # @option opts [String] :identifiers_type Type of product identifiers to search the Amazon catalog for. **Note:** Required when &#x60;identifiers&#x60; are provided.
+    # @option opts [Array<String>] :included_data A comma-delimited list of data sets to include in the response. Default: &#x60;summaries&#x60;.
+    # @option opts [String] :locale Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.
+    # @option opts [String] :seller_id A selling partner identifier, such as a seller account or vendor code. **Note:** Required when &#x60;identifiersType&#x60; is &#x60;SKU&#x60;.
+    # @option opts [Array<String>] :keywords A comma-delimited list of words to search the Amazon catalog for. **Note:** Cannot be used with &#x60;identifiers&#x60;.
+    # @option opts [Array<String>] :brand_names A comma-delimited list of brand names to limit the search for &#x60;keywords&#x60;-based queries. **Note:** Cannot be used with &#x60;identifiers&#x60;.
+    # @option opts [Array<String>] :classification_ids A comma-delimited list of classification identifiers to limit the search for &#x60;keywords&#x60;-based queries. **Note:** Cannot be used with &#x60;identifiers&#x60;.
+    # @option opts [Integer] :page_size Number of results to be returned per page.
+    # @option opts [String] :page_token A token to fetch a certain page when there are multiple pages worth of results.
+    # @option opts [String] :keywords_locale The language of the keywords provided for &#x60;keywords&#x60;-based queries. Defaults to the primary locale of the marketplace. **Note:** Cannot be used with &#x60;identifiers&#x60;.
+    # @return [Array<(ItemSearchResults, Integer, Hash)>] ItemSearchResults data, response status code and response headers
+    def search_catalog_items_with_http_info(marketplace_ids, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: CatalogApi.list_catalog_categories ...'
+        @api_client.config.logger.debug 'Calling API: CatalogApi.search_catalog_items ...'
       end
-      # verify the required parameter 'marketplace_id' is set
-      if @api_client.config.client_side_validation && marketplace_id.nil?
-        fail ArgumentError, "Missing the required parameter 'marketplace_id' when calling CatalogApi.list_catalog_categories"
+      # verify the required parameter 'marketplace_ids' is set
+      if @api_client.config.client_side_validation && marketplace_ids.nil?
+        fail ArgumentError, "Missing the required parameter 'marketplace_ids' when calling CatalogApi.search_catalog_items"
       end
-      # resource path
-      local_var_path = '/catalog/v0/categories'
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-      query_params[:'MarketplaceId'] = marketplace_id
-      query_params[:'ASIN'] = opts[:'asin'] if !opts[:'asin'].nil?
-      query_params[:'SellerSKU'] = opts[:'seller_sku'] if !opts[:'seller_sku'].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] || 'ListCatalogCategoriesResponse' 
-
-      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)
-
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: CatalogApi#list_catalog_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-    # Returns a list of items and their attributes, based on a search query or item identifiers that you specify. When based on a search query, provide the Query parameter and optionally, the QueryContextId parameter. When based on item identifiers, provide a single appropriate parameter based on the identifier type, and specify the associated item value. MarketplaceId is always required.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
-    # @param marketplace_id A marketplace identifier. Specifies the marketplace for which items are returned.
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :query Keyword(s) to use to search for items in the catalog. Example: &#x27;harry potter books&#x27;.
-    # @option opts [String] :query_context_id An identifier for the context within which the given search will be performed. A marketplace might provide mechanisms for constraining a search to a subset of potential items. For example, the retail marketplace allows queries to be constrained to a specific category. The QueryContextId parameter specifies such a subset. If it is omitted, the search will be performed using the default context for the marketplace, which will typically contain the largest set of items.
-    # @option opts [String] :seller_sku Used to identify an item in the given marketplace. SellerSKU is qualified by the seller&#x27;s SellerId, which is included with every operation that you submit.
-    # @option opts [String] :upc A 12-digit bar code used for retail packaging.
-    # @option opts [String] :ean A European article number that uniquely identifies the catalog item, manufacturer, and its attributes.
-    # @option opts [String] :isbn The unique commercial book identifier used to identify books internationally.
-    # @option opts [String] :jan A Japanese article number that uniquely identifies the product, manufacturer, and its attributes.
-    # @return [ListCatalogItemsResponse]
-    def list_catalog_items(marketplace_id, opts = {})
-      data, _status_code, _headers = list_catalog_items_with_http_info(marketplace_id, opts)
-      data
-    end
-
-    # Returns a list of items and their attributes, based on a search query or item identifiers that you specify. When based on a search query, provide the Query parameter and optionally, the QueryContextId parameter. When based on item identifiers, provide a single appropriate parameter based on the identifier type, and specify the associated item value. MarketplaceId is always required.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  For more information, see \&quot;Usage Plans and Rate Limits\&quot; in the Selling Partner API documentation.
-    # @param marketplace_id A marketplace identifier. Specifies the marketplace for which items are returned.
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :query Keyword(s) to use to search for items in the catalog. Example: &#x27;harry potter books&#x27;.
-    # @option opts [String] :query_context_id An identifier for the context within which the given search will be performed. A marketplace might provide mechanisms for constraining a search to a subset of potential items. For example, the retail marketplace allows queries to be constrained to a specific category. The QueryContextId parameter specifies such a subset. If it is omitted, the search will be performed using the default context for the marketplace, which will typically contain the largest set of items.
-    # @option opts [String] :seller_sku Used to identify an item in the given marketplace. SellerSKU is qualified by the seller&#x27;s SellerId, which is included with every operation that you submit.
-    # @option opts [String] :upc A 12-digit bar code used for retail packaging.
-    # @option opts [String] :ean A European article number that uniquely identifies the catalog item, manufacturer, and its attributes.
-    # @option opts [String] :isbn The unique commercial book identifier used to identify books internationally.
-    # @option opts [String] :jan A Japanese article number that uniquely identifies the product, manufacturer, and its attributes.
-    # @return [Array<(ListCatalogItemsResponse, Integer, Hash)>] ListCatalogItemsResponse data, response status code and response headers
-    def list_catalog_items_with_http_info(marketplace_id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: CatalogApi.list_catalog_items ...'
+      if @api_client.config.client_side_validation && opts[:'identifiers_type'] && !['ASIN', 'EAN', 'GTIN', 'ISBN', 'JAN', 'MINSAN', 'SKU', 'UPC'].include?(opts[:'identifiers_type'])
+        fail ArgumentError, 'invalid value for "identifiers_type", must be one of ASIN, EAN, GTIN, ISBN, JAN, MINSAN, SKU, UPC'
       end
-      # verify the required parameter 'marketplace_id' is set
-      if @api_client.config.client_side_validation && marketplace_id.nil?
-        fail ArgumentError, "Missing the required parameter 'marketplace_id' when calling CatalogApi.list_catalog_items"
+      if @api_client.config.client_side_validation && opts[:'included_data'] && !opts[:'included_data'].all? { |item| ['attributes', 'dimensions', 'identifiers', 'images', 'productTypes', 'relationships', 'salesRanks', 'summaries', 'vendorDetails'].include?(item) }
+        fail ArgumentError, 'invalid value for "included_data", must include one of attributes, dimensions, identifiers, images, productTypes, relationships, salesRanks, summaries, vendorDetails'
       end
       # resource path
-      local_var_path = '/catalog/v0/items'
+      local_var_path = '/catalog/2022-04-01/items'
 
       # query parameters
       query_params = opts[:query_params] || {}
-      query_params[:'MarketplaceId'] = marketplace_id
-      query_params[:'Query'] = opts[:'query'] if !opts[:'query'].nil?
-      query_params[:'QueryContextId'] = opts[:'query_context_id'] if !opts[:'query_context_id'].nil?
-      query_params[:'SellerSKU'] = opts[:'seller_sku'] if !opts[:'seller_sku'].nil?
-      query_params[:'UPC'] = opts[:'upc'] if !opts[:'upc'].nil?
-      query_params[:'EAN'] = opts[:'ean'] if !opts[:'ean'].nil?
-      query_params[:'ISBN'] = opts[:'isbn'] if !opts[:'isbn'].nil?
-      query_params[:'JAN'] = opts[:'jan'] if !opts[:'jan'].nil?
+      query_params[:'marketplaceIds'] = @api_client.build_collection_param(marketplace_ids, :csv)
+      query_params[:'identifiers'] = @api_client.build_collection_param(opts[:'identifiers'], :csv) if !opts[:'identifiers'].nil?
+      query_params[:'identifiersType'] = opts[:'identifiers_type'] if !opts[:'identifiers_type'].nil?
+      query_params[:'includedData'] = @api_client.build_collection_param(opts[:'included_data'], :csv) if !opts[:'included_data'].nil?
+      query_params[:'locale'] = opts[:'locale'] if !opts[:'locale'].nil?
+      query_params[:'sellerId'] = opts[:'seller_id'] if !opts[:'seller_id'].nil?
+      query_params[:'keywords'] = @api_client.build_collection_param(opts[:'keywords'], :csv) if !opts[:'keywords'].nil?
+      query_params[:'brandNames'] = @api_client.build_collection_param(opts[:'brand_names'], :csv) if !opts[:'brand_names'].nil?
+      query_params[:'classificationIds'] = @api_client.build_collection_param(opts[:'classification_ids'], :csv) if !opts[:'classification_ids'].nil?
+      query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'pageToken'] = opts[:'page_token'] if !opts[:'page_token'].nil?
+      query_params[:'keywordsLocale'] = opts[:'keywords_locale'] if !opts[:'keywords_locale'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -198,7 +164,7 @@ module AmzSpApi::CatalogItemsApiModel
       # http body (model)
       post_body = opts[:body] 
 
-      return_type = opts[:return_type] || 'ListCatalogItemsResponse' 
+      return_type = opts[:return_type] || 'ItemSearchResults' 
 
       auth_names = opts[:auth_names] || []
       data, status_code, headers = @api_client.call_api(:GET, local_var_path,
@@ -210,7 +176,7 @@ module AmzSpApi::CatalogItemsApiModel
         :return_type => return_type)
 
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: CatalogApi#list_catalog_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: CatalogApi#search_catalog_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end

data/lib/catalog-items-api-model/api_client.rb

@@ -1,9 +1,9 @@
 =begin
 #Selling Partner API for Catalog Items
 
-#The Selling Partner API for Catalog Items helps you programmatically retrieve item details for items in the catalog.
+#The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog.  For more information, refer to the [Catalog Items API Use Case Guide](doc:catalog-items-api-v2022-04-01-use-case-guide).
 
-OpenAPI spec version: v0
+OpenAPI spec version: 2022-04-01
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 3.0.24

data/lib/catalog-items-api-model/api_error.rb

@@ -1,9 +1,9 @@
 =begin
 #Selling Partner API for Catalog Items
 
-#The Selling Partner API for Catalog Items helps you programmatically retrieve item details for items in the catalog.
+#The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog.  For more information, refer to the [Catalog Items API Use Case Guide](doc:catalog-items-api-v2022-04-01-use-case-guide).
 
-OpenAPI spec version: v0
+OpenAPI spec version: 2022-04-01
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 3.0.24

data/lib/catalog-items-api-model/config.json

@@ -5,5 +5,5 @@
   "gemAuthor": "Eric Jensen",
   "gemAuthorEmail": "",
   "gemHomepage": "https://github.com/ericcj/amz_sp_api",
-  "gemLicense": "Apache 2.0"
-}
+  "gemLicense": "Apache-2.0"
+}

data/lib/catalog-items-api-model/configuration.rb

@@ -1,9 +1,9 @@
 =begin
 #Selling Partner API for Catalog Items
 
-#The Selling Partner API for Catalog Items helps you programmatically retrieve item details for items in the catalog.
+#The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog.  For more information, refer to the [Catalog Items API Use Case Guide](doc:catalog-items-api-v2022-04-01-use-case-guide).
 
-OpenAPI spec version: v0
+OpenAPI spec version: 2022-04-01
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 3.0.24

data/lib/catalog-items-api-model/docs/BrandRefinement.md

@@ -0,0 +1,8 @@
+# AmzSpApi::CatalogItemsApiModel::BrandRefinement
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**number_of_results** | **Integer** | The estimated number of results that would still be returned if refinement key applied. | 
+**brand_name** | **String** | Brand name. For display and can be used as a search refinement. | 
+

data/lib/catalog-items-api-model/docs/CatalogApi.md

@@ -4,16 +4,15 @@ All URIs are relative to *https://sellingpartnerapi-na.amazon.com/*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**get_catalog_item**](CatalogApi.md#get_catalog_item) | **GET** /catalog/v0/items/{asin} | 
-[**list_catalog_categories**](CatalogApi.md#list_catalog_categories) | **GET** /catalog/v0/categories | 
-[**list_catalog_items**](CatalogApi.md#list_catalog_items) | **GET** /catalog/v0/items | 
+[**get_catalog_item**](CatalogApi.md#get_catalog_item) | **GET** /catalog/2022-04-01/items/{asin} | 
+[**search_catalog_items**](CatalogApi.md#search_catalog_items) | **GET** /catalog/2022-04-01/items | 
 
 # **get_catalog_item**
-> GetCatalogItemResponse get_catalog_item(marketplace_id, asin)
+> Item get_catalog_item(asin, marketplace_ids, opts)
 
 
 
-Returns a specified item and its attributes.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
+Retrieves details for an item in the Amazon catalog.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 |  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 observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).
 
 ### Example
 ```ruby
@@ -21,64 +20,18 @@ Returns a specified item and its attributes.  **Usage Plan:**  | Rate (requests
 require 'catalog-items-api-model'
 
 api_instance = AmzSpApi::CatalogItemsApiModel::CatalogApi.new
-marketplace_id = 'marketplace_id_example' # String | A marketplace identifier. Specifies the marketplace for the item.
 asin = 'asin_example' # String | The Amazon Standard Identification Number (ASIN) of the item.
-
-
-begin
-  result = api_instance.get_catalog_item(marketplace_id, asin)
-  p result
-rescue AmzSpApi::CatalogItemsApiModel::ApiError => e
-  puts "Exception when calling CatalogApi->get_catalog_item: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **marketplace_id** | **String**| A marketplace identifier. Specifies the marketplace for the item. | 
- **asin** | **String**| The Amazon Standard Identification Number (ASIN) of the item. | 
-
-### Return type
-
-[**GetCatalogItemResponse**](GetCatalogItemResponse.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
-# **list_catalog_categories**
-> ListCatalogCategoriesResponse list_catalog_categories(marketplace_id, opts)
-
-
-
-Returns the parent categories to which an item belongs, based on the specified ASIN or SellerSKU.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
-
-### Example
-```ruby
-# load the gem
-require 'catalog-items-api-model'
-
-api_instance = AmzSpApi::CatalogItemsApiModel::CatalogApi.new
-marketplace_id = 'marketplace_id_example' # String | A marketplace identifier. Specifies the marketplace for the item.
+marketplace_ids = ['marketplace_ids_example'] # Array<String> | A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces.
 opts = { 
-  asin: 'asin_example', # String | The Amazon Standard Identification Number (ASIN) of the item.
-  seller_sku: 'seller_sku_example' # String | Used to identify items in the given marketplace. SellerSKU is qualified by the seller's SellerId, which is included with every operation that you submit.
+  included_data: ['included_data_example'], # Array<String> | A comma-delimited list of data sets to include in the response. Default: `summaries`.
+  locale: 'locale_example' # String | Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.
 }
 
 begin
-  result = api_instance.list_catalog_categories(marketplace_id, opts)
+  result = api_instance.get_catalog_item(asin, marketplace_ids, opts)
   p result
 rescue AmzSpApi::CatalogItemsApiModel::ApiError => e
-  puts "Exception when calling CatalogApi->list_catalog_categories: #{e}"
+  puts "Exception when calling CatalogApi->get_catalog_item: #{e}"
 end
 ```
 
@@ -86,13 +39,14 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **marketplace_id** | **String**| A marketplace identifier. Specifies the marketplace for the item. | 
- **asin** | **String**| The Amazon Standard Identification Number (ASIN) of the item. | [optional] 
- **seller_sku** | **String**| Used to identify items in the given marketplace. SellerSKU is qualified by the seller&#x27;s SellerId, which is included with every operation that you submit. | [optional] 
+ **asin** | **String**| The Amazon Standard Identification Number (ASIN) of the item. | 
+ **marketplace_ids** | [**Array&lt;String&gt;**](String.md)| A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces. | 
+ **included_data** | [**Array&lt;String&gt;**](String.md)| A comma-delimited list of data sets to include in the response. Default: &#x60;summaries&#x60;. | [optional] 
+ **locale** | **String**| Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. | [optional] 
 
 ### Return type
 
-[**ListCatalogCategoriesResponse**](ListCatalogCategoriesResponse.md)
+[**Item**](Item.md)
 
 ### Authorization
 
@@ -105,12 +59,12 @@ No authorization required
 
 
 
-# **list_catalog_items**
-> ListCatalogItemsResponse list_catalog_items(marketplace_id, opts)
+# **search_catalog_items**
+> ItemSearchResults search_catalog_items(marketplace_ids, opts)
 
 
 
-Returns a list of items and their attributes, based on a search query or item identifiers that you specify. When based on a search query, provide the Query parameter and optionally, the QueryContextId parameter. When based on item identifiers, provide a single appropriate parameter based on the identifier type, and specify the associated item value. MarketplaceId is always required.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
+Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords.  **Usage Plans:**  | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 |  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 observe higher rate and burst values than those shown here. For more information, refer to the [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).
 
 ### Example
 ```ruby
@@ -118,22 +72,26 @@ Returns a list of items and their attributes, based on a search query or item id
 require 'catalog-items-api-model'
 
 api_instance = AmzSpApi::CatalogItemsApiModel::CatalogApi.new
-marketplace_id = 'marketplace_id_example' # String | A marketplace identifier. Specifies the marketplace for which items are returned.
+marketplace_ids = ['marketplace_ids_example'] # Array<String> | A comma-delimited list of Amazon marketplace identifiers for the request.
 opts = { 
-  query: 'query_example', # String | Keyword(s) to use to search for items in the catalog. Example: 'harry potter books'.
-  query_context_id: 'query_context_id_example', # String | An identifier for the context within which the given search will be performed. A marketplace might provide mechanisms for constraining a search to a subset of potential items. For example, the retail marketplace allows queries to be constrained to a specific category. The QueryContextId parameter specifies such a subset. If it is omitted, the search will be performed using the default context for the marketplace, which will typically contain the largest set of items.
-  seller_sku: 'seller_sku_example', # String | Used to identify an item in the given marketplace. SellerSKU is qualified by the seller's SellerId, which is included with every operation that you submit.
-  upc: 'upc_example', # String | A 12-digit bar code used for retail packaging.
-  ean: 'ean_example', # String | A European article number that uniquely identifies the catalog item, manufacturer, and its attributes.
-  isbn: 'isbn_example', # String | The unique commercial book identifier used to identify books internationally.
-  jan: 'jan_example' # String | A Japanese article number that uniquely identifies the product, manufacturer, and its attributes.
+  identifiers: ['identifiers_example'], # Array<String> | A comma-delimited list of product identifiers to search the Amazon catalog for. **Note:** Cannot be used with `keywords`.
+  identifiers_type: 'identifiers_type_example', # String | Type of product identifiers to search the Amazon catalog for. **Note:** Required when `identifiers` are provided.
+  included_data: ['included_data_example'], # Array<String> | A comma-delimited list of data sets to include in the response. Default: `summaries`.
+  locale: 'locale_example', # String | Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.
+  seller_id: 'seller_id_example', # String | A selling partner identifier, such as a seller account or vendor code. **Note:** Required when `identifiersType` is `SKU`.
+  keywords: ['keywords_example'], # Array<String> | A comma-delimited list of words to search the Amazon catalog for. **Note:** Cannot be used with `identifiers`.
+  brand_names: ['brand_names_example'], # Array<String> | A comma-delimited list of brand names to limit the search for `keywords`-based queries. **Note:** Cannot be used with `identifiers`.
+  classification_ids: ['classification_ids_example'], # Array<String> | A comma-delimited list of classification identifiers to limit the search for `keywords`-based queries. **Note:** Cannot be used with `identifiers`.
+  page_size: 10, # Integer | Number of results to be returned per page.
+  page_token: 'page_token_example', # String | A token to fetch a certain page when there are multiple pages worth of results.
+  keywords_locale: 'keywords_locale_example' # String | The language of the keywords provided for `keywords`-based queries. Defaults to the primary locale of the marketplace. **Note:** Cannot be used with `identifiers`.
 }
 
 begin
-  result = api_instance.list_catalog_items(marketplace_id, opts)
+  result = api_instance.search_catalog_items(marketplace_ids, opts)
   p result
 rescue AmzSpApi::CatalogItemsApiModel::ApiError => e
-  puts "Exception when calling CatalogApi->list_catalog_items: #{e}"
+  puts "Exception when calling CatalogApi->search_catalog_items: #{e}"
 end
 ```
 
@@ -141,18 +99,22 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **marketplace_id** | **String**| A marketplace identifier. Specifies the marketplace for which items are returned. | 
- **query** | **String**| Keyword(s) to use to search for items in the catalog. Example: &#x27;harry potter books&#x27;. | [optional] 
- **query_context_id** | **String**| An identifier for the context within which the given search will be performed. A marketplace might provide mechanisms for constraining a search to a subset of potential items. For example, the retail marketplace allows queries to be constrained to a specific category. The QueryContextId parameter specifies such a subset. If it is omitted, the search will be performed using the default context for the marketplace, which will typically contain the largest set of items. | [optional] 
- **seller_sku** | **String**| Used to identify an item in the given marketplace. SellerSKU is qualified by the seller&#x27;s SellerId, which is included with every operation that you submit. | [optional] 
- **upc** | **String**| A 12-digit bar code used for retail packaging. | [optional] 
- **ean** | **String**| A European article number that uniquely identifies the catalog item, manufacturer, and its attributes. | [optional] 
- **isbn** | **String**| The unique commercial book identifier used to identify books internationally. | [optional] 
- **jan** | **String**| A Japanese article number that uniquely identifies the product, manufacturer, and its attributes. | [optional] 
+ **marketplace_ids** | [**Array&lt;String&gt;**](String.md)| A comma-delimited list of Amazon marketplace identifiers for the request. | 
+ **identifiers** | [**Array&lt;String&gt;**](String.md)| A comma-delimited list of product identifiers to search the Amazon catalog for. **Note:** Cannot be used with &#x60;keywords&#x60;. | [optional] 
+ **identifiers_type** | **String**| Type of product identifiers to search the Amazon catalog for. **Note:** Required when &#x60;identifiers&#x60; are provided. | [optional] 
+ **included_data** | [**Array&lt;String&gt;**](String.md)| A comma-delimited list of data sets to include in the response. Default: &#x60;summaries&#x60;. | [optional] 
+ **locale** | **String**| Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. | [optional] 
+ **seller_id** | **String**| A selling partner identifier, such as a seller account or vendor code. **Note:** Required when &#x60;identifiersType&#x60; is &#x60;SKU&#x60;. | [optional] 
+ **keywords** | [**Array&lt;String&gt;**](String.md)| A comma-delimited list of words to search the Amazon catalog for. **Note:** Cannot be used with &#x60;identifiers&#x60;. | [optional] 
+ **brand_names** | [**Array&lt;String&gt;**](String.md)| A comma-delimited list of brand names to limit the search for &#x60;keywords&#x60;-based queries. **Note:** Cannot be used with &#x60;identifiers&#x60;. | [optional] 
+ **classification_ids** | [**Array&lt;String&gt;**](String.md)| A comma-delimited list of classification identifiers to limit the search for &#x60;keywords&#x60;-based queries. **Note:** Cannot be used with &#x60;identifiers&#x60;. | [optional] 
+ **page_size** | **Integer**| Number of results to be returned per page. | [optional] [default to 10]
+ **page_token** | **String**| A token to fetch a certain page when there are multiple pages worth of results. | [optional] 
+ **keywords_locale** | **String**| The language of the keywords provided for &#x60;keywords&#x60;-based queries. Defaults to the primary locale of the marketplace. **Note:** Cannot be used with &#x60;identifiers&#x60;. | [optional] 
 
 ### Return type
 
-[**ListCatalogItemsResponse**](ListCatalogItemsResponse.md)
+[**ItemSearchResults**](ItemSearchResults.md)
 
 ### Authorization
 

data/lib/catalog-items-api-model/docs/ClassificationRefinement.md

@@ -0,0 +1,9 @@
+# AmzSpApi::CatalogItemsApiModel::ClassificationRefinement
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**number_of_results** | **Integer** | The estimated number of results that would still be returned if refinement key applied. | 
+**display_name** | **String** | Display name for the classification. | 
+**classification_id** | **String** | Identifier for the classification that can be used for search refinement purposes. | 
+

data/lib/catalog-items-api-model/docs/Dimension.md

@@ -0,0 +1,8 @@
+# AmzSpApi::CatalogItemsApiModel::Dimension
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**unit** | **String** | Measurement unit of the dimension value. | [optional] 
+**value** | [**BigDecimal**](BigDecimal.md) | Numeric dimension value. | [optional] 
+

data/lib/catalog-items-api-model/docs/Dimensions.md

@@ -0,0 +1,10 @@
+# AmzSpApi::CatalogItemsApiModel::Dimensions
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**height** | [**Dimension**](Dimension.md) |  | [optional] 
+**length** | [**Dimension**](Dimension.md) |  | [optional] 
+**weight** | [**Dimension**](Dimension.md) |  | [optional] 
+**width** | [**Dimension**](Dimension.md) |  | [optional] 
+

data/lib/catalog-items-api-model/docs/Error.md

@@ -4,6 +4,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **code** | **String** | An error code that identifies the type of error that occurred. | 
-**message** | **String** | A message that describes the error condition in a human-readable form. | 
-**details** | **String** | Additional information that can help the caller understand or fix the issue. | [optional] 
+**message** | **String** | A message that describes the error condition. | 
+**details** | **String** | Additional details that can help the caller understand or fix the issue. | [optional] 
 

data/lib/catalog-items-api-model/docs/ErrorList.md

@@ -3,4 +3,5 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**errors** | [**Array<Error>**](Error.md) |  |