PurchasedProductViewInput

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

Purchased product input that represents details at the time of Order placement.

Arguments

ArgumentDescription
identifier (ProductIdentifierInput)

Identifier for selected product from catalog. If the lineItem's deliveryProvider is BUY_WITH_PRIME or AMAZON (starting 2024-11-01 version), then this identifier is required. If the lineItem's deliveryProvider is MERCHANT, then this is an optional input.

image (FeaturedImageInput)

Image associated with the product.

offerPrime (Boolean)

Intention of offering prime for the product.

price (MoneyInput)

Price associated with the product. If the lineItem's deliveryProvider is BUY_WITH_PRIME or AMAZON (starting 2024-11-01 version), then price is required and should be positive. If the lineItem's deliveryProvider is MERCHANT, then price is an optional input.

productDetailPageUrl (String)

Product detail page URL for the product.

The size should be greater than or equal to 1 and less than or equal to 2000.

purchaseGroupMembership (PurchaseGroupViewMemberInput)

Details of the purchase group membership if this product was purchased as a component of another product such as a bundle.

title (String)

Title associated with the product. If the lineItem's deliveryProvider is BUY_WITH_PRIME or AMAZON (starting 2024-11-01 version), then title is required. If the lineItem's deliveryProvider is MERCHANT, then title is an optional input.

The size should be greater than or equal to 1 and less than or equal to 250.

variationSelections ([VariationSelectionInput])

Variation selections associated with the product. For example, 'Color: Red'.