Amazon Connector for Magento 2 integrates the Amazon store with Magento 2 store. This module enables the store owner to import products, stock, and orders from the Amazon store to Magento 2 store.
Also, the store owner can also export his products from Magento 2 to the Amazon store.
Magento 2 (Adobe Commerce) Amazon connector performs real-time updates of the synchronized product price and quantity on the Amazon store.
The store owner can also connect multiple Amazon stores with the Adobe Commerce store.
Note:
- This module will work for professional seller accounts at Amazon seller central only.
- This module is based on Amazon Selling Partner API (SP-API).
- The Amazon Connector module also works with Adobe Commerce Cloud Edition.
- Also, to manage shipment fulfillment you have to buy a separate module Amazon MCF (FBA) for Magento 2
Check a brief overview of the Amazon connector plugin configuration –
Features-Amazon Connector for Magento 2
- Synchronize the Magento 2 products to Amazon and vice versa using Amazon connector.
- The admin can create multiple price rules to update the price of the synchronized products automatically.
- Import Amazon orders to Magento 2 store.
- Admin can set a default category for the imported products in the Adobe Commerce store.
- Set default quantity and weight values for imported products in the Magento 2 store.
- Revise the changes for the product’s price and quantity occur in Magento 2 store, the results will reflect on the Amazon store.
- Admin can import Simple as well as Configurable product types.
- Admin can export simple and configurable product types.
- While importing the product from Amazon the admin can choose the status of the products.
- Admin can map Amazon product attribute to Magento product attribute.
- The product information like base image, name, price, and quantity gets imported along with the product.
- Can import multiple images of the Amazon imported product to the Adobe Commerce store.
- The product information like SKU, price, images, and quantity get exported along with the product.
- Set the default store view and order status for the imported order in the Magento 2 store.
- The admin can manage the imported orders through Amazon seller central account only.
- Orders from the Amazon store with status shipped, unshipped, and partially shipped get imported to the Magento 2 store.
- The admin can connect multiple Amazon Accounts.
- Synchronized Amazon product work like Magento products.
- Admin can fetch the order between the desired date range.
- The orders will fetch automatically via Cron and if order items do not exist in Magento, they will automatically be created.
- The exported product status will be updated automatically via Cron.
- Admin can export Magento products as FBA products at Amazon.
- Admin can update Magento product as FBA product at Magento.
Note-
However, the only following list of Amazon attributes can be mapped with the Magento attributes-
- Brand,
- Description,
- Manufacturer,
- MfrPartNumber,
- Price,
- Product Type,
- Product Value,
- SKU,
- Title and
- qty can map in the module.
Installation – Amazon Connector for Magento 2
Customers will get a zip folder then they have to extract the contents of this zip folder on their system. Once the customer extracts the folder it has an src folder, inside the src folder you have the app folder. After that, you need to transfer this app folder into the Magento2 root directory on the server as shown below.
After the successful installation, you have to run these commands in the Magento2 root directory.
First command – php bin/magento setup:upgrade
Second Command – php bin/magento setup:di:compile
Third Command – php bin/magento setup:static-content:deploy
Fourth Command – composer require guzzlehttp/guzzle:*
Fifth Command – composer require league/csv:^9.5
Sixth Command – composer require spatie/array-to-xml:*
After running the commands, you have to flush the cache from the Adobe Commerce admin panel by navigating through->System->Cache management as shown below.
Multi-Lingual Configuration
Language Translation
Similarly, if you need to do the module translation, please navigate to the following path in your system app/code/Webkul/AmazonMagentoConnect/i18n.
Open the file named en_US.CSV for editing as shown in the below screenshot.
Once you have opened the file for editing. Replace the words after the comma(,) on the right with your translated words.
After editing and translating the CSV file, you need to save the translated file name according to your region language and country code such as – de_DE.CSV. Then upload the translated file to the same folder from where you have obtained it. Now your module translation is complete.
How to create/get required credentials for the Amazon connector module
1. Registering as a developer
You must register as a Selling Partner API developer before you can register your Selling Partner API application. The way you register as a developer varies slightly depending on the type of application that you create. We will use the following:
- Private seller applications: Applications for sellers that are available only to your organization, and are self-authorized.
To register as a developer (for private seller applications)
- Sign in to Seller Central using the credentials that you want to associate with your developer account.
- In the Partner Network menu, click Develop Apps.
The Developer Central page appears. - If you have not yet completed a developer profile for this selling account, click the Proceed to Developer Profile button. Otherwise, click the Your Developer Profile link.
- Complete the form. In the Data Access section, in the dropdown box, select My organization sells on Amazon, and I only want to integrate to manage my own business only.
Note: If you want to import the buyer information and shipping address with the orders, then you must have access to the customer’s Personally Identifiable Information (PII). For this, you need Approval for the roles that are required to access buyer information and/or shipping address information. These are:
- Direct-to-consumer shipping. Required to access shipping address information.
- Tax remittance. Required to access buyer information.
- Tax invoicing. Required to access buyer information.
2. Checking the status of your request to register as a developer
After you have submitted your request to register as a developer, Amazon evaluates the information provided and approves or denies your request. If denied, you can address the reason for the denial and then resubmit your Developer Profile.
The following procedures show you how to check the status of your request to register as a developer, depending on the type of application you want to create.
To check the status of your request (private seller applications)
- Sign in to Seller Central with the credentials that you used when you registered as a developer.
- In the Partner Network menu, click Develop Apps.
The Developer Central page appears. - Follow the instructions in the Your developer registration is under the review banner. The banner will change to reflect the status of your application.
After we have registered you as a developer, you can create and configure IAM policies and entities. To view your developer information, see Viewing your application information and credentials.
3. Creating and configuring IAM policies and entities
The following steps explain how to create and configure IAM policies and entities with the end goal of creating an IAM role that you provide when you register your application. In this workflow you create an IAM user (with an AWS STS policy attached) that assumes an IAM role that has permissions to call Selling Partner API.
Steps:
Step 1 Create an AWS account
Step 2 Create an IAM user
Step 3 Create an IAM policy
Step 4 Create an IAM role
Step 5 Add an AWS Security Token Service policy to your IAM user
Step 1. Create an AWS account
You need an AWS account because the Selling Partner API security model uses AWS authentication credentials. If you’re not already an AWS customer, you can create a free AWS account. For more information, see AWS Free Tier.
Step 2. Create an IAM user
You need to create an IAM user to get AWS keys to authenticate calls to the Selling Partner API. We recommend creating a new IAM user exclusively for this purpose. Use the IAM user to assume the IAM role that you create in Step 4.
To create an IAM user
- If you are not already signed in, sign in to the AWS Management Console and open the IAM console at console.aws.amazon.com/iam.
- In the navigation pane on left, click Users and then click Add user button.
- Enter a user name for the new user.
- Select Programmatic access and then click the Next: Permissions button.
5. On the Set Permissions page, accept the defaults and click the Next: Tags. You will set permissions when you create an IAM role.
6. On the Add tags (optional) page, add optional tags if you want them, and then click the Next: Review button.
7. On the Review page, review the choices you have made. You can ignore the This user has no permissions warning. You will set permissions when you create an IAM role. When you are ready to proceed, click the Create user button.
The AWS access key ID for your new IAM user is displayed.
8. Click Show to view the AWS secret access key. To save the AWS access key, click Download .csv and then save the file to a safe location.
Important:
This is your only opportunity to view or download your AWS secret access key, which you will need to authenticate your calls to the Selling Partner API. Save the AWS access key ID and AWS secret access key in a safe and secure place. You will not have access to the AWS access key again after this step. If you lose your AWS secret access key you will need to create a new IAM user with its own new set of keys.
9. Click Close.
10. In the User name column, click your new IAM user and make a note of the User ARN. You will need it in Step 4. Create an IAM role.
11. Save your User ARN. You will need it:
i. In Registering your Application
ii. In Step 4. Create an IAM role.
Note: The created AWS access key ID and AWS secret access will be used for module configurations: Access Key of AWS IAM User, Secret Key of AWS IAM User
Step 3. Create an IAM policy
This IAM policy defines permissions to make calls to the Selling Partner API. You will attach it to the IAM role(that you create in Step 4. Create an IAM role) and the IAM user(that you created in the previous step).
Note: If your AWS account leverages AWS Organizations you must ensure that your organization level policy allows access to the Selling Partner API. For more information, refer to Managing AWS Organizations policies in the AWS documentation.
To create an IAM policy
1. Sign in to the AWS Management Console and open the IAM console at console.aws.amazon.com/iam.
2. In the navigation pane at the left, click Policies.
If this is your first time choosing Policies, the Welcome to Managed Policies page appears. Click Get Started.
3. Click the Create policy button.
4. Click the JSON tab.
5. Paste the following code into the text box, replace the existing code, and then click Review policy.
{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "execute-api:Invoke", "Resource": "arn:aws:execute-api:*:*:*" } ] }
6. On the Review policy page, type a Name and a Description (optional) for the policy that you are creating.
7. Review the policy Summary to see the permissions that are granted by your policy, then click the Create policy button.
Your new IAM policy appears in the list.
Step 4. Create an IAM role
Now, Create an IAM role that trusts the IAM user that you created in Step 2. Create an IAM user and has permission to call the Selling Partner API.
To create an IAM role
1. If you are not already signed in, sign in to the AWS Management Console and open the IAM console at console.aws.amazon.com/iam.
2. In the navigation pane on left, click Roles and then click Create role button.
3. On the Create role page, click Another AWS account.
4. In the Account ID box, enter the account identifier for the AWS account in which you created your IAM user in Step 2. Create an IAM user, and then click the Next: Permissions button.
5. On the Attach permissions policies page, under the Policy Name, select the policy that you created in Step 3. Create an IAM policy, and then click Next: Tags.
Tip: Click Filter policies and then select Customer managed to narrow your choices.
6. On the Create role page, enter a role name in the Role name box, an optional role description in the Role description box, and then click the Create role button.
7. On the Add tags (optional) page, add optional tags if you want them, and then click the Next: Review button.
8. Under Role name, click the name of your new role.
The Summary page appears
9. Save your role ARN. You will need it:
i. In Step 5. Add an AWS Security Token Service policy to your IAM user.
Step 5. Add an AWS Security Token Service policy to your IAM user
Adding AWS Security Token Service (AWS STS) policy to your IAM user enables you to request temporary AWS access keys that you can use to authenticate your requests to the Selling Partner API. These credentials expire after a set period of time, helping you to control access to your AWS resources.
1. If you are not already signed in, sign in to the AWS Management Console and open the IAM console at console.aws.amazon.com/iam.
2. In the navigation pane on left, click Users and then click the user that you want to add the AWS STS policy to. In this workflow, choose the user you created in Step 2. Create an IAM user. You might choose a different IAM user for other use cases.
3. On the Permissions tab, click Add inline policy.
4. On the Create policy page, click Choose a service.
5. Click the STS service.
Tip. Type STS in the search box to narrow your choices.
6. Click the arrow next to Write to expand it.
7. Select AssumeRole.
8. Click the arrow next to Resources to expand it, and then click Add ARN.
9. In the Add ARN(s) dialog box, enter the role ARN from Step 4. Create an IAM role in the Specify ARN for role box, click Add, and then click the Review policy button.
10. On Review policy page, enter name for your policy in the Name box. Review the choices you have made. If you are ready to proceed, click Create policy button.
11. Again choose user you created in Step 2. Create an IAM user. Now, On Permissions tab, click “Add Permissions“.
12. Now, click on “Attach existing policies directly”. Then, select policy that you created in Step3. Create an IAM policy, and then click “Next: Review”.
13. Click on “Add Permissions“.
4. Registering your application
Before you register your application, create and configure your IAM policies and entities. We will register applications for
- Private seller applications: These are seller applications that are available only to your organization, and are self-authorized.
The following procedures show you how to register your application.
To register your application (for private seller applications)
- Sign in to Seller Central using the credentials that you used to register as a developer.
- In the Partner Network menu, click Develop Apps.
The Developer Central page appears. - Click the Add new app client button.
The App registration page appears. - Complete the form.
Important: When registering your application, the IAM ARN that you provide must be for the IAM User to which you attached the IAM policy from Step 3. Create an IAM policy. Since you register your application using your IAM user, be sure that the IAM policy is attached to it. Otherwise, your calls to the Selling Partner API will fail.
5. Viewing your application information and credentials
After you register your application you can view information about your application, as well as your Login with Amazon (LWA) credentials. Here, we have used :
- Private seller applications: These are seller applications that are available only to your organization, and are self-authorized.
The following procedures show you how to view your application information and credentials, depending on the application type.
To view your application information and credentials (for private seller applications)
- Sign in to Seller Central using the credentials that you used to register as a developer.
- In the Partner Network menu, click Develop Apps.
The Developer Central page displays information about your application(s), including the IAM ARN associated with them. - Click View under LWA credentials for the application you want.
Your LWA client identifier and client secret for that application appear. You will need these credentials in module configurations: App Client ID from Seller Central, The corresponding Client Secret
Self authorization
When you create a private application for your own organization you can self-authorize it to access your account information. Before doing this you must register as a developer and register your application. You can self-authorize your application in draft status; there is no reason to publish a private application.
To self-authorize your application (seller application)
- Sign in to Seller Central using the credentials that you used to register as a developer.
- In the Partner Network menu, click Develop Apps.
The Developer Central page appears. - For the application that you want to authorize, click the arrow next to the Edit App button, and then click Authorize.
The Authorize application page appears.
Note. If your selling partner account is merged with accounts in other regions, you will see an Authorize app button for each of your merged accounts.
4. Click the Authorize app button for each selling partner account that you want your application to access. The Marketplaces column indicates the marketplaces in which an account is active.
A Login with Amazon (LWA) refreshes token appears with every Authorize app button that you click.
Note:
1. Keep this LWA refresh token as this will be used in module configuration: Refresh Token
2. If you click on Authorize app button multiple times, a new refresh token is generated each time. Generating a new refresh token does not invalidate previous refresh tokens.
Module Configuration-Amazon Connector for Magento 2
After the installation of the Amazon Connector, you can configure it by navigating through->Store>Configuration>Amazon Connector.
Product Settings
Default Attribute Set: The admin can select the default attribute set that will be used for creating the category attributes in the Amazon connector.
Product Description With HTML: Choose whether you want to import the product with HTML description content or not.
Mapping Info
Marketplace-wise Default Account: Here, select the marketplace-wise default account by tapping the Add button as required.
Note – First, set up the amazon accounts. Then, you have to map the default accounts to be used with respective marketplaces. The mapped account will be used as default while fetching some common data for that marketplace like category attributes using the amazon API.
Manage Amazon Accounts – Admin End
After successful configuration, the admin can add Amazon account credentials. The admin can navigate to “Amazon Magento Connect > Manage Amazon Accounts” for managing and adding Amazon Accounts.
After clicking on Manage Amazon Accounts, the following page will open showing an Amazon accounts list with the Store Name, Amazon Marketplace, and Seller ID.
Here, the admin can:
- Edit – edit the Amazon account details by clicking on this link.
- Delete – remove the existing Amazon account from the list.
- Add Amazon Seller Account – add/create new Amazon account.
Add Amazon Seller Account
After clicking on “Add Amazon Seller Account“, the admin will navigate to the New Amazon Account page. The admin has to select Marketplace then provide Seller Id, Access Key Id, and Secret Key.
After that, admin has to click on “Save and Continue Edit” button for saving the information and continue to edit the Amazon account details.
Here, the admin will enter :
- Store: Enter the store name and this will not be changed once got saved in the Magento 2 store.
- Attribute set: Select the attribute set for the imported product.
- Marketplace: Select the Marketplace from the drop-down list.
- Enter the Seller Id, Access Key Id, and Secret Key which the admin has received while creating the Amazon Seller Central account.
Once the admin clicks on “Save and Continue Edit” button, the following options become visible as per the below image.
Amazon General Configuration

