DocumentationCommerceAmazon sales channel

Add or verify the Amazon API key

Last update: Mon Jul 24 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Admin
  • Developer

When accessing Amazon sales channel, Commerce 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 in to the Commerce Admin.

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

    If it is your first time accessing Amazon sales channel or if your API key requires updating, the system prompts you through the process.

    img-md
    w-500
    Get and Add the Amazon API Key Prompt

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

    The Commerce accounts page opens in a new browser tab.

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

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

    • If you do not have an account, visit the Commerce account page 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 Commerce account.

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

    img-md
    w-500 modal-image
    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 Commerce Admin. You can open this page manually when you go to Stores > Settings > Configuration, expand Services in the left panel, and choose Magento Services.

  7. Paste the copied key for Production Api key.

  8. Click Save Config. You can now return to Amazon sales channel.

    img-md
    w-600 modal-image
    Adding your API Key in your store configuration

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

    Reaccessing Amazon sales channel triggers Commerce verify and validate your API key and allows you to continue.

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

Next icon Continue to Store Integration

6586dad3c5b6b881a39fa02f