Class: Peddler::API::CatalogItemsV0

Inherits:
Peddler::API show all
Defined in:
lib/peddler/api/catalog_items_v0.rb

Overview

Selling Partner API for Catalog Items

The Selling Partner API for Catalog Items helps you programmatically retrieve item details for items in the catalog.

Instance Attribute Summary

Attributes inherited from Peddler::API

#access_token, #endpoint

Instance Method Summary collapse

Methods inherited from Peddler::API

#cannot_sandbox!, #endpoint_uri, #http, #initialize, #meter, #must_sandbox!, #retriable, #sandbox, #sandbox?, #use, #via

Constructor Details

This class inherits a constructor from Peddler::API

Instance Method Details

#get_catalog_item(marketplace_id, asin, rate_limit: nil) ⇒ Hash

Note:

This operation can make a static sandbox call.

Effective September 30, 2022, the getCatalogItem operation will no longer be available in the Selling Partner API for Catalog Items v0. This operation is available in the latest version of the href="https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-reference">https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-reference Selling Partner API for Catalog Items v2022-04-01. Integrations that rely on this operation should migrate to the latest version to avoid service disruption. Note: The listCatalogCategories operation is not being deprecated and you can continue to make calls to it.

Parameters:

  • marketplace_id (String) —

    A marketplace identifier. Specifies the marketplace for the item.

  • asin (String) —

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

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

    Requests per second

Returns:

  • (Hash) —

    The API response



74
75
76
77
78
79
80
81
 
# File 'lib/peddler/api/catalog_items_v0.rb', line 74

def get_catalog_item(marketplace_id, asin, rate_limit: nil)
  path = "/catalog/v0/items/#{asin}"
  params = {
    "MarketplaceId" => marketplace_id,
  }.compact

  get(path, params:)
end

#list_catalog_categories(marketplace_id, asin: nil, seller_sku: nil, rate_limit: 1.0) ⇒ Hash

Note:

This operation can make a static sandbox call.

Returns the parent categories to which an item belongs, based on the specified ASIN or SellerSKU.

Parameters:

  • marketplace_id (String) —

    A marketplace identifier. Specifies the marketplace for the item.

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

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

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

    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.

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

    Requests per second

Returns:

  • (Hash) —

    The API response



92
93
94
95
96
97
98
99
100
101
 
# File 'lib/peddler/api/catalog_items_v0.rb', line 92

def list_catalog_categories(marketplace_id, asin: nil, seller_sku: nil, rate_limit: 1.0)
  path = "/catalog/v0/categories"
  params = {
    "MarketplaceId" => marketplace_id,
    "ASIN" => asin,
    "SellerSKU" => seller_sku,
  }.compact

  meter(rate_limit).get(path, params:)
end

#list_catalog_items(marketplace_id, query: nil, query_context_id: nil, seller_sku: nil, upc: nil, ean: nil, isbn: nil, jan: nil, rate_limit: nil) ⇒ Hash

Note:

This operation can make a static sandbox call.

Effective September 30, 2022, the listCatalogItems operation will no longer be available in the Selling Partner API for Catalog Items v0. As an alternative, searchCatalogItems is available in the latest version of the href="https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-reference">https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-reference Selling Partner API for Catalog Items v2022-04-01. Integrations that rely on the listCatalogItems operation should migrate to the searchCatalogItemsoperation to avoid service disruption. Note: The listCatalogCategories operation is not being deprecated and you can continue to make calls to it.

Parameters:

  • marketplace_id (String) —

    A marketplace identifier. Specifies the marketplace for which items are returned.

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

    Keyword(s) to use to search for items in the catalog. Example: 'harry potter books'.

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

    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 (String) (defaults to: nil) —

    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 (String) (defaults to: nil) —

    A 12-digit bar code used for retail packaging.

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

    A European article number that uniquely identifies the catalog item, manufacturer, and its attributes.

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

    The unique commercial book identifier used to identify books internationally.

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

    A Japanese article number that uniquely identifies the product, manufacturer, and its attributes.

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

    Requests per second

Returns:

  • (Hash) —

    The API response



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/peddler/api/catalog_items_v0.rb', line 45

def list_catalog_items(marketplace_id, query: nil, query_context_id: nil, seller_sku: nil, upc: nil, ean: nil,
  isbn: nil, jan: nil, rate_limit: nil)
  path = "/catalog/v0/items"
  params = {
    "MarketplaceId" => marketplace_id,
    "Query" => query,
    "QueryContextId" => query_context_id,
    "SellerSKU" => seller_sku,
    "UPC" => upc,
    "EAN" => ean,
    "ISBN" => isbn,
    "JAN" => jan,
  }.compact

  get(path, params:)
end