Module: Peddler::Types::CatalogItems20220401

Defined in:: lib/peddler/types/catalog_items_2022_04_01/item.rb,
lib/peddler/types/catalog_items_2022_04_01/error.rb,
lib/peddler/types/catalog_items_2022_04_01/dimension.rb,
lib/peddler/types/catalog_items_2022_04_01/dimensions.rb,
lib/peddler/types/catalog_items_2022_04_01/error_list.rb,
lib/peddler/types/catalog_items_2022_04_01/item_image.rb,
lib/peddler/types/catalog_items_2022_04_01/pagination.rb,
lib/peddler/types/catalog_items_2022_04_01/item_images.rb,
lib/peddler/types/catalog_items_2022_04_01/refinements.rb,
lib/peddler/types/catalog_items_2022_04_01/item_summaries.rb,
lib/peddler/types/catalog_items_2022_04_01/item_dimensions.rb,
lib/peddler/types/catalog_items_2022_04_01/item_identifier.rb,
lib/peddler/types/catalog_items_2022_04_01/brand_refinement.rb,
lib/peddler/types/catalog_items_2022_04_01/item_contributor.rb,
lib/peddler/types/catalog_items_2022_04_01/item_identifiers.rb,
lib/peddler/types/catalog_items_2022_04_01/item_sales_ranks.rb,
lib/peddler/types/catalog_items_2022_04_01/item_relationship.rb,
lib/peddler/types/catalog_items_2022_04_01/item_product_types.rb,
lib/peddler/types/catalog_items_2022_04_01/item_relationships.rb,
lib/peddler/types/catalog_items_2022_04_01/item_search_results.rb,
lib/peddler/types/catalog_items_2022_04_01/item_vendor_details.rb,
lib/peddler/types/catalog_items_2022_04_01/item_variation_theme.rb,
lib/peddler/types/catalog_items_2022_04_01/item_contributor_role.rb,
lib/peddler/types/catalog_items_2022_04_01/classification_refinement.rb,
lib/peddler/types/catalog_items_2022_04_01/item_browse_classification.rb,
lib/peddler/types/catalog_items_2022_04_01/item_images_by_marketplace.rb,
lib/peddler/types/catalog_items_2022_04_01/item_browse_classifications.rb,
lib/peddler/types/catalog_items_2022_04_01/item_summary_by_marketplace.rb,
lib/peddler/types/catalog_items_2022_04_01/item_vendor_details_category.rb,
lib/peddler/types/catalog_items_2022_04_01/item_display_group_sales_rank.rb,
lib/peddler/types/catalog_items_2022_04_01/item_classification_sales_rank.rb,
lib/peddler/types/catalog_items_2022_04_01/item_dimensions_by_marketplace.rb,
lib/peddler/types/catalog_items_2022_04_01/item_identifiers_by_marketplace.rb,
lib/peddler/types/catalog_items_2022_04_01/item_sales_ranks_by_marketplace.rb,
lib/peddler/types/catalog_items_2022_04_01/item_product_type_by_marketplace.rb,
lib/peddler/types/catalog_items_2022_04_01/item_relationships_by_marketplace.rb,
lib/peddler/types/catalog_items_2022_04_01/item_vendor_details_by_marketplace.rb,
lib/peddler/types/catalog_items_2022_04_01/item_browse_classifications_by_marketplace.rb

Defined Under Namespace

Classes: ItemBrowseClassifications, ItemDimensions, ItemIdentifiers, ItemImages, ItemProductTypes, ItemRelationships, ItemSalesRanks, ItemSummaries, ItemVendorDetails

Constant Summary collapse

Item = An item in the Amazon catalog.

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

  # @return [Hash]
  attribute?(:attributes, Hash)

  # @return [Array<ItemBrowseClassificationsByMarketplace>]
  attribute?(:classifications, [ItemBrowseClassificationsByMarketplace])

  # @return [Array<ItemDimensionsByMarketplace>]
  attribute?(:dimensions, [ItemDimensionsByMarketplace])

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

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

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

  # @return [Array<ItemRelationshipsByMarketplace>]
  attribute?(:relationships, [ItemRelationshipsByMarketplace])

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

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

  # @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

Dimension = The value of an individual dimension for an Amazon catalog item or item package.

Structure.new do
  # @return [String] Unit of measurement for the dimension value.
  attribute?(:unit, String)

  # @return [Float] Numeric value of the dimension.
  attribute?(:value, Float)
end

