AmazonItem interface

Details about an item for sale on the amazon website.

Signature:

export interface AmazonItem 

Remarks

Details of the item present will depend on which AmazonItemContent values were provided when requesting this item.

Note: All values aren't available for all items even if you've requested the content.

Properties

PropertyModifiersTypeDescription
asinreadonlystringUnique identifier of the product
detailPageURLreadonlystringLink to the item on the amazon website
itemInforeadonlyAmazonItemInfoProduct information about the item
offersreadonlyAmazonOfferListing[]Details about the current listings of the item
primaryImagereadonlyAmazonImageOptionsThe main image in various sizes for this item
summariesreadonlyAmazonOfferSummary[]Summary information about offers of the item
variantImagesreadonlyAmazonImageOptions[]The alternative image of the item in various sizes

AmazonItem.asin property

Unique identifier of the product

Signature:

readonly asin: string;

Remarks

Always returned

AmazonItem.itemInfo property

Product information about the item

Signature:

readonly itemInfo: AmazonItemInfo;

Remarks

Title information is returned if you don't provide any AmazonItemContent values to your query.

But if any AmazonItemContent value is provided this is only present if AmazonItemContent.ItemInfoTitle or AmazonItemContent.ItemInfoFeatures is requested.

AmazonItem.detailPageURL property

Link to the item on the amazon website

Signature:

readonly detailPageURL: string;

Remarks

Always returned

AmazonItem.offers property

Details about the current listings of the item

Signature:

readonly offers: AmazonOfferListing[];

Remarks

Only present if one of AmazonItemContent.OffersListingMerchantInfo, AmazonItemContent.OffersListingBuyBoxWinner, or AmazonItemContent.OffersListingPrice is requested.

AmazonItem.primaryImage property

The main image in various sizes for this item

Signature:

readonly primaryImage: AmazonImageOptions;

Remarks

Only present if one of AmazonItemContent.ImagesPrimarySmall, AmazonItemContent.ImagesPrimaryMedium, or AmazonItemContent.ImagesPrimaryLarge is requested.

AmazonItem.summaries property

Summary information about offers of the item

Signature:

readonly summaries: AmazonOfferSummary[];

Remarks

Only present if one of AmazonItemContent.OffersSummaryOfferCount, AmazonItemContent.OffersSummaryLowestPrice, or AmazonItemContent.OffersSummaryHighestPrice is requested.

AmazonItem.variantImages property

The alternative image of the item in various sizes

Signature:

readonly variantImages: AmazonImageOptions[];

Remarks

Only present if one of AmazonItemContent.ImagesVariantsSmall, AmazonItemContent.ImagesVariantsMedium, or AmazonItemContent.ImagesVariantsLarge is requested.