Buy with Prime | Developer Documentation
Documentation

RETURN_COMPLETED

📘

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

The RETURN_COMPLETED event is published when a return that was initiated earlier was successfully completed.

The following examples are ways that you might use this event:

  • To enable customers to see that their returned items were received, so that they don't have to worry about whether they can receive their refund.
  • To enable customer service agents to see that a customer is eligible for a refund, so that they can give the customer accurate information if the customer reaches out by phone or email.
  • To enable developers to update their order management system and all of the downstream systems. Examples of downstream systems are analytics and reporting on business performance, accounting for remitting taxes, customer service agents helping customers who reach out, and so on.
  • To enable e-commerce managers to be confident that their customer experience meets their high bar, so that they don't have to worry that some customers aren't able to return the items.

Required permission

To subscribe to this event, your API credentials must have at least Read Order permission. You choose permissions when you generate your API credentials. For details, see Authenticate to the Buy with Prime API.

Schema

Schema for webhook destinations 
{
    "idempotencyKey":"example-idempotency-key",
    "eventDescriptor": "RETURN_COMPLETED",
    "resources": [
        "businessProduct/business-product-id/order/order-id/return/return-id"
    ],
    "eventId":"example-event-id",
    "apiVersion": "2024-11-01",
    "subscriptionId": "example-subscription-id",
    "eventTime":"2025-01-20T12:34:56Z",
    "data": {}
}
Schema for Amazon EventBridge destinations 
{
    "version": "0",
    "id": "example-event-id",
    "detail-type": "RETURN_COMPLETED",
    "source": "aws.partner/buywithprime/partner-event-source-name",
    "account": "example-aws-account-id",
    "time": "2025-01-20T12:34:56Z",
    "region": "us-east-1",
    "resources": [
        "businessProduct/business-product-id/order/order-id/return/return-id"
    ], 
    "detail": {
        "idempotencyKey":"example-idempotency-key",
        "eventDescriptor": "RETURN_COMPLETED",
        "resources": [
            "businessProduct/business-product-id/order/order-id/return/return-id"
        ],
        "eventId":"example-event-id",
        "apiVersion": "2024-11-01",
        "subscriptionId": "example-subscription-id",
        "eventTime":"2025-01-20T12:34:56Z",
        "data": {}
    }
}
Schema for Amazon EventBridge destinations (Deprecated) 
{
    "version": "0",
    "id": "example-event-id",
    "detail-type": "RETURN_COMPLETED",
    "source": "aws.partner/buywithprime/partner-event-source-name",
    "account": "example-aws-account-id",
    "time": "2025-01-20T12:34:56Z",
    "region": "us-east-1",
    "resources": [
        "businessProduct/business-product-id/order/order-id/return/return-id"
    ], 
    "detail": {}
}

Fields

KeyData typeDescription
versionStringAmazon EventBridge event version.
idStringAmazon EventBridge-generated UUID for an event.
detail-typeStringType schema for the detail of the event, which in this case is RETURN_COMPLETED.
sourceStringName of the partner event source in Amazon EventBridge. For details, see Subscribe to Events.
accountStringAWS account ID that hosts the partner event source.
timeStringISO 8601 timestamp that indicates when the event was published.
regionStringAWS region from which the event is published.
resourcesArray of stringsArray of identifiers for the resources that triggered the event, in key-value pair format. Each resource identifier is a string that starts with businessProduct/{businessProductId}/, followed by resource types (keys) and resource IDs (values) separated by slashes. For details about how to interpret resources, see Subscribe to Events.
detailObjectJSON object that contains details about the event. You can call the Buy with Prime API to find further information about the resource(s) specified in the resources array. For details, see detail fields.

Detail fields

KeyData typeDescription
idempotencyKeyStringUnique identifier to detect duplicate events.
eventDescriptorStringEvent type that determines the default query.
resourcesArray of stringsArray of identifiers for the resources that triggered the event, in key-value pair format. Each resource identifier is a string that starts with businessProduct/{businessProductId}/, followed by resource types (keys) and resource IDs (values) separated by slashes. This field is the same value as resources at the top level.
eventIdStringUnique identifier for this event. This field is the same value as id at the top level.
apiVersionStringBuy with Prime API version associated with this event.
subscriptionIdStringUnique identifier for an event subscription.
eventTimeStringISO 8601 timestamp that indicates when the event was published. This field is the same value as time at the top level.
dataObjectJSON object that can contain API response data.

Handling the event

When you receive this event, you typically query the order to fetch more information about which products the shopper returned. For details, see Steps to Process Returns.

Related topics

Updated about 1 month ago