- Default Category: Select the Default Category of Magento 2 store for assigning to Amazon products.
- Default Store View – Select Default Store View of the Magento 2 for order syncing.
- Product Create: Select the product creation type such as “with variation” or “without variation”.
- Default Website: Select Default Website.
- Price Rule Applicable For -Select the product sync type either Import or Export option for which you want to apply the Amazon Price Rule. If it’s selected for Import Products then will work in a reverse manner for Export Products or vice versa.
For Example –
Suppose “Amazon Price Rule Applicable For” is set to Import Products. And as per the price rule, the price value of the imported products will get increase by value 10 more. But the price value of the exported products will be reduced by value 10.
- Shipped Order Status – Select the order status for Amazon order in Magento.
- Unshipped Order Status – Select the order status for Amazon order in Magento.
- Partially Shipped Order Status – Select the order status for Amazon order in Magento.
- Export Product Image –
- Get All Images Of Product – If this option is selected as a Yes, then you will get all of the images of the product. If the option is selected as a No, in that case only one image would get fetched.
For that, you need to sign up as an Amazon Associate and get the keys.
- Product Deleted From Catalog – , then the product will also be deleted from the Magento catalog.
- Default Qty – Default quantity will be assigned to the product when Amazon product does not have quantity.
Manage Product Price Rules-Amazon Connector for Magento 2
The admin can easily update the price of the synced products automatically. For this, the admin needs to create the Price Rules by navigating to Amazon Magento Connect > Amazon Product Price Rules.
After clicking on Manage Product Price Rules, the following page will open showing the Price Rules list.
Here, the admin can:
- Edit – edit the Price Rule details by clicking on this link.
- Delete – remove the existing Price Rule from the list.
- Add Rule – add/create new Price Rule.
Add Rule
After clicking on “Add Rule“, the admin will navigate to the New price rule page as per the below image.
Here, the admin will:
- Product Price From – Select the minimum price for the price rule to be active from.
- Product Price to – Set the maximum price for the price rule to get inactive.
- Operation Type – Select the operation type as fixed or percentage.
- Operation – Select the operation as increase or decrease.
- Price – Enter the amount.
- Amazon Store – Select the store.
- Status – Enable/Disable the price rule.
HOW WILL IT WORK?
Suppose the price of the synchronized product is 100 and admin has configured –
- Operation Type: Percentage
- Operation: Increase
- Price: 10
Then 10% of 100 will be added to the original price of the product ie; (10 % 100) + 100 = 10+100 = 110.
Else if the Admin has configured –
- Operation Type: Fixed
- Operation: Decrease
- Price: 10
Then 10 will be decreased from the original price of the product ie; (100-10) = 90.
Map Attribute with Amazon-Amazon Connector for Magento 2
Under “Amazon Magento Connect > Attribute Map” the admin can map the “Amazon Product Attribute” with the “Magento Product Attribute”.
By clicking Attribute Map the following page will be open for attribute mapping.
Here, by clicking “Add Option” a new option will be added then the admin can select the “Amazon Product Attribute” from the dropdown then its respective “Magento Product Attribute”.
Category Map-Amazon Connector for Magento 2
Under “Amazon Magento Connect > Category Map” the admin can map the “Amazon Parent Category” with the “Magento Category”.
By clicking Category Map for Import the following page will be open for category mapping.
Here, by clicking “create mapping” a new page will open. Hence, the admin has to select the “Amazon Marketplace” from the dropdown then its respective “Amazon category” will be shown. After that, the admin can select the “Amazon parent category” from the dropdown and then its respective “Magento category”.
After that, click on the save mapping button.
When we map the categories in the “Category Map” option, then first we have to add Amazon credentials in Magento and have to follow the below steps for fetching the category data for the associated Amazon marketplace.
After that, the categories data will be shown in the fields for the selected marketplace(for which the amazon seller credentials are added on Magento.
Add Products-Amazon Connector for Magento 2
While adding a new product to the Magento store, the admin will see a new tab “Amazon Product Identifier”. Here, the admin can select any unique identifier from the drop-down list as per the requirement.
After that, the admin needs to provide a genuine Unique Identification Code which will be used while exporting the Adobe Commerce products to the Amazon shop.
Import Product From Amazon-Amazon Connector for Magento 2
The admin can import the desired products from the Amazon store to their Magento store.
To import products from the Amazon store, the admin will click on Import Product From Amazon tab as per the image.
Here, the admin will:
- Select Import Product: There is an option available where the admin can import products as per their status over Amazon.
Admin can choose All products to import, Active products or Inactive products to import from Amazon.
- Generate Report Id: This creates the seller’s account report which is used to send as a request to import the products from Amazon store.
- Import Product From Amazon: when clicking on “Import Product from Amazon”, the temporary product data is created and stored in Magento 2 database.
- Create Imported Product: It is used to create/adds the imported products to Magento 2 store.
The admin can check the imported products by navigating to the store product category which has been set as default category for the imported product from Amazon while module configuration.
HOW TO CHANGE DEFAULT CATEGORY OF THE IMPORTED PRODUCTS:
The admin can change the default category of imported products. For this, the admin will click on Import Product From the Amazon tab as per the image.
To change the default category of the imported products, the admin will do the following:
- Select one or more than one product from the imported products list.
- Select Assign to Category option from the Actions drop-down list. This will display the Category field and Submit button beside the Actions drop-down list.
- Select the desired category from the Category drop-down list.
- Proceed further by clicking on the Submit button.
Also, the admin can check the newly assigned category of the product by navigating to the category which has been assigned to the product.
NOTE:
- The product information like base image, name, price, and quantity get imported along with the product.
HOW TO CHANGE THE FULFILLMENT CHANNEL OF PRODUCTS:
The admin can change the Fulfilment Channel of the imported products. For this, the admin will click on Import Product From the Amazon tab as per the image.
In order to change the Fulfillment Channel of the imported products, the admin will do the following:
- Select one or more than one product from the imported products list.
- Select Update as FBA To Amazon or Update as FBM To Amazon option from the Actions drop-down list as per the requirement.
- Proceed further by clicking on the Submit button.
As per the above image, the product’s Fulfillment Channel will be updated.
Import Order From Amazon
In order to import the orders from the Amazon store, the admin will click on Import Order From Amazon tab as per the image.
Here the admin will:
-
Import Order from Amazon:
when clicking on the “Import Order from Amazon” button, an Amazon Order Range page will open as per the image.
In addition, the admin can enter the date and time range. Proceed by clicking on the submit button and the temporary order data is created and stored in Magento 2 database.
-
Create Imported order in Store:
It is used to create/add the imported orders to Magento 2 store.
After that, a list will be generated for the imported orders with details like Amazon Order Id, Order Status, Sync Date, and Purchase Date.
The admin can check the details of imported orders by navigating to Sales>Orders. But the admin cannot manage the imported orders from the Magento 2 store ie; the admin cannot create an invoice, shipment, cancel the order and make a refund.
The admin can manage the imported orders through Amazon seller central account only.
Note –
- A cron is set for this module. So, for auto-synchronization of orders, the admin has to configure the cron on Magento 2 server. This will automatically import the orders from Amazon store to Magento 2 store after every one hour.
- The admin will not get any email notifications for any order placed on the Amazon store for the admin products. However, the admin needs to check those orders normally by navigating to Sales > Orders after importing them.
Export Product To Amazon
The admin can export the Magento store products to Amazon shop. To do so, the admin will click on the “Export Products To Amazon” option under Amazon Account Information.
In order to export the products to the Amazon store using the Amazon connector, the admin will:
- Select the products which the admin wants to export to the Amazon store.
- Then select the “Export as FBA To Amazon” or “Export as FBM to Amazon” option from the “Action” drop-down list.
- If selected as “Export as FBA To Amazon” then the product will be exported as FBA (Fulfillment by Amazon) product.
- If selected as “Export as FBM To Amazon” then the product will be exported as FBM (Fulfillment by Merchant) product.
- Proceed further by clicking on the “Submit” button which gets visible when selecting any of the options from the “Action” drop-down list. This will navigate the admin to the “Run Profile” page as per the image.
Once the execution is completed, the admin will click on “Back” button to navigate back.
Then, the admin will go to his Amazon seller central account page and navigates to INVENTORY>Manage Inventory.
Here, the admin can check the exported product after 15 minutes because the process of exporting products take 10-15 minutes to reflect the exported products on the Amazon store.
In addition, the admin can click on the “Edit” button to edit the product details.
Notes:
- The product information like SKU, price, and quantity get exported along with the product.
- A cron is set for this module. So, for the auto status update of exported products, the admin has to configure the cron on Magento 2 server. This will automatically update the status of exported products whether the products are exported to the Amazon store successfully or not.
- For exporting products, the unique identification code of products must pre-exist in Amazon’s seller central catalog, newly assigned unique identification codes to products may not be exported.
That’s all for the Amazon Connector for Magento2 If you have any queries regarding the plugin, please contact us at Webkul Support System.
You can also check our complete Magento 2 extensions.
Current Product Version - 4.0.9
Supported Framework Version - Magento 2.0.x, 2.1.x, 2.2.x,2.3.x, 2.4.x
Be the first to comment.