CancelOrderInput

📘
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 cancel an Order, 'cancelOrder' mutation.

Note: Currently only supports entire order cancellation.

Arguments

Argument Description

Argument	Description
`additionalComments` (String)	Additional comments/notes to be associated with this cancellation request.
`aliases` ([AliasInput])	A list of aliases that we want to associate with this Order Cancellation. This could include unique identifier of the order cancellation in merchant's store or cancellation display Id in the order of the merchant store. The total number of aliases associated with an cancellation are limited to 5. The size should be greater than or equal to 0 and less than or equal to 5.
`reason` (CancellationReasonInput)	Denotes reason for issuing cancellation.

additionalComments (String)

Additional comments/notes to be associated with this cancellation request.

aliases ([AliasInput])

A list of aliases that we want to associate with this Order Cancellation. This could include unique identifier of the order cancellation in merchant's store or cancellation display Id in the order of the merchant store.

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

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

reason (CancellationReasonInput)

Denotes reason for issuing cancellation.

📘Important

Overview

Arguments

📘
Important