Module: Peddler::Types::CatalogItems20201201

Defined in:

lib/peddler/types/catalog_items_2020_12_01/item.rb,
lib/peddler/types/catalog_items_2020_12_01/error.rb,
lib/peddler/types/catalog_items_2020_12_01/error_list.rb,
lib/peddler/types/catalog_items_2020_12_01/item_image.rb,
lib/peddler/types/catalog_items_2020_12_01/pagination.rb,
lib/peddler/types/catalog_items_2020_12_01/refinements.rb,
lib/peddler/types/catalog_items_2020_12_01/item_attributes.rb,
lib/peddler/types/catalog_items_2020_12_01/item_identifier.rb,
lib/peddler/types/catalog_items_2020_12_01/item_sales_rank.rb,
lib/peddler/types/catalog_items_2020_12_01/brand_refinement.rb,
lib/peddler/types/catalog_items_2020_12_01/item_search_results.rb,
lib/peddler/types/catalog_items_2020_12_01/classification_refinement.rb,
lib/peddler/types/catalog_items_2020_12_01/item_images_by_marketplace.rb,
lib/peddler/types/catalog_items_2020_12_01/item_summary_by_marketplace.rb,
lib/peddler/types/catalog_items_2020_12_01/item_variations_by_marketplace.rb,
lib/peddler/types/catalog_items_2020_12_01/item_identifiers_by_marketplace.rb,
lib/peddler/types/catalog_items_2020_12_01/item_sales_ranks_by_marketplace.rb,
lib/peddler/types/catalog_items_2020_12_01/item_product_type_by_marketplace.rb,
lib/peddler/types/catalog_items_2020_12_01/item_vendor_details_by_marketplace.rb

Constant Summary

Item =

An item in the Amazon catalog.

Structure.new do
  # @return [String]
  attribute(:asin, String)

  # @return [ItemAttributes]
  attribute(:attributes, ItemAttributes)

  # @return [Array<ItemIdentifiersByMarketplace>]
  attribute(:identifiers, [ItemIdentifiersByMarketplace])

  # @return [Array<ItemImagesByMarketplace>]
  attribute(:images, [ItemImagesByMarketplace])

  # @return [Array<ItemProductTypeByMarketplace>]
  attribute(:product_types, [ItemProductTypeByMarketplace], from: "productTypes")

  # @return [Array<ItemSalesRanksByMarketplace>]
  attribute(:sales_ranks, [ItemSalesRanksByMarketplace], from: "salesRanks")

  # @return [Array<ItemSummaryByMarketplace>]
  attribute(:summaries, [ItemSummaryByMarketplace])

  # @return [Array<ItemVariationsByMarketplace>]
  attribute(:variations, [ItemVariationsByMarketplace])

  # @return [Array<ItemVendorDetailsByMarketplace>]
  attribute(:vendor_details, [ItemVendorDetailsByMarketplace], from: "vendorDetails")
end

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.
  attribute(:message, String)

  # @return [String] Additional details that can help the caller understand or fix the issue.
  attribute(:details, String)
end

ErrorList =

A list of error responses returned when a request is unsuccessful.

Structure.new do
  # @return [Array<Error>]
  attribute(:errors, [Error])
end

ItemImage =

Image for an item in the Amazon catalog.

Structure.new do
  # @return [String] Variant of the image, such as MAIN or PT01.
  attribute(:variant, String)

  # @return [String] Link, or URL, for the image.
  attribute(:link, String)

  # @return [Integer] Height of the image in pixels.
  attribute(:height, Integer)

  # @return [Integer] Width of the image in pixels.
  attribute(:width, Integer)
end

Pagination =

When a request produces a response that exceeds the pageSize, pagination occurs. This means the response is divided into individual pages. To retrieve the next page or the previous page, you must pass the nextToken value or the previousToken value as the pageToken parameter in the next request. When you receive the last page, there will be no nextToken key in the pagination object.

Structure.new do
  # @return [String] A token that can be used to fetch the next page.
  attribute(:next_token, String, from: "nextToken")

  # @return [String] A token that can be used to fetch the previous page.
  attribute(:previous_token, String, from: "previousToken")
end

Refinements =

Search refinements.

Structure.new do
  # @return [Array<BrandRefinement>] Brand search refinements.
  attribute(:brands, [BrandRefinement])

  # @return [Array<ClassificationRefinement>] Classification search refinements.
  attribute(:classifications, [ClassificationRefinement])
end

ItemAttributes =

A JSON object that contains structured item attribute data keyed by attribute name. Catalog item attributes are available only to brand owners and conform to the related product type definitions available in the Selling Partner API for Product Type Definitions.

Structure.new do
end

ItemIdentifier =

Identifier associated with the item in the Amazon catalog, such as a UPC or EAN identifier.

Structure.new do
  # @return [String] Type of identifier, such as UPC, EAN, or ISBN.
  attribute(:identifier_type, String, from: "identifierType")

  # @return [String] Identifier.
  attribute(:identifier, String)
end

ItemSalesRank =

Sales rank of an Amazon catalog item.

Structure.new do
  # @return [String] Title, or name, of the sales rank.
  attribute(:title, String)

  # @return [String] Corresponding Amazon retail website link, or URL, for the sales rank.
  attribute(:link, String)

  # @return [Integer] Sales rank value.
  attribute(:rank, Integer)
end

BrandRefinement =

Description of a brand that can be used to get more fine-grained search results.

Structure.new do
  # @return [Integer] The estimated number of results that would still be returned if refinement key applied.
  attribute(:number_of_results, Integer, from: "numberOfResults")

  # @return [String] Brand name. For display and can be used as a search refinement.
  attribute(:brand_name, String, from: "brandName")