Dimensions = Dimensions of an Amazon catalog item or item in its packaging.

Structure.new do
  # @return [Dimension] Height of an item or item package.
  attribute?(:height, Dimension)

  # @return [Dimension] Length of an item or item package.
  attribute?(:length, Dimension)

  # @return [Dimension] Weight of an item or item package.
  attribute?(:weight, Dimension)

  # @return [Dimension] Width of an item or item package.
  attribute?(:width, Dimension)
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 [Integer] Height of the image in pixels.
  attribute(:height, Integer)

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

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

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

Pagination = Pagination occurs when a request produces a response that exceeds the ‘pageSize`. This means that the response is divided into individual pages. To retrieve the next page or the previous page of results, you must pass the `nextToken` value or the `previousToken` value as the `pageToken` parameter in the next request. There is no `nextToken` in the pagination object on the last page.

Structure.new do
  # @return [String] A token that you can use to retrieve the next page.
  attribute?(:next_token, String, from: "nextToken")

  # @return [String] A token that you can use to retrieve the previous page.
  attribute?(:previous_token, String, from: "previousToken")
end

Refinements = Optional fields that you can use to refine your search results.

Structure.new do
  # @return [Array<BrandRefinement>] A list of brands you can use to refine your search.
  attribute(:brands, [BrandRefinement])

  # @return [Array<ClassificationRefinement>] A list of classifications you can use to refine your search.
  attribute(:classifications, [ClassificationRefinement])
end

ItemIdentifier = The identifier that is associated with the item in the Amazon catalog, such as a UPC or EAN identifier.

Structure.new do
  # @return [String] Identifier of the item.
  attribute(:identifier, String)

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

BrandRefinement = A brand that you can use to refine your search.

Structure.new do
  # @return [String] The brand name that you can use to refine your search.
  attribute(:brand_name, String, from: "brandName")

  # @return [Integer] The estimated number of results that would be returned if you refine your search by the
  # specified `brandName`.
  attribute(:number_of_results, Integer, from: "numberOfResults")
end

ItemContributor = Individual contributor to the creation of an item, such as an author or actor.

Structure.new do
  # @return [ItemContributorRole]
  attribute(:role, ItemContributorRole)

  # @return [String] Name of the contributor, such as `Jane Austen`.
  attribute(:value, String)
end

ItemRelationship = Relationship details for an Amazon catalog item.

Structure.new do
  # @return [String] Type of relationship.
  attribute(:type, String)

  # @return [Array<String>] ASINs of the related items that are children of this item.
  attribute?(:child_asins, [String], from: "childAsins")

  # @return [Array<String>] ASINs of the related items that are parents of this item.
  attribute?(:parent_asins, [String], from: "parentAsins")

  # @return [ItemVariationTheme] For `VARIATION` relationships, the variation theme indicates the combination of
  # Amazon catalog item attributes that define the variation family.
  attribute?(:variation_theme, ItemVariationTheme, from: "variationTheme")
end

ItemSearchResults = Items in the Amazon catalog and search-related metadata.

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

  # @return [Integer] For searches that are based on `identifiers`, `numberOfResults` is the total number of
  # Amazon catalog items found. For searches that are based on `keywords`, `numberOfResults` is the estimated
  # total number of Amazon catalog items that are matched by the search query. Only results up to the page count
  # limit are returned per request regardless of the number found.
  #
  # **Note:** The maximum number of items (ASINs) that can be returned and paged through is 1,000.
  attribute(:number_of_results, Integer, from: "numberOfResults")

  # @return [Pagination] The `nextToken` and `previousToken` values that are required to retrieve paginated
  # results.
  attribute(:pagination, Pagination)

  # @return [Refinements] Search refinements for searches that are based on `keywords`.
  attribute(:refinements, Refinements)
end

ItemVariationTheme = The variation theme is a list of Amazon catalog item attributes that define the variation family.

Structure.new do
  # @return [Array<String>] Names of the Amazon catalog item attributes that are associated with the variation
  # theme.
  attribute?(:attributes, [String])

  # @return [String] Variation theme that indicates the combination of Amazon catalog item attributes that define
  # the variation family.
  attribute?(:theme, String)
end

ItemContributorRole = Role of an individual contributor in the creation of an item, such as author or actor.

Structure.new do
  # @return [String] Role value for the Amazon catalog item, such as `author` or `actor`.
  attribute(:value, String)

  # @return [String] Display name of the role in the requested locale, such as `Author` or `Actor`.
  attribute?(:display_name, String, from: "displayName")
end

ClassificationRefinement = A classification that you can use to refine your search.

Structure.new do
  # @return [String] The identifier of the classification that you can use to refine your search.
  attribute(:classification_id, String, from: "classificationId")

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

  # @return [Integer] The estimated number of results that would be returned if you refine your search by the
  # specified `classificationId`.
  attribute(:number_of_results, Integer, from: "numberOfResults")
end

ItemBrowseClassification = Classification (browse node) for an Amazon catalog item.

Structure.new do
  # @return [String] Identifier of the classification.
  attribute(:classification_id, String, from: "classificationId")

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

  # @return [:self] Parent classification of the current classification.
  attribute?(:parent, :self)
end

ItemImagesByMarketplace = Images for an item in the Amazon catalog, grouped by ‘marketplaceId`.

