Create and onboard an app notification template

You can use the App Integrations API to create and onboard your app notification templates.

Prerequisites

To complete this tutorial, you need:

• Authorization from the selling partner for whom you are making calls. For more information, refer to Authorizing Selling Partner API Applications.
• The Notifications in Seller Central role assigned to your developer profile.
• The Notifications in Seller Central role selected in the App Registration page for your application.

Step 1. Create your notification template draft

1. Sign in to Seller Central using the appropriate URL for your marketplace.

2. Navigate to the Developer Console.

3. Choose Action, then choose App Integration.

4. Choose Create a notification template.

5. On the notification template form, add the following information:

• Source language for template: Select the language used to provide the listing information.
• Template type: Input the name of your notification template. Format the identifier using all capital letters, with an underscore to separate words. For example, RESTOCK_LOW_INVENTORY.
• Template content: Specify the message that is displayed in the notification to the seller. This message must include between one and five parameters. Limit your message to 250 characters.
• Parameters: Specify the parameters and their supported types.

The following types of parameters are supported:

• Template CTA URL: Specify the URL that relates to the seller's call-to-action. This section is required. If you do not have a URL that relates to the seller's call-to-action, populate this field with the URL to your website.

• Expected action from sellers: Choose the action that the seller is expected to take based on the notification. Select the option that applies to your notification.

• Template topic: Choose the template type category. Select the option that applies to your notification. If none of the options apply, select Other and provide a category name.

  • Template topic - Other: Provide a category name.

• Template granularity level: Choose whether you want your template available at the marketplace level or the regional level. If you don't specify, your template defaults to the regional level. For a list of supported regions and marketplaces, refer to Marketplace IDs.

  ❗️

  Important

  Do not use HTML reserved characters (", ', &, <, or >) in any description. Including these characters delays the publishing of your notification.

6. After you have completed the notification template form, choose Preview.

7. On the Preview tab, review the notification for any errors. To make edits, close the Preview tab, and choose Edit on the notification template form.

8. After you edit your template, choose Save to save your edits.

Example notification templates

The following example shows a template for the fictitious RESTOCK_LOW_INVENTORY notification type.

Template type: RESTOCK_LOW_INVENTORY
Template content: You have ${NumberofProducts} products running low on inventory. Restock your inventory by clicking here.
Parameters: numberOfProducts: number
Template CTA URL: -
Sample content: You have 5 products running low on inventory. Restock your inventory by clicking here.
Marketplace or region: -
Expected action from seller: -
Template topic: -

The following example shows a template for the fictitious SALES_SUMMARY notification type.

Template type: SALES_SUMMARY
Template content: Your sales summary as of ${summaryAsOnDate} is ${salesSummaryInUSD} USD
Parameters: summaryAsOnDate: date
salesSummaryInUSD: number
Template CTA URL: -
Sample content: Your sales summary as of 2022-08-30 is 1000.50 USD
Marketplace or region: -
Expected action from seller: -
Template topic: -

Step 2. Submit your notification template for review

1. On the App Integration page, choose the Draft tab.

2. Select the notification templates that are ready for submission. You can select up to 10 notification templates.

3. Choose Submit for review.

Step 3. Check the status of your notification template

The notification template publishing process includes review and translation. You can track the status of your template on the Developer Console.

1. Sign in to Seller Central using the appropriate URL for your marketplace.

2. Navigate to Develop Apps.

3. In the Developer Console, choose Action, then choose App Integration.

4. On the App Integration page, choose In Review.

5. Check that your submitted notification template is marked as Submitted. You can preview a submitted template, but you can't edit it.

6. After Amazon approves and translates the template, navigate to the Developer Console and choose App Integrations. Then, choose Published.

   ⭐

   Tip

   If your template is not approved, feedback is provided with your template submission on the Drafts tab. Address the feedback and resubmit your template for review.

Step 4. Launch your new notification template

1. After your template is published, relist your application in the Selling Partner Appstore. After your application is relisted, Amazon grants you a Notifications in Seller Central badge.

2. Send notifications using the App Integrations API v2024-04-01.