Magento 2.x integration guide

// Contents

Magento 2 Integration features
Installation requirements
Downloading the extension
Connect the extension to ChannelEngine
Setup and activate the Magento 2 plugin in ChannelEngine
Product data/stock
Shipments, cancellations & returns
Troubleshooting issues & frequently asked questions

// Introduction

To connect your Magento 2 shop to ChannelEngine, you can install our Magento module. This guide will explain how to install the plugin after downloading the extension. Our Magento 2 extension is fully reliant on Magento 2's own API, which has the big benefit that we do not have to do frequent updates of the extension because it uses Magento's internal code. The downside is that some data can only be retrieved by using 

// Magento 2 integration features

Supported Not supported
Product data External fulfillment orders
Orders Returns (only supported by Magento commerce cloud / Enterprise editions)
Cancellations (merchant)  

// Requirements

There are several requirements to install the ChannelEngine Magento extension:

  • Magento 2.0 or higher (2.3 or higher is recommended)
  • Access to the Magento admin

// Downloading the extension

You can find the Magento extension in its various forms here. Select the package/method you want to use and download it.

An easy guide to installing a Magento plugin as a zip file can be found here.

// Integrate with ChannelEngine

Our Magento 2 module uses the new Magento 2 integrations feature. This will make integrating with ChannelEngine both easy and fast.

  1. Install the extension through composer or the web installer
  2. After installing go to System > Integrations, our ChannelEngine integration should be listed there.

  3. Click on “Activate“, this will prompt you with the different endpoints that we request to use. In this screen, click the orange “Allow“ button.

  4. A popup will open. If you are not yet logged in in ChannelEngine, this popup will direct you to the ChannelEngine login page. Use your ChannelEngine account to log in.
  5. Optional: In case you have multiple ChannelEngine environments, a screen will be shown to select the ChannelEngine environment that you want to integrate with.

  6. Optional: In case you have multiple store views, a screen will be shown that allows you to select the store view that you want to integrate with.

// Setup and Activation

As soon as you’ve successfully connected your Magento to ChannelEngine, a Magento merchant plugin should be created in ChannelEngine. If this is not yet visible, please contact your integration coordinator or customer success manager to have this merchant plugin added.

  1. You can find this in your main dashboard on the left-hand side. 
  2. Select it to open the settings for the plugin.

  3. All required settings should already be entered under 'Setup' by the integration flow from Magento, but please double-check if the correct 'Store URL' and 'Store View Code' are filled in. If these are empty, our integration can not connect to your Magento shop and fetch or export data.

    To go into detail what every setting is for:

    • Store URL: the URL where the main store for Magento is located. Example:
    • Store View Code: the store view code for the store view you wish to connect. Example: default
    • OAuth Consumer Key: the OAuth consumer key necessary for communication with the Magento 2 API.
    • OAuth Consumer Secret: the OAuth consumer secret necessary for communication with the Magento 2 API.
    • Access Token: the OAuth access token necessary for communication with the Magento 2 API.
    • Access Token Secret: the OAuth access token secret necessary for communication with the Magento 2 API.
    • URL Suffix: the URL suffix for product pages in Magento 2. If you use the default URL rewrite in Magento this can remain empty, but if pages show .html at the end this needs to be included.
    • Submit order prices excluding VAT: if you have enabled VAT calculation (so your webshop orders are placed without default VAT), please enable this setting to prevent double VAT calculation on marketplace orders.
    • Cancelled Order Line Handling: this setting determines how ChannelEngine handles canceled orderlines (for example coming from a cancellation request). You can include these orderlines in the export to Magento, exclude these orderlines in the export to Magento or automatically cancel unknown orders, and not export them to Magento. The default value is including these orderlines.
    • Magento Stock Endpoint: this setting determines if we try to get the stock from Magento and if so, from which endpoint/attribute. The options are not importing any stock (so stock must come from an alternative means like a product feed), from the Salable Qty attribute (please note that enabling this will double the number of API calls necessary to get the stock), or from the regular Stock Item. The default value is the Stock Item.

    There are also a few hidden settings that clients will not see themselves. If any of these need to be changed, please contact ChannelEngine support or your customer success manager/integration coordinator:

    • API Async Batch Size: this is the number of simultaneous API calls we perform to your Magento server. Most servers are configured to only handle a limited amount of calls (and/or block the rest), but the lower this number the longer the import of product data will take.
    • Attribute code for Ean field: this is the name of the attribute you use in Magento where the EAN / GTIN can be found. This is usually the default attribute 'ean_code' but we've seen quite some custom alternatives. Because changing this setting to a wrong value would have big consequences (without correct EAN's you can't sell on a lot of marketplaces), this is a hidden setting.
    • Inventory Management Stock Id: if you are using Magento's own inventory management system and you have multiple stock locations set up, you can use this setting to enter the correct warehouse id. The default value (so if it's left empty) is always 1.
  4. If so, you can activate the Magento 2 plugin by pressing the 'Activate synchronisation for Magento' toggle.

  5. Once activated, tasks for importing and exporting data will automatically be scheduled and executed. You can see the latest performed and scheduled of these tasks in the 'Dashboard' tab of the plugin settings.

  6. If you run into issues during any of these steps, please contact us at for further assistance or consult our common integration issues article.

// Magento 2 product data and stock


// Magento 2 orders

// Magento 2 shipments and cancellations

// Connecting additional storeviews

// Troubleshooting common issues

Should you run into issues with successfully connecting the Magento 2 extension, please consult our common integration issues article.