Magento Account Integration

Overview

Magento, currently known as Adobe Commerce, is an e-commerce platform used to build and manage online stores. It offers features for catalog management, order processing, payment integration, and customer management. With its flexibility, scalability, and extensive customization options, Magento empowers you to create tailored and engaging online shopping experiences for your customers.

You can integrate Magento into Sellercloud through plugins using APIs. While you can integrate either version of Magento, overall, Magento 2 offers a more modern, scalable, and feature-rich service than Magento 1. In addition, at this time, Magento 1 is no longer supported by Adobe.

The following features are supported by the integration:

• Automatic export from Sellercloud to Magento:
  • Products
  • Inventory/Prices
  • Order Tracking
  • Order Cancellations and Refunds
• Automatic import from Magento to Sellercloud:
  • Orders
  • Active Listings
  • Categories
  • Attributes
  • RMAs

This is a high-level overview of the integration process:

1. SOAP is deployed on the Magento installation by a developer to enable communication between the plugin and the Magento system. CRON is also set up on the installation.
2. Sellercloud’s Magento plugin is deployed by someone with access to the Magento site’s FTP (e.g., site admin, developer) or Sellercloud Support.
3. Commands are executed via SSH to ensure the proper functioning and optimization of the Magento installation.
4. A Magento admin user with full access to the Magento Web Services (API) is created, and the API key and password are retrieved.
5. The Magento API credentials are entered into Sellercloud, and the integration is enabled.
6. Any other Magento Account Settings are configured in Sellercloud.
7. Products, Listings, and Orders are managed from Sellecloud.

Prerequisites

The prerequisites for setting up the integration differ depending on your version of Magento.

Magento 2

To install the Magento 2 plugin:

1. Request the plugin from Sellercloud Support.
2. Upload the plugin to a remote server, placing Sellercloud’s folder (in the plugin zip file) under /app/code.
3. Enable the module with one of the two methods below.
   1. Go to Admin > Store > Configuration > Advanced > Advanced > Enable Sellercloud_Scm2
   2. In the FTP, edit /app/etc/config.php by entering 1 for Sellercloud_Scm2.
4. Run a setup upgrade: 
   1. Log into your terminal via SSH access. You typically use an SSH client like PuTTY or Terminal on macOS/Linux to establish this connection.
   2. Run the command cd public_html to go to your Magento root directory. This is where all the Magento files and directories are located.
   3. Run the command php bin/magento setup:upgrade to upgrade the Magento application, including database schema and data structures. This is necessary after installing new extensions or making changes to the codebase to ensure any changes made are properly reflected in the Magento system.
5. Run the command php bin/magento setup:di:compile to compile Magento’s dependency injection configuration and generate all necessary code for the application. This is necessary when any modified code in the extension is uploaded to ensure that the changes are reflected properly. Compilation may take some time, depending on the size and complexity of the codebase.
6. Clean the cache with one of the two methods below:
   1. Go to Admin > System > Cache Management.
   2. Running the command php bin/magento:cache:clean.

Web services are a set of Web APIs that can be accessed and executed on a remote system. To do that, you must grant the required permissions to enable access and update information on Magento. The first step is to create a new role and then assign this role to a new user. 

To create a new user and grant the required permissions:

1. Log into the Magento2 admin portal.
2. Go to System > User Roles, and create an admin role with full access.
3. Create a new user from System > All users.
4. Assign an admin role you have created to a new user.
5. Go to System > Integrations
6. Adjust the integration settings for this user. You will enter the username and password (on the bottom) into your WebService Username (API Key) and WebService Password (API Password) settings in Sellercloud later.
7. On the same page, click the API, and select All from the dropdown.
8. Save the changes.

Next, continue with the steps in the Client Settings section before you start setting up the integration in Sellercloud.

Magento 1

To install the Magento1 plugin:

1. Request the plugin from Sellercloud Support.
2. Upload the _import folder of the plugin to http://yoursite.com/ so that http://www.yoursite.com/_import is accessible.
3. Upload the _export folder of the plugin to http://yoursite.com/ so that http://www.yoursite.com/_export is accessible.
4. Log into FTP using an Admin account.
5. Right-click a folder or a file name, select its Permissions option, and enter the correct numeric value from those listed below:
   1. The _import and _export folders must have execution rights set to 0775 or 0777.
   2. The files in the _import and _export folders must have execution rights. 0445 is preferred; otherwise, 0777 is usable.
   3. The _import/log folder should have the write permission of 0777.
6. Run http://www.site.com/_import/ (if your URL is http://www.site.com) in your browser to test it. Full authentication is required in the request URLs.

