Amazon Marketplace Web Service (MWS) will no longer be available after March 31, 2024. All MWS developers must migrate to Selling Partner API (SP-API) to avoid service disruptions. Refer to the Migration Hub for more information.
The Amazon MWS Subscriptions API section enables you to subscribe to receive notifications that are relevant to your business with Amazon. With the operations in the Subscriptions API section, you can register to receive important information from Amazon without having to poll the Amazon MWS service. Instead, the information is sent directly to you when an event occurs to which you are subscribed.
To receive notifications, you must first create and register a Destination, such as an Amazon Simple Queue Service (Amazon SQS) queue. Then, you create a Subscription for the NotificationType that you want to receive, such as a notification when another Seller has changed their offer for an item that you also sell. Finally, verify that Amazon is able to send notifications to your Destination by calling the SendTestNotificationToDestination operation.
The following table defines terminology for this API section:
Term | Description |
---|---|
Notification | A communication that contains information related to a specific state change or event that affects you. A Notification is also referred to as a Message. |
Notification Type | A label that denotes a specific class of notifications. For example, AnyOfferChanged notifications. |
Delivery Channel | A technology that you use to receive notifications. For example, Amazon SQS. |
Destination | A delivery channel that you create to receive notifications. For example, an Amazon SQS queue with the URL "http://sqs.us-east-1.amazonaws.com/12345/queue1". |
Subscription | An object that represents the type of notification that you want to receive and the location where you want to receive it. For example, send AnyOfferChanged notifications for Seller A1234 to the Amazon SQS queue at "http://sqs.us-east-1.amazonaws.com/12345/queue1". |
The following operations are included in the Subscriptions API section:
Operation | Description | Availability |
---|---|---|
RegisterDestination | Specifies a new destination where you want to receive notifications. | All marketplaces except Mexico. |
DeregisterDestination | Removes an existing destination from the list of registered destinations. | All marketplaces except Mexico. |
ListRegisteredDestinations | Lists all current destinations that you have registered. | All marketplaces except Mexico. |
SendTestNotificationToDestination | Sends a test notification to an existing destination. | All marketplaces except Mexico. |
Operation | Description | Availability |
---|---|---|
CreateSubscription | Creates a new subscription for the specified notification type and destination. | All marketplaces except Mexico. |
GetSubscription | Gets the subscription for the specified notification type and destination. | All marketplaces except Mexico. |
DeleteSubscription | Deletes the subscription for the specified notification type and destination. | All marketplaces except Mexico. |
ListSubscriptions | Returns a list of all your current subscriptions. | All marketplaces except Mexico. |
UpdateSubscription | Updates the subscription for the specified notification type and destination. | All marketplaces except Mexico. |