Install Amazon Sales Channel

The Amazon Sales Channel extension installs and adds features to integrate your Magento catalog with Amazon Seller Accounts to sell through the Amazon Marketplace. To review additional information, see the Amazon Sales Channel Marketplace page.

Requirements

  • Magento Instance: Amazon Sales Channel can be installed on instances with Magento Open Source and Magento Commerce versions 2.2.4+ and 2.3.X. We do not support the extension on Magento 2.1 or Magento 1.
  • Magento Web Account: You should have a Magento web account, which is used to create and track an API key.
  • API Key: Get a Amazon Sales Channel API key through your Magento web account. The following instructions include these steps.

Install

Amazon Sales Channel install is a .zip file available from the Magento Marketplace. It includes a composer.json which provides the name magento/amazon-sales-channel and the available version.

  1. Log in with your Magento web account.
  2. Click the Marketplace tab, then click My Purchases.
  3. Locate and select Amazon Sales Channel.
  4. On the extension page, select the version from the drop-down menu.
  5. For the component name and version, click Technical Details.
  6. Click Download.
  7. Export the contents to your Magento root.
  8. Follow all instructions for Extension Installation.
  9. Update the services connector entry in your composer.json file
    • Add the extension’s name and version to your composer.json file:
    • Navigate to your Magento project directory and update your composer.json file.

      1
      
      composer require magento/services-connector:~1.0.3
      
    • Enter your authentication keys. Your public key is your username; your private key is your password.
    • Wait for Composer to finish updating your project dependencies and make sure there aren’t any errors.
  10. After installing, enter an API Key to complete configuration.

Add the Amazon Sales Channel API key

To add the Amazon Sales Channel API key:

  1. Log into the Magento Admin.

  2. On the Admin sidebar, click Marketing. Then under Channels, click Amazon.

    If you need an API Key, the following screen displays.

    Onboarding API Key Verification

  3. Click Sign in to access your Magento web account. The Magento Accounts page loads, displaying the API Portal tab.

    You may need to login with your Magento web account credentials. If you need to create an account, visit here and register.

  4. API keys are available through the API Portal tab. Copy the key.

    If you need to create a new key, enter a description like “Amazon Sales Channel” and click Add. Copy this new key.

    Copy or generate an API Key

  5. Return to the Magento Admin tab and click Add the key on the Amazon welcome screen.

    A store configuration page opens to Stores > Configuration > Services > Magento Services.

  6. On the Api Keys screen, paste the key you copied for Production API Key.

  7. Click Save Config.

  8. On the Admin sidebar, click Marketing. Then under Channels, click Amazon. Magento verifies and validates the entered API key, continuing with onboarding.

See Onboarding Amazon Sales Channel to continue.

Amazon Sales Channel configuration options

You have the following options for configuring Amazon Sales Channel. You do not need to modify these settings to begin onboarding and selling on Amazon. We recommend advanced administrators consider these options.

  1. Log into the Magento Admin.

  2. On the Admin sidebar, click Stores. Then under Settings, click Configuration.

  3. Click Sales Channels, then Global Settings.

  4. For Show Dashboard Chart, set to “Yes” if you want to display the Revenue section on the store’s dashboard screen.

  5. For Clear Log History, indicate the interval for clearing the collected logs. Options include Once Daily, Once Weekly, and Once Monthly (default).

  6. Advanced users recommended: Background Tasks (CRON) Source. All background tasks are handled by CRON jobs using the Magento CRON. Advanced users can change this setting to Command Line (CLI) CRON.

  7. Click Save Config.

Update

  1. Log in with your Magento web account.
  2. Click the Marketplace tab, then open My Profile.
  3. Click My Purchases.
  4. Locate and select Amazon Sales Channel.
  5. On the extension page, select the version from the drop-down menu.
  6. For the component name and version, click Technical Details.
  7. Click Download.

Complete the upgrade following the instructions Upgrade an extension.

Updated