LineItemInput

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

Represents a single line item on an order.

Arguments

ArgumentDescription
aliases ([AliasInput])

Unique identifiers of the line item Id in the order of the merchant’s store.

amount (AmountInput required)

The amount associated with the line item, indicating quantity or another relevant measure.

clientDetails (ClientDetailsInput)

Represents context for the buying application, like browser, ip fingerprints etc.

discounts (DiscountAllocationInput)

Promotional discounts allocated to the line item.

payments (PaymentsInput)

Contains either a summary or the details of payments that apply to this specific line item. Payments that don't apply to specific line items should be included in the order input directly.

product (PurchasedProductViewInput)

Snapshot of purchased product details at the time of Order placement. For items fulfilled by Buy with Prime (i.e., lineItem's deliveryProvider is either BUY_WITH_PRIME or AMAZON), product must be defined and provide title, price, identifier, and optionally variant information (if applicable). This allows for Amazon to show a consistent post-order experience.

selectedDeliveryOffer (DeliveryOfferInput required)

Shopper selected delivery offer for this line item.

taxes (TaxInput)

The tax(es) applied on the line item.