Class: Peddler::APIs::CatalogItemsV0

Inherits:
Peddler::API show all
Defined in:
lib/peddler/apis/catalog_items_v0.rb,
lib/peddler/apis/catalog_items_v0/error.rb,
lib/peddler/apis/catalog_items_v0/categories.rb,
lib/peddler/apis/catalog_items_v0/error_list.rb,
lib/peddler/apis/catalog_items_v0/list_of_categories.rb,
lib/peddler/apis/catalog_items_v0/list_catalog_categories_response.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.

See Also:

Defined Under Namespace

Classes: ErrorList, ListOfCategories

Constant Summary collapse

Error =

Error response returned when the request is unsuccessful.

Structure.new do
  # @return [String] An error code that identifies the type of error that occurred.
  attribute(:code, String)

  # @return [String] A message that describes the error condition in a human-readable form.
  attribute(:message, String)

  # @return [String] Additional information that can help the caller understand or fix the issue.
  attribute?(:details, String)
end
Categories = 
Structure.new do
  # @return [String] The identifier for the product category (or browse node).
  attribute?(:product_category_id, String, from: "ProductCategoryId")

  # @return [String] The name of the product category (or browse node).
  attribute?(:product_category_name, String, from: "ProductCategoryName")

  # @return [Hash] The parent product category.
  attribute?(:parent, Hash)
end
ListCatalogCategoriesResponse = 
Structure.new do
  # @return [Array<Error>] One or more unexpected errors occurred during the listCatalogCategories operation.
  attribute?(:errors, [Error])

  # @return [Array<Categories>] The payload for the listCatalogCategories operation.
  attribute?(:payload, [Categories])
end

Instance Attribute Summary

Attributes inherited from Peddler::API

#access_token, #endpoint, #retries

Instance Method Summary collapse

Methods inherited from Peddler::API

#endpoint_uri, #http, #initialize, #meter, #retriable, #sandbox, #sandbox?, #use, #via

Constructor Details

This class inherits a constructor from Peddler::API

Instance Method Details

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

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.

seller's SellerId, which is included with every operation that you submit.

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

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

    Requests per second

Returns:



23
24
25
26
27
28
29
30
31
32
 
# File 'lib/peddler/apis/catalog_items_v0.rb', line 23

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
  parser = -> { ListCatalogCategoriesResponse }
  meter(rate_limit).get(path, params:, parser:)
end