Selling Partner API for Notifications
The Selling Partner API for Notifications lets you subscribe to notifications that are relevant to a selling partner's business. Using this API you can create…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The Selling Partner API for Notifications lets you subscribe to notifications that are relevant to a selling partner's business. Using this API you can create a destination to receive notifications, subscribe to notifications, delete notification subscriptions, and more.
For more information, refer to the Notifications Use Case Guide.
Endpoints 10
notifications
- GETgetSubscriptions
/notifications/v1/subscriptions?notificationTypes=string&payloadVersion=string&pageSize=30&nextToken=stringReturns information about subscriptions of the specified notification type. You can use this API to retrieve all subscriptions when multiple subscriptions… - GETgetSubscription
/notifications/v1/subscriptions/:notificationType?payloadVersion=stringReturns information about subscription of the specified notification type and payload version. payloadVersion is an optional parameter. When you do not… - POSTcreateSubscription
/notifications/v1/subscriptions/:notificationTypeCreates a subscription for the specified notification type to be delivered to the specified destination. Before you can subscribe, you must first create the… - GETgetSubscriptionById
/notifications/v1/subscriptions/:notificationType/:subscriptionIdReturns information about a subscription for the specified notification type. The getSubscriptionById operation is grantless. For more information, refer to… - DELETEdeleteSubscriptionById
/notifications/v1/subscriptions/:notificationType/:subscriptionIdDeletes the subscription indicated by the subscription identifier and notification type that you specify. The subscription identifier can be for any… - POSTsendTestNotification
/notifications/v1/subscriptions/:notificationType/testNotificationSends a mock notification of the specified type to your SQS. The sendTestNotification API is grantless. For more information, see "Grantless operations" in… - GETgetDestinations
/notifications/v1/destinationsReturns information about all destinations. The getDestinations operation is grantless. For more information, refer to Grantless Operations in the Selling… - POSTcreateDestination
/notifications/v1/destinationsCreates a destination resource to receive notifications. The createDestination operation is grantless. For more information, refer to Grantless Operations in… - GETgetDestination
/notifications/v1/destinations/:destinationIdReturns information about the destination that you specify. The getDestination operation is grantless. For more information, refer to Grantless Operations in… - DELETEdeleteDestination
/notifications/v1/destinations/:destinationIdDeletes the destination that you specify. The deleteDestination operation is grantless. For more information, refer to Grantless Operations in the Selling…
API details
- Base URL
https://sellingpartnerapi-na.amazon.com- Authentication
- None declared in the description
- Operations
- 10 operations on 6 pathsGET 5POST 3DELETE 2
- Main resources
- notifications 10
- Response formats
application/json- Description format
- Swagger 2.0, API version
v1 - Links
- OpenAPI document · Support
- Listed from
- Amazon Selling Partner's published OpenAPI description (amzn/selling-partner-api-models) (Apache-2.0)
How to test the Selling Partner API for Notifications in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Selling Partner API for Notifications collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “getSubscriptions” (GET /notifications/v1/subscriptions?notificationTypes=string&payloadVersion=string&pageSize=30&nextToken=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Selling Partner API for Notifications?
The Selling Partner API for Notifications lets you subscribe to notifications that are relevant to a selling partner's business. Using this API you can create… It is listed under E-commerce and has 10 endpoints.
Who publishes the Selling Partner API for Notifications?
It is listed from Amazon Selling Partner's public API description (an OpenAPI document), not published by Amazon Selling Partner on Swastik Codes. Anyone who controls sellingpartnerapi.amazon.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Selling Partner API for Notifications?
Requests go to https://sellingpartnerapi-na.amazon.com. Endpoint paths are added to this base URL.
How do I authenticate with the Selling Partner API for Notifications?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the Selling Partner API for Notifications have?
10 operations on 6 paths (5 GET, 3 POST, 2 DELETE). The largest groups are notifications.
Is forking the Selling Partner API for Notifications free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.