end

ItemSearchResults =

Items in the Amazon catalog and search related metadata.

Structure.new do
  # @return [Integer] The estimated total number of products matched by the search query (only results up to the
  # page count limit will be returned per request regardless of the number found).
  #
  # Note: The maximum number of items (ASINs) that can be returned and paged through is 1000.
  attribute(:number_of_results, Integer, from: "numberOfResults")

  # @return [Pagination] If available, the nextToken and/or previousToken values required to return paginated
  # results.
  attribute(:pagination, Pagination)

  # @return [Refinements]
  attribute(:refinements, Refinements)

  # @return [Array<Item>] A list of items from the Amazon catalog.
  attribute(:items, [Item])
end

ClassificationRefinement =

Description of a classification that can be used to get more fine-grained search results.

Structure.new do
  # @return [Integer] The estimated number of results that would still be returned if refinement key applied.
  attribute(:number_of_results, Integer, from: "numberOfResults")

  # @return [String] Display name for the classification.
  attribute(:display_name, String, from: "displayName")

  # @return [String] Identifier for the classification that can be used for search refinement purposes.
  attribute(:classification_id, String, from: "classificationId")
end

ItemImagesByMarketplace =

Images for an item in the Amazon catalog for the indicated Amazon marketplace.

Structure.new do
  # @return [String] Amazon marketplace identifier.
  attribute(:marketplace_id, String, from: "marketplaceId")

  # @return [Array<ItemImage>] Images for an item in the Amazon catalog for the indicated Amazon marketplace.
  attribute(:images, [ItemImage])
end

ItemSummaryByMarketplace =

Summary details of an Amazon catalog item for the indicated Amazon marketplace.

Structure.new do
  # @return [String] Amazon marketplace identifier.
  attribute(:marketplace_id, String, from: "marketplaceId")

  # @return [String] Name of the brand associated with an Amazon catalog item.
  attribute(:brand_name, String, from: "brandName")

  # @return [String] Identifier of the browse node associated with an Amazon catalog item.
  attribute(:browse_node, String, from: "browseNode")

  # @return [String] Name of the color associated with an Amazon catalog item.
  attribute(:color_name, String, from: "colorName")

  # @return [String] Name, or title, associated with an Amazon catalog item.
  attribute(:item_name, String, from: "itemName")

  # @return [String] Name of the manufacturer associated with an Amazon catalog item.
  attribute(:manufacturer, String)

  # @return [String] Model number associated with an Amazon catalog item.
  attribute(:model_number, String, from: "modelNumber")

  # @return [String] Name of the size associated with an Amazon catalog item.
  attribute(:size_name, String, from: "sizeName")

  # @return [String] Name of the style associated with an Amazon catalog item.
  attribute(:style_name, String, from: "styleName")
end

ItemVariationsByMarketplace =

Variation details for the Amazon catalog item for the indicated Amazon marketplace.

Structure.new do
  # @return [String] Amazon marketplace identifier.
  attribute(:marketplace_id, String, from: "marketplaceId")

  # @return [Array<String>] Identifiers (ASINs) of the related items.
  attribute(:asins, [String])

  # @return [String] Type of variation relationship of the Amazon catalog item in the request to the related
  # item(s): "PARENT" or "CHILD".
  attribute(:variation_type, String, from: "variationType")
end

ItemIdentifiersByMarketplace =

Identifiers associated with the item in the Amazon catalog for the indicated Amazon marketplace.

Structure.new do
  # @return [String] Amazon marketplace identifier.
  attribute(:marketplace_id, String, from: "marketplaceId")

  # @return [Array<ItemIdentifier>] Identifiers associated with the item in the Amazon catalog for the indicated
  # Amazon marketplace.
  attribute(:identifiers, [ItemIdentifier])
end

ItemSalesRanksByMarketplace =

Sales ranks of an Amazon catalog item for the indicated Amazon marketplace.

Structure.new do
  # @return [String] Amazon marketplace identifier.
  attribute(:marketplace_id, String, from: "marketplaceId")

  # @return [Array<ItemSalesRank>] Sales ranks of an Amazon catalog item for an Amazon marketplace.
  attribute(:ranks, [ItemSalesRank])
end

ItemProductTypeByMarketplace =

Product type associated with the Amazon catalog item for the indicated Amazon marketplace.

Structure.new do
  # @return [String] Amazon marketplace identifier.
  attribute(:marketplace_id, String, from: "marketplaceId")

  # @return [String] Name of the product type associated with the Amazon catalog item.
  attribute(:product_type, String, from: "productType")
end

ItemVendorDetailsByMarketplace =

Vendor details associated with an Amazon catalog item for the indicated Amazon marketplace.

Structure.new do
  # @return [String] Amazon marketplace identifier.
  attribute(:marketplace_id, String, from: "marketplaceId")

  # @return [String] Brand code associated with an Amazon catalog item.
  attribute(:brand_code, String, from: "brandCode")

  # @return [String] Product category associated with an Amazon catalog item.
  attribute(:category_code, String, from: "categoryCode")

  # @return [String] Manufacturer code associated with an Amazon catalog item.
  attribute(:manufacturer_code, String, from: "manufacturerCode")

  # @return [String] Parent vendor code of the manufacturer code.
  attribute(:manufacturer_code_parent, String, from: "manufacturerCodeParent")

  # @return [String] Product group associated with an Amazon catalog item.
  attribute(:product_group, String, from: "productGroup")

  # @return [String] Replenishment category associated with an Amazon catalog item.
  attribute(:replenishment_category, String, from: "replenishmentCategory")

  # @return [String] Product subcategory associated with an Amazon catalog item.
  attribute(:subcategory_code, String, from: "subcategoryCode")
end