UpdateOrderInput

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. These aliases will be appended to any existing aliases provided during order creation.

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

The customer who placed the order.

If this is a multi-customer 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.

A list of aliases that we want to associate with DeliveryInformationDetails entities. This could include unique identifier of the DeliveryInformationDetails in merchant's store or display Id of the DeliveryInformationDetails in the merchant store. These aliases will be appended to any existing aliases.

The total number of aliases associated with a DeliveryInformationDetails are limited to 5.

Denotes desired order execution state which will trigger the fulfillment flow following order updates if set to 'STARTED'. This is an optional field which will leave the order state as it is if not provided.

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.

A list of the order's line items.

DeprecatedUse aliases.

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. These aliases will be appended to any existing aliases provided during order creation.

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

Any order identifier to look up the order. This could be the BwP orderId or any alias ID as well.

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.

The size should be greater than or equal to 0 and less than or equal to 5.

DeprecatedUse totalPrice instead.

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.

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.

Contains either a summary or details of refunds that have been issued on an order.

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.

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.