• Contents

Connecting Cin7 to Magento

Last updated 12/02/2021

This article outlines the steps required to connect your Magento and Cin7 accounts.


The below setup requires technical expertise, so we strongly recommend involving your Magento developer. If completed correctly it will take around 10 minutes.

These instructions relate to Magento Community Edition 1.9 and should be similar for previous versions (1.6 - 1.8). Version 2 onwards has a separate process outlined in Connecting Cin7 to Magento 2.

We recommend using a staging site to test on before connecting to your live Magento server. It is also recommended that you connect a new Magento module in Cin7 when switching to your live site so that it does not conflict with the data mapped to your staging site.

The process for connecting the two platforms is as follows:

  • Create Magento API details
  • Add Magento to your Cin7 Account
  • Connect the two accounts
  • Install Plugins to Magento
  • Add cin7_import attribute

Each step is outlined in detail below.

Create a Magento API role and user

Before you can connect Magento to your Cin7 account, you must first obtain Magento API details. To do this:

  1. Log in to Magento with your Administrator Account.
  2. Create an API Role:
    System > Web Services > SOAP/XML-RPC Roles > Add New Role 
    Fill in the fields.
    Under Role Resources set Resource Access to All.
  3. Create an API user:
    System > Web Services > SOAP/XML-RPC Users > Add New User.
    Fill in the fields.
    Under User Role select the role created in previous step.
    Make note of the details as you will need them later.

Adding Magento to your Cin7 account

Once you have retrieved this information, you will need to add the Magento module to your Cin7 account.

To add the module:

  1. While logged in as an Administrator, from the left navigation select App Store.
  2. From the App Store, select Ecommerce then Magento.
  3. Select Request App Installation.

Cin7 Customer Success will receive the installation request and provide an update once completed.

Connecting the two accounts

Next, connect the two accounts using the details obtained earlier.

  1. While logged in as an Administrator, from the left navigation, select Integrations then Magento.
  2. Select Settings and go to the Connect tab.
  3. Insert your Web Address, API Username and API Password in the fields provided. These are the details created earlier.
  4. Ensure you select "https" if you are using SSL and make sure to remove this from the Web Address field.
  5. If your Magento installation is not at the root of the server, you can change the API path setting to custom and enter the correct path.
  6. Select Save Connection Settings.

Install Plug-ins

A few plug-ins to your Magento installation must be installed into download orders. To assist in the process, Cin7 provides a script that will install all necessary plugins. For more information on what is installed, or to do this manually, see the Installing Magento Plugins Manually Help article for additional information.

  1. Log in to your Magento Administrator Account.
  2. Set the below
    System > Configuration > Developer > Enable symlinks > Set to Yes  .
  3. Download the install file - cin7installer.zip 
  4. Extract the contents, which is a single file called cin7installer.sh
  5. Copy or move the file to your Magento installation directory. 
    This is usually the public_html folder where you can see index.php file and app directory.
    We suggest any ofthefollowingmethods to copy the file:
    • use FTP to copy the file
    • if you can SSH into your server, run "vim" (or any editor) and copy the cin7installer.sh content in a new file with the same name and extension, or
    • if you are familiar with UNIX you may use SCP as follows: 
      scp cin7installer.sh your_username@yourhostingurl:/magentodirectory
  6. SSH to your server and go to the Magento directory where you can see the cin7installer.sh file you copied in the step above.
    (In the next two steps, if you have writing and execution privilege, you may have to remove "sudo" from your commands).
  7. Run this command:
    sudo chmod +x cin7installer.sh
  8. Run Cin7 installer.sh with the following command:
    sudo ./cin7installer.sh
  9. In your Magento Admin Panel go to System > Cache Management > Select All > Submit to refresh the Magento cache.
  10. If the installation has worked you will see a .modman directory and geterrors.php file in the Magento installation directory.
    The cin7installer.sh will take care of all dependencies and installs for the required packages.
    You should also see API Import under Services in System > Configuration

Insert a new attribute

Cin7 requires an additional attribute "cin7_import" to track which products have been successfully updated.

Make this attribute Global and Text insert into all attribute sets.


Can we have API updates into a git repository?

Yes but is up to the developer's discretion as Cin7 does not support this.

Does the installation script support CentOS 6.6?

No. The current installation script is based on Debian Linux, like Ubuntu. You can install the Cin7 plugin manually, however.

Is TLS supported?

HTTP and HTTPS (SSL) are supported by the API but not TLS.

Will the integration work with other Magento addons?

The Cin7 Integration is set up to work with a default environment in Magento. Extensions are not tested for compatibility except the two required for the actual integration.

An extension could be compatible if it doesn't add any complex data to the order or products data required by Cin7. For example, if you had a Magento add-on that had an extra field in the product that you wanted to include in Cin7, it should be compatible.  However, if you had an add-on that produced a many-to-many relationship between multiple products and you required Cin7 to support the same, it most likely would not be supported.