Buy with Prime | Developer Documentation
Documentation

Get Refund Details

📘

Buy with Prime API is now available for early access

Sign up for early access to the Buy with Prime API using the 'Sign Up' button below. The API may change as Amazon receives feedback and iterates on it.

Sign Up

As you process Buy with Prime refunds for an order, you can get details about all the refunds associated with the order. You then initiate the refunds and update the Buy with Prime order with the latest information. For details, see Steps to Process Refunds.

The following examples show how to get information about Buy with Prime refunds.

For an overview of refund terminology, see Synchronize Refunds. To learn how to call the Buy with Prime API, see Call the Buy with Prime API.

Get refund details for an order

After you receive a REFUND_REQUESTED event, you can find information about refunds for the associated order in the event's data object.

The following example REFUND_REQUESTED event shows that the refund is in the PENDING state and is associated with line item example-line-item-id. The estimated amount to be refunded is $10.

{
    "idempotencyKey":"example-idempotency-key",
    "eventDescriptor": "REFUND_REQUESTED",
    "resources": [
        "businessProduct/business-product-id/order/order-id/refund/example-refund-id"
    ],
    "eventId":"example-event-id",
    "apiVersion": "2024-11-01",
    "subscriptionId": "example-subscription-id",
    "eventTime":"2025-01-20T12:34:56Z",
    "data": {
        "order": {
            "id": "example-order-id",
            "aliases": [
                {
                    "aliasId": "example-alias-id",
                    "aliasType": "example-alias-type"
                }
            ],
            "refunds": {
                "details": [
                    {
                        "id": "example-refund-id",
                        "createdAt": "example-created-at-datetime-string",
                        "updatedAt": "example-updated-at-datetime-string",
                        "state": "PENDING",
                        "refundRequestReason": "example-refund-request-reason-string",
                        "refundStatusReason": "example-refund-status-reason-string",
                        "refundTotal": {
                        "totalAmount": {
                            "amount": 10.0,
                            "currencyCode": "USD"
                            }
                        },
                        "refundFor": {
                            "orderLineItems": [
                                {
                                    "lineItem": {
                                        "id": "example-line-item-id"
                                    }
                                }
                            ]
                        }
                    }
                ]
            }
        }
    },
}

Get the refund request reason and the refund status reason

Order information included in the event contains the refund request reason and the refund status reason. These fields are in the refunds.details of the data object.

{
    "idempotencyKey":"example-idempotency-key",
    "eventDescriptor": "REFUND_REQUESTED",
    "resources": [
        "businessProduct/business-product-id/order/order-id/refund/example-refund-id"
    ],
    "eventId":"example-event-id",
    "apiVersion": "2024-11-01",
    "subscriptionId": "example-subscription-id",
    "eventTime":"2025-01-20T12:34:56Z",
    "data": {
        "order": {
            "id": "example-order-id",
            "aliases": [
                {
                    "aliasId": "example-alias-id",
                    "aliasType": "example-alias-type"
                }
            ],
            "refunds": {
                "details": [
                    {
                        "id": "example-refund-id",
                        "createdAt": "example-created-at-datetime-string",
                        "updatedAt": "example-updated-at-datetime-string",
                        "state": "PENDING",
                        "refundRequestReason": "CUSTOMER_NOT_SATISFIED_WITH_SERVICE",
                        "refundStatusReason": "FRAUDULENT_RETURN_ATTEMPT",
                        "refundTotal": {
                        "totalAmount": {
                            "amount": 10.0,
                            "currencyCode": "USD"
                            }
                        },
                        "refundFor": {
                            "orderLineItems": [
                                {
                                    "lineItem": {
                                        "id": "example-line-item-id"
                                    }
                                }
                            ]
                        }
                    }
                ]
            }
        }
    },
}

Related topics

Updated 22 days ago