You are viewing documentation for Amazon Sales Channel 2.x / 3.x.
Refer to Amazon Sales Channel 4.0+ for updated documentation.
After July 2021, the 2.3.x release line no longer received quality updates or user guide updates. PHP 7.3 reached end of support in December 2021, and Adobe Commerce 2.3.x reached end of support in September 2022. We strongly recommend upgrading to Adobe Commerce 2.4.x to help maintain PCI compliance.

Add or Verify the Amazon API Key

This site contains archived merchant documentation for a version of Adobe Commerce and Magento Open Source that has reached end-of-support. The documentation available here is intended for historical reference only and is not maintained. 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 displays prompting you to get an API key and to add they key to your Amazon Sales Channel configuration.

To 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 you need to update your API key, the following screen displays 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 displays in a new browser tab.

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

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

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

  4. API keys can be viewed and generated 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 displayed 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 browser tab. On the Welcome to Amazon Sales Channel screen, click Add the key. The browser exits Amazon Sales channel, and a store configuration page opens to Stores > Configuration > Services > Magento Services.

  6. Paste the copied key into the Production Api key field.

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

    Add your API Key in the Magento Services screen in your Store Configuration

  8. On the Admin sidebar, go to Marketing > Channels > Amazon. Magento verifies and validates your API key and allows you to continue with setup.

    If prompted to verify the key again, repeat the process.

Continue to Store Integration

See Onboarding Amazon Sales Channel.

© 2024 Adobe. All rights reserved.