Web services are a set of Web APIs that can be accessed and executed on a remote system. To do that, you must grant the required permissions to enable access and update information on Magento. The first step is to create a new role and then assign this role to a new Soap/XML-RPC user.

To create a new user and grant the required permissions:

1. Log in to the Magento1 admin portal.
2. Go to System > Web Services > Soap/XML-RPC-Users.
3. Click Add New User.
4. Complete the required fields and create a password to enter in the API key Save the password, as you will need to use it in Sellercloud.
5. Click Save.
6. Go to System > Web Services > Soap/XML-RPC-Roles.
7. Click Add New Role.
8. Give a name to the new role and enter the admin password.
9. From the left navigation menu, select Role Resources.
10.  Select All from the Resource Access dropdown.
11. Click Save.
12. Assign a newly created Role to the new user you have created in steps 1-5.

Next, continue with the steps in the Client Settings section before you start setting up the integration in Sellercloud.

Client Settings

The following Client Settings control what orders will be imported to Sellercloud:

• Magento: Enable Pending Orders – If this setting is enabled, Sellercloud will import orders with the Pending status from Magento. This status refers to a new order that does not include a customer payment, an invoice, or a tracking number at the time of import. In short, this is the initial status that the channel assigns to an order. When you enable the setting for the first time, we will import all pending orders with the next service run. If the setting is disabled, Sellercloud will only import Charged or Invoiced orders into Sellercloud and skip pending ones.
• Do Not Create Magento Orders With Review Status – If this setting is enabled, Sellercloud will not import orders with the Review status from Magento.
• Do Not Create Magento Unpaid Orders – If this setting is enabled, Sellercloud will not import unpaid orders from Magento.
• Only Create Magento Orders If Older Than X Hours – If this setting is enabled, Sellercloud will only import orders older than the number of hours you select.

Product Identifiers

In Magento, each product can have two identifiers: an ID, which contains only digits, and a SKU, which can be alphanumeric. The API Sellercloud uses to update products on Magento can work either with the ID or SKU, but not both.

The MagentoProductIdentifierType App Setting determines which identifier Sellercloud will be used. Misconfiguring it may result in Sellercloud being unable to update products on Magento. Contact Sellercloud Support for assistance with the setting.

Magento may try to use the ID instead of the SKU if the SKU contains only digits. To resolve this issue, use the code below to update one of the Magento files:

Integrate Magento

To integrate Magento:

1. Go to Company Settings.
   When you have multiple Companies, each company can be connected to a different Magento website.
2. Click Toolbox and select Magento > General Settings.
3. Check Magento Enabled.
4. Enter the Magento Store URL used to navigate to your Magento store and add the suffix api/v2_soap/index/. For example, http://www.cellphonemate.net/api/v2_soap/index/.
   
   If your domain starts without the www prefix, the API URL will need to reflect that, like http://cellphonemate.net/api/v2_soap/index/. Also, try to navigate to the URL in the browser to test that it isn’t redirected to another address. For example, if it redirects you to an https address, then something needs to change on the Magento side before it will work.
5. Enter the Magento Admin URL.
6. Enter the credentials to the Web Service API into the WebService Username (API Key), WebService Password (API Password), and Confirm Password fields.
7. Select your Magento Version.
   
8. Magento can manage multiple stores from a single installation, and each is assigned an ID. 
   1. The Default Website field refers to the main website that is being managed by your Magento installation. 
   2. To connect only specific websites, enter a comma-separated list of website codes (alphanumeric, not the website ID) into the WebSites ID List.
   3. To connect only specific stores, enter a comma-separated list of store codes (alphanumeric, not the store ID) into the Store ID List.
      
9. To set up the order import:
   1. If you connect only specific stores or websites with the WebSites ID List and Store ID List settings, orders will be imported based on that; otherwise, all orders will be imported. 
   2. Optionally, enable Order Download Limit Date and set a Limit Date to only download orders starting from a specific date.
   3. Optionally, in the Download Orders with Status field, select the Magento order statuses that Sellercloud is allowed to import. Here, you can allow statuses like Review, Hold, Processing, and more.
   4. Additionally, make sure you check out the Client Settings section.
10. Configure the remaining Magento Account Settings according to your needs. 
11. Click Save.
12. Click Select Action and select the Test Settings option to verify your credentials and settings. Do not skip this step.
    
13. Click Select Action and select Download Attribute Set. This will import the Magento Attribute Set configurations into Sellercloud. You do not need to select anything here. You will be able to select the attribute set at the product level.
    

Next, learn how to manage your Products, Listings, and Orders from Sellecloud.