Buy with Prime | Developer Documentation
Documentation

RETURN_STARTED

📘

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_STARTED event is published when a return of one or more purchased items was successfully initiated.

Typically, this event is a result of a customer initiating a return through the Buy with Prime user interface. The following examples are ways that you might use this event:

  • To enable customer service agents to see that a customer successfully initiated a self-service return, 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 eCommerce managers to see how many customers attempt to return items through the self-service flow with Amazon, so that they can fix any problems customer might have in the return process.

When you receive this event, you typically query the order to fetch more information about which products the shopper is returning. For details, see Handling the event.

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

{
  "version": "0", 
  "id": "example-event-id", 
  "detail-type": "RETURN_STARTED", 
  "source": "aws.partner/buywithprime/partner-event-source-name",
  "account": "example-aws-account-id", 
  "time": "2023-10-27T12: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_STARTED.
sourceStringName of the partner event source in Amazon EventBridge.
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 How to process events.
detailObjectJSON object that contains details about the event. For this event, this object is empty; you must call the Buy with Prime API to find further information about the resource(s) specified in the resources array.

Handling the event

For details about how to process this event, see Steps to Process Returns.

Related topics

Updated 20 days ago