Adobe Commerce 3.0: merchant plugin guide

About this guide

This guide describes ChannelEngine's integration with Adobe Commerce (née Magento), including how to install and configure it, and more.

Table of contents

Introduction

Plugin features

Requirements

Upgrade to 2.4.3 or higher version

Download the plugin

Connect the plugin with ChannelEngine

• Installation
• Setup
• Activation

FAQs

Introduction

Adobe Commerce is a leading ecommerce platform that offers webstore functionality. It is designed to help merchants personalize the look, content, and functionality of their store.

ChannelEngine's Adobe Commerce 3.0 plugin is intended for medium to large businesses, including enterprise users.

The plugin fully relies on Adobe Commerce API, which helps prevent any conflicts with existing plugins or customizations in your Adobe Commerce environment. It includes many built-in features and allows you to add custom features on top of those provided by ChannelEngine.

We recommend using the 3.0 plugin for better compatibility and reliability.

Plugin features

Requirements

Below you can find the requirements to install ChannelEngine's Adobe Commerce plugin:

• Adobe Commerce 2.0 or higher (Open Source, Commerce, Cloud)*
• Access to the Adobe Commerce admin

* Adobe Commerce 2.3 or higher is recommended

Download the plugin

You can find the Adobe Commerce plugin in its various forms on ChannelEngine: webshop integrations. Select the package or method you want to use and download it.

For a guide on how to install the Adobe Commerce plugin as a zip file, check out How to install modules manually in Magento 2 article.

Connect the plugin with ChannelEngine

Installation

ChannelEngine's Adobe Commerce plugin uses the new Adobe Commerce integrations feature. This makes integrating with ChannelEngine both easier and faster.

1. Install the Adobe Commerce plugin via composer or the web installer. For composer, see Manage third-party extensions in the Adobe Commerce Installation Guide and follow these instructions:
   • Modify the composer.json to make sure that updates to the magento2 module from non-marketplace repositories take precedence:

     "repositories": [
        {
            "type": "composer",
            "url": "https://repo.magento.com/",
            "exclude": ["channelengine/magento2"]
        }
     ],

   • Open the terminal and run:

     composer require channelengine/magento2

   • Enable the extension:

     bin/magento module:status ChannelEngine_Magento2

   • Clear static view files:

     bin/magento module:enable ChannelEngine_Magento2 --clear-static-content

   • Upgrade the setup:

     bin/magento setup:upgrade

   • Compile the application:

     bin/magento setup:di:compile

   • Verify the extension is enabled:

     bin/magento module:status 

   • Clean the cache:

     bin/magento cache:clean

2. After you install the extension, go to System, Integrations. The ChannelEngine integration should be listed.
3. Click Activate.
4. In the ChannelEngine dialog box, you can see the different endpoints ChannelEngine needs access to. Allow access to all available recourses. 
5. If you are not logged in to ChannelEngine, a popup redirects you to the ChannelEngine login page.
6. If you have multiple ChannelEngine environments, you can now select the ChannelEngine environment to integrate with Adobe Commerce.
7. If you have multiple store views, you can now select the store view that you want to integrate with.

Setup

Once you have connected Adobe Commerce with ChannelEngine, an Adobe Commerce 3.0 plugin is created on ChannelEngine. If this is not yet visible, contact your implementation specialist or customer success manager to verify the installation.

1. On the dashboard, click the Adobe Commerce 3.0 plugin.
2. The required settings should already be entered under Setup by Adobe Commerce integration flow, but do double-check if the correct Store URL and Store view code are filled in. If they are empty, ChannelEngine's plugin cannot connect to your Adobe Commerce store and import or export data. The plugin settings are:
   • Store URL - the URL where the main store for Adobe Commerce is located. E.g.: https://www.mystore.com/.
   • Store view code - the store view code of the store view you wish to connect with. E.g.: default.
   • OAuth consumer key - the key necessary for communication with the Adobe Commerce API.
   • OAuth consumer secret - the secret necessary for communication with the Adobe Commerce API.
   • Access token - the access token necessary for communication with the Adobe Commerce API.
   • Access token secret - the token secret necessary for communication with the Adobe Commerce API.

