CreateOrderInput
Version 2024-01-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
Specifies the input fields required to initiate a Order, 'createOrder' mutation.
Arguments
| Argument | Description |
|---|---|
aliases ([AliasInput]) | A list of aliases that we want to associate with this 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. The total number of aliases associated with an order are limited to 5. |
customer (CustomerInput required) | The customer who placed the order. Contains details like shoppers contact (email, phone etc.) for any notifications related to the order. |
desiredExecutionState (OrderExecutionStateInput) | Denotes desired order execution state which will trigger the fulfillment flow following order creation if set to 'STARTED'. This is an optional field which will not start the order execution is if not provided. |
discounts (DiscountAllocationInput) | 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. |
lineItems ([LineItemInput] required) | A list of the order's line items. |
orderAliases ([AliasInput]) | DeprecatedUse A list of aliases that we want to associate with this 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. The total number of aliases associated with an order are limited to 5. |
orderLinks ([OrderLinkInput]) | 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. A maximum of 5 URLs can be provided. The size should be greater than or equal to 0 and less than or equal to 5. |
orderTotal (OrderTotalSummaryInput) | DeprecatedUse Indicates total price on the Order that was computed on the existing order out side of Buy with Prime. This allows as a reinforcement signal for ensuring data around prices is consistent with the data provided by clients to minimize ambiguity for Buy with Prime Order API clients. |
payments (PaymentsInput) | 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 should be included in the appropriate line item input. |
recipient (RecipientInput required) | Represents details of the recipient who will receive the order. In the future, we may relax the required constraint as we support a multi-recipient order then the expectation is there will not be one order level recipient but instead there will be recipient association at delivery offer level. In such cases we expect the order level recipient to be nullable. |
shopperIdentity (IdentityTokenInput required) | Represents the metadata from Identity Providers like Login with Amazon (LwA) or Amazon Pay (APay) to further attribute permissions to the shopper for managing the order. |
taxes (TaxInput) | The tax(es) applied on the order level; not total tax for the order. These tax(es) does not apply to or override tax(es) applied at individual entities in the order. |
totalPrice (OrderTotalSummaryInput) | Indicates total price on the Order that was computed on the existing order out side of Buy with Prime. This allows as a reinforcement signal for ensuring data around prices is consistent with the data provided by clients to minimize ambiguity for Buy with Prime Order API clients. |
Updated 3 days ago