App Integrations API

Learn how to use the App Integrations API.

You use the Selling Partner API for App Integrations to send targeted app notifications to sellers.

Current versionLegacy versionsAvailable to sellersAvailable to vendors
v2024-04-01 (Reference | Model)NoneYesNo
Release notes

To learn more about the terms that are used in this guide, refer to Terminology.

Use cases

Key tasks that you can perform with the App Integrations API include:

  • Post notifications that are critical to your application and your selling partner's business in Seller Central.
  • Delete notifications that are incorrect or outdated.
  • Use notifications to track seller engagement activity.

You can send notifications to inform the seller about their business or to encourage the seller to take action on your website. The notification message is displayed on the notification banner in Seller Central. You can also track seller engagement with published notifications.

Each app notification that you create has a unique identifier (the notification ID). You can retrieve this ID from the createNotification response. When a seller clicks on the notification's call-to-action (CTA) URL, the notification ID is appended to the URL. You can use this information to track which users are clicking on the notification.

The following use case examples are available for the App Integrations API v2024-04-01:

Important

The following notification content is not permitted:

  • Notifications that name a non-Amazon sales channel. You can provide details or a summary of a non-Amazon channel, but not the channel name.
  • Promotional notifications that invite the seller to adopt new products or features that:
    • Incur additional costs or fees
    • Are not part of what the seller has already signed up for
    • Don't relate to the seller's business needs

You can view the notifications you send through App Notifications on the Seller Central homepage, where you can select to view the notification details.

Roles

createNotification
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Notifications in Seller Central
deleteNotifications
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Notifications in Seller Central
recordActionFeedback
AttributeValue
RegionsNA, EU, FE
Required roles (need at least one)Notifications in Seller Central