Plugin-specific settings

• VAT/sales tax country code - the ISO code of the country where the sales tax is applicable. E.g.: DE, NL, etc.
• Adobe Commerce version - the version of your Adobe Commerce software. E.g.: Magento/2.4 (Enterprise).
• Use order line description provided by the channel - enable this setting to include the product description in the order export to Adobe Commerce.
• Export region - enable the setting to include the region name from the billing and shipping addresses in the order export to Adobe Commerce.

Advanced settings

• URL suffix - the URL suffix for product pages on Adobe Commerce. If you use the default URL rewrite in Adobe Commerce, this field can remain empty. If pages show .html at the end, it needs to be included.
• Submit order prices excluding VAT - if you have enabled VAT calculation (i.e.: so your store orders are placed without the default VAT), make sure to enable this setting to prevent double VAT calculation on marketplace orders.
• Synchronize orders fulfilled by marketplace - enable this to include orders fulfilled by marketplaces in the order export.
• Canceled order line handling - determines how ChannelEngine handles canceled order lines, e.g.: from a cancelation request. The options are: include these order lines in the export to Adobe Commerce; exclude these order lines in the export to Adobe Commerce; or automatically cancel unknown orders – and not export them to Magento. The default value is to include these order lines.
• Magento stock endpoint - determines if ChannelEngine should get the stock from Adobe Commerce and, if so, from which endpoint or attribute. The options are: do not import any stock (so stock must come from an alternative source, like a product feed); import from the Salable quantity attribute (note that enabling this doubles the number of API calls necessary to get the stock); or import from the normal Stock item. The default value is Stock item.
• Inventory management stock ID - if you are using Adobe Commerce's own inventory management system and have multiple stock locations set up, use this setting to enter the correct warehouse ID as an integer. The default value is 1. Note that in Adobe Commerce, you can find the stock ID on the Manage stock page by going to Stores, stock.
• Update stock on product import - enable this to update the product's stock whenever the product import is performed.

There are also hidden settings, visible only to ChannelEngine's employees. If any of these need to be changed, contact ChannelEngine's Support, your customer success manager, or implementation specialist.

• API async batch size - the number of simultaneous API calls ChannelEngine makes to your Adobe Commerce server. Most servers are configured to handle a limited number of calls and block the rest. The lower this value of this field, the longer the import of product data takes.
• Attribute code for EAN field - the name of the attribute you use on Adobe Commerce where the EAN/GTIN can be found. This is usually the default attribute EAN_code but there are custom alternatives. Changing this setting to an invalid value can result in products unavailable on marketplaces, hence it is hidden.

Activation

1. On the Activation tab, switch the Activate synchronization for Adobe Commerce toggle to activate the Adobe Commerce 3.0 plugin.
2. Once the plugin is activated, data import and export tasks are scheduled and executed automatically. You can see the latest performed and scheduled tasks under the Dashboard tab of the plugin's settings.
3. If you run into issues during any of these steps, contact ChannelEngine's Support team or check out the Adobe Commerce 3.0: common integration issues and error messages article.

FAQs

How often does each task run on Adobe Commerce 3.0?

By default, the Adobe Commerce 3.0 plugin follows the schedule below.

What do I encounter the 'Invalid signature' error?

You may encounter the 'Invalid signature' error if you upgraded your Adobe Commerce to version 2.4.3 or higher but did not reauthorize your plugin in Adobe Commerce back-end. 

1. In the Admin sidebar, go to System, Extensions, Integrations.
2. Find the ChannelEngine's integration with the Active status.
3. In Activate column, click Reauthorize.
4. Approve access to the API resources and save the integration tokens.