Class: Peddler::APIs::CatalogItems20201201

Inherits:
Peddler::API show all
Defined in:
lib/peddler/apis/catalog_items_2020_12_01.rb,
lib/peddler/apis/catalog_items_2020_12_01/item.rb,
lib/peddler/apis/catalog_items_2020_12_01/error.rb,
lib/peddler/apis/catalog_items_2020_12_01/error_list.rb,
lib/peddler/apis/catalog_items_2020_12_01/item_image.rb,
lib/peddler/apis/catalog_items_2020_12_01/pagination.rb,
lib/peddler/apis/catalog_items_2020_12_01/item_images.rb,
lib/peddler/apis/catalog_items_2020_12_01/refinements.rb,
lib/peddler/apis/catalog_items_2020_12_01/item_summaries.rb,
lib/peddler/apis/catalog_items_2020_12_01/item_identifier.rb,
lib/peddler/apis/catalog_items_2020_12_01/item_sales_rank.rb,
lib/peddler/apis/catalog_items_2020_12_01/item_variations.rb,
lib/peddler/apis/catalog_items_2020_12_01/brand_refinement.rb,
lib/peddler/apis/catalog_items_2020_12_01/item_identifiers.rb,
lib/peddler/apis/catalog_items_2020_12_01/item_sales_ranks.rb,
lib/peddler/apis/catalog_items_2020_12_01/item_product_types.rb,
lib/peddler/apis/catalog_items_2020_12_01/item_search_results.rb,
lib/peddler/apis/catalog_items_2020_12_01/item_vendor_details.rb,
lib/peddler/apis/catalog_items_2020_12_01/classification_refinement.rb,
lib/peddler/apis/catalog_items_2020_12_01/item_images_by_marketplace.rb,
lib/peddler/apis/catalog_items_2020_12_01/item_summary_by_marketplace.rb,
lib/peddler/apis/catalog_items_2020_12_01/item_variations_by_marketplace.rb,
lib/peddler/apis/catalog_items_2020_12_01/item_identifiers_by_marketplace.rb,
lib/peddler/apis/catalog_items_2020_12_01/item_sales_ranks_by_marketplace.rb,
lib/peddler/apis/catalog_items_2020_12_01/item_product_type_by_marketplace.rb,
lib/peddler/apis/catalog_items_2020_12_01/item_vendor_details_by_marketplace.rb,
sig/peddler/apis/catalog_items_2020_12_01.rbs

Overview

Selling Partner API for Catalog Items

The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog.

For more information, see the href="https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2020-12-01-use-case-guide">https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2020-12-01-use-case-guide Catalog Items API Use Case Guide.

See Also:

Defined Under Namespace

Classes: BrandRefinement, ClassificationRefinement, Error, ErrorList, Item, ItemIdentifier, ItemIdentifiers, ItemIdentifiersByMarketplace, ItemImage, ItemImages, ItemImagesByMarketplace, ItemProductTypeByMarketplace, ItemProductTypes, ItemSalesRank, ItemSalesRanks, ItemSalesRanksByMarketplace, ItemSearchResults, ItemSummaries, ItemSummaryByMarketplace, ItemVariations, ItemVariationsByMarketplace, ItemVendorDetails, ItemVendorDetailsByMarketplace, Pagination, Refinements

Instance Attribute Summary

Attributes inherited from Peddler::API

#access_token, #endpoint, #retries

Instance Method Summary collapse

Methods inherited from Peddler::API

#cannot_sandbox!, #delete, #endpoint_uri, #get, #http, #initialize, #must_sandbox!, #patch, #percent_encode, #post, #put, #request, #sandbox, #sandbox?, #stringify_array, #timestamp, #user_agent

Constructor Details

This class inherits a constructor from Peddler::API

Instance Method Details

#get_catalog_item(asin, marketplace_ids, included_data: ["summaries"], locale: nil, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Retrieves details for an item in the Amazon catalog.

