A Buy with Prime refund is a process by which a customer is reimbursed for an item that they ordered, which is then returned or cancelled.

A refund for Buy with Prime items in an order is requested in the following cases:

• After placing an order, a customer goes to the Buy with Prime shopper order details page, where they request to cancel the order.
• After receiving the order, a customer requests a return for the Buy with Prime items in the order.
• You use the Buy with Prime merchant console to request an order cancellation or a return on behalf of a customer.
• After a customer creates an order, the order or an item in the order is cancelled because an item becomes unfulfillable or encounters delivery exceptions such as package undelivered, lost, and so on.
• A customer reaches out to a Buy with Prime customer service agent, who initiates a refund.

If you subscribe to Buy with Prime events, you're notified of refunds by the REFUND_REQUESTED event. You then initiate the refund and update Buy with Prime with the latest details. For the process, see Steps to Process Refunds.

You currently can't do the following operations with Buy with Prime refunds:

• Directly generate a Buy with Prime refund request.
• Update the items associated with a refund requested through Buy with Prime.
• Manually generate a refund from the Buy with Prime merchant console. However, you can return or cancel an order from the merchant console. These actions automatically generate a refund request for the order.

You can associate each refund with one or more identifiers called aliases, which are in the refunds.details.aliases field of the order. If you use aliases for a refund, it is crucial to ensure that the aliases that you provide for the refund are unique and aren't already associated with other refunds in the order.

Each alias has an aliasId and an aliasType. We strongly recommend that you provide a unique aliasId that you can use when you call the updateOrder mutation to add or update refund details.

You can add and update refund aliases related to the order by calling the updateOrder mutation in the following way:

• Updating an alias: Aliases of the same type overwrite each other. Therefore, to update an alias, call the updateOrder mutation and provide an aliasType that is already present for the refund. The existing aliasId with that aliasType will be overwritten with the aliasId that you provide in the updateOrder request. For example, consider an order with a refund aliasType of EXTERNAL-REFUND-ID and an aliasId of external-refund-id-1. If you call the updateOrder mutation and specify an aliasType of EXTERNAL-REFUND-ID and an aliasId of external-refund-id-2, the aliasId for the EXTERNAL-REFUND-ID is overwritten with the new value, external-refund-id-2.
• Adding aliases: To add an alias, call the updateOrder mutation and provide an alias with a new aliasType.

📘

Note

You can't delete existing aliases.

The state of the refund. As you process refunds with your order management system, you call the updateOrder mutation to update the refund state for the Buy with Prime order. The following table shows the allowable refund state values that you can set on your next call to updateOrder given the current refund state. For details about processing refunds, see Steps to Process Refunds.

A Buy with Prime return is an action that a customer takes to return previously-delivered items that they purchased in a Buy with Prime order.

For details, see Return interface.

Reversal is a term that the Buy with Prime API uses to encompass the concepts of returns, refunds, and cancellations.