Notifications API
Learn how to subscribe to notifications that are relevant to a selling partner's business.
You use the Notifications API to subscribe to notifications that are relevant to your selling business. You can create a destination to receive notifications, subscribe to notifications, delete notification subscriptions, and more. Instead of polling for information, your application can receive information directly from Amazon when an event generates a notification to which you are subscribed.
You can subscribe to notifications on behalf of sellers or vendors. To determine whether you can subscribe to a notification type on behalf of sellers only, vendors only, or both, go to notificationType
. We allow multiple subscriptions with different payload versions per application, notification type and party (seller/vendor). For supported payload versions of different notification types, refer to notificationType
.
Build a backup mechanism
As a best practice, we recommend that you have a means to retrieve needed information in the event of an unexpected outage or delay in notification delivery.
Release notes
To learn more about the terms that are used on this page, refer to Terminology.
Uses cases
The following use case examples are available for the Notifications API:
-
Set up notifications using the Amazon EventBridge workflow: Set up your system to receive notifications using the Amazon EventBridge workflow.
-
Set up notifications using the Amazon Simple Queue Service workflow: Set up your system to receive notifications using the Amazon Simple Queue Service workflow.
Roles
createDestination
Attribute | Value |
---|---|
Regions | NA, EU, FE |
Required roles (need at least one) | None (grantless) |
createSubscription
Attribute | Value |
---|---|
Regions | NA, EU, FE |
Required roles (need at least one) | The role that is associated with the notification type |
deleteDestination
Attribute | Value |
---|---|
Regions | NA, EU, FE |
Required roles (need at least one) | None (grantless) |
deleteSubscriptionById
Attribute | Value |
---|---|
Regions | NA, EU, FE |
Required roles (need at least one) | None (grantless) |
getDestination
Attribute | Value |
---|---|
Regions | NA, EU, FE |
Required roles (need at least one) | None (grantless) |
getDestinations
Attribute | Value |
---|---|
Regions | NA, EU, FE |
Required roles (need at least one) | None (grantless) |
getSubscription
Attribute | Value |
---|---|
Regions | NA, EU, FE |
Required roles (need at least one) | The role that is associated with the notification type |
getSubscriptionById
Attribute | Value |
---|---|
Regions | NA, EU, FE |
Required roles (need at least one) | None (grantless) |
Updated about 10 hours ago