BUYABILITY_CHANGED
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 BUYABILITY_CHANGED
event is published when an item that was previously eligible for Buy with Prime is no longer eligible for Buy with Prime, or vice versa.
Required permission
To subscribe to this event, your API credentials must have at least Read Buyability permission. You choose permissions when you generate your API credentials. For details, Authenticate to the Buy with Prime API.
Schema
{
"version": "0",
"id": "example-event-id",
"detail-type": "BUYABILITY_CHANGED",
"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/items/item-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 BUYABILITY_CHANGED . |
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
When you receive this event, parse the resources
array of the event for the item ID of the associated product.
You can then use the product
query of the Catalog interface to find the buyability
of the item.
For an example, see Get the buyability status of a product.
Related topics
Updated 20 days ago