Agent-readable docs index: /llms.txt. Download /docs.zip to grep all markdown files locally.

AmazonProduct

AmazonProduct and ShopifyProduct have similarities and differences that are compared in detail here

Fields

path idID!required
The unique identifier for the Amazon product.
path marketplaceMarketplace!required
Value for a marketplace for AmazonProduct is set to Marketplace.AMAZON.
path titleString!required
The title of the Amazon product.
path descriptionString!required
The description of the product.
path vendorString!required
The brand of the product.
path urlURL!required
The canonical URL for the product on Amazon's website.
path pricePrice
The price of the Amazon product that the shopper is charged, including its value, currency, and display value.
This price is the greater of the amazonBusinessPrice and amazonRegularPrice fields. See the Price type for more information.
path amazonBusinessPricePrice
The business price of the Amazon product, not accounting for dynamic discounts like volume pricing. This can be cheaper than the regular price.
path amazonRegularPricePrice
The price of the Amazon product that displays on Amazon retail
path isAvailableBoolean!required
Indicates whether the product is available in stock. This field is required.
path hasOfferBoolean
Indicates whether requested Amazon Offer is available. e.g. it will return false if you requested sold&shipped by amazon, but only 3rd party offer available.
arguments
path fulfilledByAmazonBoolean
Set to true to only consider offers that are fulfilled by Amazon, rather than a third-party fulfillment service.
path soldByAmazonBoolean
Set to true to only consider offers that are sold by Amazon, rather than a third-party merchant.
path tagsString!required
A list of tags associated with the Amazon product
path imagesImage!required
A list of images for the Amazon product. This field is required.
path thumbnailImage
The thumbnail image for the Amazon product, when available.
arguments
path sizeProductThumbnailSize!required
The size of the thumbnail image to return.
path variantsVariant!required
A list of product variants, such as different colors or sizes.
path ASINID!required
Amazon's canonical product ID (Amazon Standard Identification Number). This field is required
path titleExcludingVariantNameString!required
The Amazon product title without any additional context of the variant.
path featureBullets[String!]!required
A list of summary bullets about the product, found next to the product image on Amazon.
path parentIDID
The parent ID of the product if the product has multiple variants.
path protectionPlans[AmazonProtectionPlan!]!required
A list of protection plans available for the product.
path categories[AmazonCategory!]!required
A list of categories to which the product belongs.
path ratingsTotalInt!required
The total number of ratings for this item.
path reviewsTotalInt!required
The total number of reviews for this item.
path subtitleAmazonSubtitle
The secondary title for the product, displayed below the main title on the product detail page.
path videos[AmazonVideo!]!required
A list of videos associated with the product.
path specifications[AmazonSpecification!]!required
A list of product specifications.
path colorString
The color of the product.
path manufacturerString
The manufacturer of the product.
path weightString
The weight of the product.
path firstAvailableTime
The date when the product was first listed on Amazon.
path dimensionsString
The dimensions of the product.
path modelNumberString
The manufacturer's model number for the product.

Related types

Rye
Powered byHolocron