Parameters:

  • asin (String) —

    The Amazon Standard Identification Number (ASIN) of the item.

  • marketplace_ids (Array<String>) —

    A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces.

  • included_data (Array<String>) (defaults to: ["summaries"]) —

    A comma-delimited list of data sets to include in the response. Default: summaries.

  • locale (String) (defaults to: nil) —

    Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

  • (String)
  • (Array[String])
  • included_data: (Array[String], nil) (defaults to: ["summaries"])
  • locale: (String, nil) (defaults to: nil)
  • rate_limit: (Float) (defaults to: 2.0)

Returns:



67
68
69
70
71
72
73
74
75
76
 
# File 'lib/peddler/apis/catalog_items_2020_12_01.rb', line 67

def get_catalog_item(asin, marketplace_ids, included_data: ["summaries"], locale: nil, rate_limit: 2.0)
  path = "/catalog/2020-12-01/items/#{percent_encode(asin)}"
  params = {
    "marketplaceIds" => stringify_array(marketplace_ids),
    "includedData" => stringify_array(included_data),
    "locale" => locale,
  }.compact
  parser = -> { Item }
  get(path, params:, rate_limit:, parser:)
end

#search_catalog_items(keywords, marketplace_ids, included_data: ["summaries"], brand_names: nil, classification_ids: nil, page_size: 10, page_token: nil, keywords_locale: nil, locale: nil, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Search for and return a list of Amazon catalog items and associated information.

Parameters:

  • keywords (Array<String>) —

    A comma-delimited list of words or item identifiers to search the Amazon catalog for.

  • marketplace_ids (Array<String>) —

    A comma-delimited list of Amazon marketplace identifiers for the request.

  • included_data (Array<String>) (defaults to: ["summaries"]) —

    A comma-delimited list of data sets to include in the response. Default: summaries.

  • brand_names (Array<String>) (defaults to: nil) —

    A comma-delimited list of brand names to limit the search to.

  • classification_ids (Array<String>) (defaults to: nil) —

    A comma-delimited list of classification identifiers to limit the search to.

  • page_size (Integer) (defaults to: 10) —

    Number of results to be returned per page.

  • page_token (String) (defaults to: nil) —

    A token to fetch a certain page when there are multiple pages worth of results.

  • keywords_locale (String) (defaults to: nil) —

    The language the keywords are provided in. Defaults to the primary locale of the marketplace.

  • locale (String) (defaults to: nil) —

    Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.

  • rate_limit (Float) (defaults to: 2.0) —

    Requests per second

  • (Array[String])
  • (Array[String])
  • included_data: (Array[String], nil) (defaults to: ["summaries"])
  • brand_names: (Array[String], nil) (defaults to: nil)
  • classification_ids: (Array[String], nil) (defaults to: nil)
  • page_size: (Integer, nil) (defaults to: 10)
  • page_token: (String, nil) (defaults to: nil)
  • keywords_locale: (String, nil) (defaults to: nil)
  • locale: (String, nil) (defaults to: nil)
  • rate_limit: (Float) (defaults to: 2.0)

Returns:



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/peddler/apis/catalog_items_2020_12_01.rb', line 37

def search_catalog_items(keywords, marketplace_ids, included_data: ["summaries"], brand_names: nil,
  classification_ids: nil, page_size: 10, page_token: nil, keywords_locale: nil, locale: nil, rate_limit: 2.0)
  path = "/catalog/2020-12-01/items"
  params = {
    "keywords" => stringify_array(keywords),
    "marketplaceIds" => stringify_array(marketplace_ids),
    "includedData" => stringify_array(included_data),
    "brandNames" => stringify_array(brand_names),
    "classificationIds" => stringify_array(classification_ids),
    "pageSize" => page_size,
    "pageToken" => page_token,
    "keywordsLocale" => keywords_locale,
    "locale" => locale,
  }.compact
  parser = -> { ItemSearchResults }
  get(path, params:, rate_limit:, parser:)
end