Order

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 an instance of a Buy with Prime Order.

Fields

FieldDescription
aliases ([Alias])

A list of aliases that are associated with the Buy with Prime Order. This could include unique identifier of the order in merchant's store or display Id in the order of the merchant store etc.

The total number of aliases associated with an order are limited to 5.

customer (Customer)

The customer who placed the order.

If this is a multi-customer order (group order) then the expectation is there will not be one order level customer but instead there will be customer association at line item level. In such cases we expect the order level customer to be nullable.

discounts (DiscountAllocations)

Promotional discounts allocated on the order level. Please note that this is not the total discount of the order. Discount allocated to some specific line items should be set in the corresponding lineItem. Discount allocated to shipping should be set in the corresponding deliveryOffer.

id (ID required)

Unique identifier to represent the Buy with Prime Order.

lineItems ([LineItem] required)

A list of the order's line items.

metadata (OrderMetadata)

Provides metadata on the order containing details like execution state, when the order is created and last updated.

orderLinks ([OrderLink])

Contains list of URLs to manage the order from shopper/merchant experiences. If external storefront URLs are provided, these will be surfaced on any Buy with Prime experiences for discoverability and similarly any Amazon storefront URLs provided can be used by clients to incorporate in their experiences.

packageInformation (PackageInformation)

Contains an optional summary and details of Delivery for all items in the order. In order to look at specific details of delivery on the Line Item, that can also be navigated via LineItem.packageInformation as well.

payments (Payments)

Contains either a summary or the details of payments for the order that don't apply to any specific line items. Payments that apply to specific line items are included in the appropriate line item.

recipient (Recipient)

The recipient to whom the products in the order get delivered to.

If this is a multi-recipient order (group order) then the expectation is there will not be one order level recipient but instead there will be recipient association at delivery level. In such cases we expect the order level recipient to be nullable.

refunds (Refunds)

Contains all the refunds that have happened on an order. This contains both; RefundSummary and RefundDetailed view. RefundSummary provides a summarized view of all refunds that have happened on an order whereas RefundDetail provides detailed view of all refunds. In order to look at refunds associated with Returns, Cancellations, look at refunds under those nodes.

returns (Returns)

Contains all the returns that have been requested against an order.

taxes (Taxes)

The tax(es) applied on the order level; not total taxes for the order. These tax(es) does not apply to or override tax(es) applied at individual entities in the order.

totalPrice (OrderTotalSummary)

Represents the summary of charges on the order by rolling up different charges appropriately and categorizing them into a high level view.