Product
Version 2024-11-01
Important
The Buy with Prime API is offered as a preview and might change as we receive feedback and iterate on the interfaces. We are sharing this early documentation to help you learn about the Buy with Prime API as we write and iterate on the content.
Overview
Product holds the product identifier mapping between e-commerce platform and Amazon.com. Product data authority is e-commerce platform. Product fulfillment is provided by Buy With Prime.
Fields
| Field | Description |
|---|---|
advertisedPrice (Price) | Advertised price for a product. |
amazonSku (AmazonSkuProductIdentifier) | Amazon SKU from Amazon.com. |
asin (AsinProductIdentifier) | Amazon Standard Identification Number (ASIN) from Amazon.com |
description (LocalizedStringField) | Description for a product, supporting plain text and HTML format |
externalId (ExternalProductIdentifier) | External e-commerce platform product identifier. |
externalVersion (String) | External version for a product. |
id (ID required) | Product identifier generated by Buy With Prime associated with the product. |
image (FeaturedImage) | Image associated with a product. |
metadata (ProductMetadata) | Readonly metadata field for a product |
offerPrime (Boolean) | Intention of offering prime for a product. |
price (Price) | Base price for a product, which is the cost of a single unit before any discounts, taxes or adjustments |
productDetailPageUrl (String) | Product detail page URL for a product. |
purchaseGroupMemberships ([PurchaseGroupMember]) | List of PurchaseGroupMembers representing the purchase groups that this product is part of |
representativeOfPurchaseGroup (PurchaseGroup) | PurchaseGroup that this product represents |
representativeOfVariationGroup (VariationGroup) | VariationGroup that this product represents |
sku (SkuProductIdentifier) | Product SKU from e-commerce platform. |
title (LocalizedStringField) | Title for a product. |
variationGroupMembership (VariationGroupMember) | VariationGroupMember representing the variation group that this product is part of |
inventoryItem (InventoryItem) | Extend Product with InventoryItem so clients can retrieve inventory data using external inventory identifiers. |
buyability (Buyability) | Extend Product with Buyability so clients can query Buyability fields when querying Product. |
Updated 14 days ago