LineItem

📘

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.

Fields

FieldDescription
aliases ([Alias])

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

amount (Amount)

Amount associated with the line item.

cancellations (Cancellations)

Provides cancellation summary and details that apply to this specific line item. Cancellation that applies to the entire order will be included in the order directly.

createdAt (String)

The Date Time in ISO 8601 format when the unit was created.

deliveryInformation (DeliveryInformation)

Contains a summary and optionally the details of Delivery that apply to this specific line item.

deliveryOffer (DeliveryOfferInfo)

Delivery Offer that is associated with the LineItem at the time of placement.

discounts (DiscountAllocations)

Promotional discounts allocated to the line item.

id (ID required)

Unique identifier to represent the line item.

lineItemAliases ([Alias])

DeprecatedUse aliases.

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

payments (Payments)

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 are included in the order directly.

purchasedItem (PurchasedItem)

DeprecatedConsider migrating to newer version of API 2024-04-01

Snapshot of purchased item details at the time of Order placement.

quantity (Quantity)

DeprecatedUse amount instead.

Quantity associated with the line item.

taxes (Taxes)

The tax(es) applied on the line item.