Structure.new do
  # @return [Array<ItemImage>] Images for an item in the Amazon catalog, grouped by `marketplaceId`.
  attribute(:images, [ItemImage])

  # @return [String] Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace
  # IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
  attribute(:marketplace_id, String, from: "marketplaceId")
end

ItemSummaryByMarketplace = Information about an Amazon catalog item for the indicated ‘marketplaceId`.

Structure.new do
  # @return [String] Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace
  # IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
  attribute(:marketplace_id, String, from: "marketplaceId")

  # @return [:boolean] When `true`, the Amazon catalog item is intended for an adult audience or is sexual in
  # nature.
  attribute?(:adult_product, :boolean, from: "adultProduct")

  # @return [:boolean] When `true`, the Amazon catalog item is autographed.
  attribute?(:autographed, :boolean)

  # @return [String] Name of the brand that is associated with the Amazon catalog item.
  attribute?(:brand, String)

  # @return [ItemBrowseClassification] Classification (browse node) that is associated with the Amazon catalog
  # item.
  attribute?(:browse_classification, ItemBrowseClassification, from: "browseClassification")

  # @return [String] The color that is associated with the Amazon catalog item.
  attribute?(:color, String)

  # @return [Array<ItemContributor>] Individual contributors to the creation of the item, such as the authors or
  # actors.
  attribute?(:contributors, [ItemContributor])

  # @return [String] Classification type that is associated with the Amazon catalog item.
  attribute?(:item_classification, String, from: "itemClassification")

  # @return [String] The name that is associated with the Amazon catalog item.
  attribute?(:item_name, String, from: "itemName")

  # @return [String] The name of the manufacturer that is associated with the Amazon catalog item.
  attribute?(:manufacturer, String)

  # @return [:boolean] When true, the item is classified as memorabilia.
  attribute?(:memorabilia, :boolean)

  # @return [String] The model number that is associated with the Amazon catalog item.
  attribute?(:model_number, String, from: "modelNumber")

  # @return [Integer] The quantity of the Amazon catalog item within one package.
  attribute?(:package_quantity, Integer, from: "packageQuantity")

  # @return [String] The part number that is associated with the Amazon catalog item.
  attribute?(:part_number, String, from: "partNumber")

  # @return [String] The earliest date on which the Amazon catalog item can be shipped to customers.
  attribute?(:release_date, String, from: "releaseDate")

  # @return [String] The name of the size of the Amazon catalog item.
  attribute?(:size, String)

  # @return [String] The name of the style that is associated with the Amazon catalog item.
  attribute?(:style, String)

  # @return [:boolean] When true, the Amazon catalog item is eligible for trade-in.
  attribute?(:trade_in_eligible, :boolean, from: "tradeInEligible")

  # @return [String] The identifier of the website display group that is associated with the Amazon catalog item.
  attribute?(:website_display_group, String, from: "websiteDisplayGroup")

  # @return [String] The display name of the website display group that is associated with the Amazon catalog
  # item.
  attribute?(:website_display_group_name, String, from: "websiteDisplayGroupName")
end

ItemVendorDetailsCategory = The product category or subcategory that is associated with an Amazon catalog item.

Structure.new do
  # @return [String] The display name of the product category or subcategory.
  attribute?(:display_name, String, from: "displayName")

  # @return [String] The code that identifies the product category or subcategory.
  attribute?(:value, String)
end

ItemDisplayGroupSalesRank = Sales rank of an Amazon catalog item, grouped by website display group.

Structure.new do
  # @return [Integer] Sales rank.
  attribute(:rank, Integer)

  # @return [String] Name of the sales rank.
  attribute(:title, String)

  # @return [String] Name of the website display group that is associated with the sales rank
  attribute(:website_display_group, String, from: "websiteDisplayGroup")

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

ItemClassificationSalesRank = Sales rank of an Amazon catalog item.

Structure.new do
  # @return [String] Identifier of the classification that is associated with the sales rank.
  attribute(:classification_id, String, from: "classificationId")

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

  # @return [String] Name of the sales rank.
  attribute(:title, String)

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

ItemDimensionsByMarketplace = Dimensions that are associated with the item in the Amazon catalog for the indicated ‘marketplaceId`.

