After July 2021, the 2.3.x release line will no longer receive quality updates, or user guide updates. PHP 7.3 reaches end of support in December 2021 and Adobe Commerce 2.3.x reaches end of support in September 2022. We strongly recommend planning your upgrade now to Adobe Commerce 2.4.x to help maintain PCI compliance.

Add or Verify the Amazon API Key

The information on this page is intended for Adobe Commerce 2.3 customers who are on an extended support contract. The Adobe Commerce Merchant Documentation for current releases is published on the Adobe Experience League.

When accessing Amazon Sales Channel, Magento automatically checks and validates the Amazon API key you have added in your store configuration. If validated, then you can move on to the next step, Store Integration.

If the Amazon API key is missing, invalid, or expired, you must update your key. A message appears prompting you to get an API key and to add they key to your Amazon Sales Channel configuration.

Get and add the Amazon API key as prompted

The API key is validated each time you access your Amazon Sales Channel.

  1. Log into the Magento Admin.

  2. On the Admin sidebar, go to Marketing > Channels > Amazon.

    If this is your first time accessing Amazon Sales Channel or if you need to update your API key, a modal will appear to prompt you through the process.

    Get and Add the Amazon API Key Prompt

  3. Click Sign in to access your Magento web account.

    The Magento Accounts page opens in a new browser tab.

    • If you are logged into your Magento account, the API Portal section of the My Account page appears automatically.

    • If you are not logged in, you are prompted to enter your Magento username and password before the API Portal tab appears.

    • If you need to create a Magento account, visit here and register. This account should be part of your company or business.

  4. If needed, you can view and generate API keys on the API Portal tab in your Magento account.

    If you need to create a new API key, enter a description like Amazon Sales Channel and click Add New. The new key is generated and shown with the name you entered. Click Copy to copy the new key.

    Generate or Copy an API Key

  5. With the new key generated and copied, return to the Amazon Sales Channel tab in the browser.

  6. On the Welcome to Amazon Sales Channel page, click Add the key.

    The browser exits Amazon Sales channel and a store configuration page opens the Api Keys page in the Magento Admin at Stores > Settings > Configuration > Services > Magento Services.

  7. Paste the copied key for Production Api key.

  8. Click Save Config. You can now return to Amazon Sales Channel.

    Add your API Key in the Magento Service modal in your Store Configuration

  9. On the Admin sidebar, go to Marketing > Channels > Amazon.

    Reaccessing Amazon Sales Channel triggers Magento verify and validate your API key and allows you to continue.

    If prompted to verify the key again, repeat this Add and Verify process.

Continue to Store Integration