RETURN_DELIVERY_IN_TRANSIT
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.
The RETURN_DELIVERY_IN_TRANSIT event is published when a returned Buy with Prime item was dropped off at the carrier location.
When you receive this event, you typically query the order to fetch more information about which products the shopper returned. 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_DELIVERY_IN_TRANSIT",
"source": "aws.partner/buywithprime/partner-event-source-name",
"account": "example-aws-account-id",
"time": "2023-05-26T16:15:07Z",
"region": "us-east-1",
"resources": [
"businessProduct/business-product-id/order/order-id/return/return-id",
],
"detail": {
}
}
Fields
| Key | Data Type | Description |
|---|---|---|
version | String | Amazon EventBridge event version. |
id | String | Amazon EventBridge-generated UUID for an event. |
detail-type | String | Type schema for the detail of the event, which in this case is RETURN_DELIVERY_IN_TRANSIT. |
source | String | Name of the partner event source in Amazon EventBridge. |
account | String | AWS account ID that hosts the partner event source. |
time | String | ISO 8601 timestamp that indicates when the event was published. |
region | String | AWS region from which the event is published. |
resources | Array of strings | Array 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. |
detail | Object | JSON 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