Structure.new do
  # @return [String] Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace
  # IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
  attribute(:marketplace_id, String, from: "marketplaceId")

  # @return [Dimensions] Dimensions of an Amazon catalog item.
  attribute?(:item, Dimensions)

  # @return [Dimensions] Dimensions of a package that contains an Amazon catalog item.
  attribute?(:package, Dimensions)
end

ItemIdentifiersByMarketplace = Identifiers that are associated with the item in the Amazon catalog, grouped by ‘marketplaceId`.

Structure.new do
  # @return [Array<ItemIdentifier>] Identifiers associated with the item in the Amazon catalog for the indicated
  # `marketplaceId`.
  attribute(:identifiers, [ItemIdentifier])

  # @return [String] Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace
  # IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).identifier.
  attribute(:marketplace_id, String, from: "marketplaceId")
end

ItemSalesRanksByMarketplace = Sales ranks of an Amazon catalog item, grouped by ‘marketplaceId`.

Structure.new do
  # @return [String] Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace
  # IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
  attribute(:marketplace_id, String, from: "marketplaceId")

  # @return [Array<ItemClassificationSalesRank>] Sales ranks of an Amazon catalog item for a `marketplaceId`,
  # grouped by classification.
  attribute?(:classification_ranks, [ItemClassificationSalesRank], from: "classificationRanks")

  # @return [Array<ItemDisplayGroupSalesRank>] Sales ranks of an Amazon catalog item for a `marketplaceId`,
  # grouped by website display group.
  attribute?(:display_group_ranks, [ItemDisplayGroupSalesRank], from: "displayGroupRanks")
end

ItemProductTypeByMarketplace = Product type that is associated with the Amazon catalog item, grouped by ‘marketplaceId`.

Structure.new do
  # @return [String] Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace
  # IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
  attribute?(:marketplace_id, String, from: "marketplaceId")

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

ItemRelationshipsByMarketplace = Relationship details for the Amazon catalog item for the specified Amazon ‘marketplaceId`.

Structure.new do
  # @return [String] Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace
  # IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
  attribute(:marketplace_id, String, from: "marketplaceId")

  # @return [Array<ItemRelationship>] Relationships for the item.
  attribute(:relationships, [ItemRelationship])
end

ItemVendorDetailsByMarketplace = The vendor details that are associated with an Amazon catalog item for the specified ‘marketplaceId`.

Structure.new do
  # @return [String] Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace
  # IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
  attribute(:marketplace_id, String, from: "marketplaceId")

  # @return [String] The brand code that is associated with an Amazon catalog item.
  attribute?(:brand_code, String, from: "brandCode")

  # @return [String] The manufacturer code that is associated with an Amazon catalog item.
  attribute?(:manufacturer_code, String, from: "manufacturerCode")

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

  # @return [ItemVendorDetailsCategory] The product category that is associated with an Amazon catalog item.
  attribute?(:product_category, ItemVendorDetailsCategory, from: "productCategory")

  # @return [String] The product group that is associated with an Amazon catalog item.
  attribute?(:product_group, String, from: "productGroup")

  # @return [ItemVendorDetailsCategory] The product subcategory that is associated with an Amazon catalog item.
  attribute?(:product_subcategory, ItemVendorDetailsCategory, from: "productSubcategory")

  # @return [String] The replenishment category that is associated with an Amazon catalog item.
  attribute?(:replenishment_category, String, from: "replenishmentCategory")
end

ItemBrowseClassificationsByMarketplace = Classifications (browse nodes) that are associated with the item in the Amazon catalog for the indicated ‘marketplaceId`.

Structure.new do
  # @return [String] Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace
  # IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
  attribute(:marketplace_id, String, from: "marketplaceId")

  # @return [Array<ItemBrowseClassification>] Classifications (browse nodes) that are associated with the item in
  # the Amazon catalog.
  attribute?(:classifications, [ItemBrowseClassification])
end