1. ChannelEngine Help Center
  2. Integrations
  3. Adobe Commerce

Articles in this section

Adobe Commerce 3.0: merchant plugin guide

  • Created
  • Updated

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

Download the plugin

Connect the plugin with ChannelEngine

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

Supported Not supported
Product content  
Product offers  
Orders (incl. marketplace-fulfilled orders)  
Shipments  
Cancelations (merchant)  
Stock  
Three-level product structure  
Merchant returns1  
Marketplace returns1  
Return tracking codes2  

1. Both merchant and marketplace returns are only supported by Adobe Commerce Cloud/Enterprise Edition. Marketplace-fulfilled returns, e.g.: FBA, ZFS, LVB, are not supported.

2. You can configure return tracking codes on Adobe Commerce 3.0 using the additional tracking number. To learn more, check out the article Adobe Commerce 3.0: return tracking code.

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.4 or higher is recommended

Download the plugin

You can find the Adobe Commerce plugin in its various forms on ChannelEngine: webstore 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.Magento_2_-_Integration_setup.png
  3. Click Activate.
  4. In the ChannelEngine dialog box, you can see the different endpoints ChannelEngine needs access to. 
    • POST /rest/default/V1/guest-carts
    • POST /rest/default/V1/orders
    • GET /rest/default/V1/orders/{id}
    • POST /rest/default/V1/order/{orderId}/invoice
    • POST /rest/default/V1/order/{id}/channelengine
    • POST /rest/default/V1/guest-carts/{cartId}/items
    • POST /rest/default/V1/guest-carts/{cartId}/channelengine 
    • POST /rest/default/V1/guest-carts/{cartId}/shipping-information
    • PUT /rest/default/V1/guest-carts/{cartId}/order
    • GET /rest/default/V1/categories
    • GET /rest/default/V1/products/attributes
    • GET /rest/default/V1/products
    • GET /rest/default/V1/taxRules/search
    • GET /rest/default/V1/taxRates/search
    • GET /rest/default/V1/configurable-products/{sku}/children
    • GET /rest/default/V1/stockItems/{productSku}
    • GET /rest/default/V1/inventory/get-product-salable-quantity/{sku}/{stockId}
    • GET /rest/default/V1/shipments
    • GET /rest/default/V1/orders
    • GET /rest/default/V1/store/storeConfigs
  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. Go to Setup, Connection. Choose an authentication method: OAuth or token-based.
    NB: while OAuth is the recommended method, you can choose token-based authentication if you use Adobe Commerce 2.4.6 or higher, and your Merchant product numbers contain special characters.

    Token-based authentication is not supported if you use two-factor authentication (2FA) in your Adobe Commerce account, as the plugin does not work in that case.
  3. The required settings should be entered by Adobe Commerce integration flow. 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.
    • 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.
  4. The remaining settings depend on your selected authentication method.
    • OAuth-based authentication: 
      • OAuth consumer key
      • OAuth consumer secret
      • Access token
      • Access token secret
    • Token-based authentication:
      • Adobe Commerce username
      • Adobe Commerce password

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. When enabled, all order amounts, including shipping, are consistently synchronized with Adobe Commerce exclusive of VAT. 
  • 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. Make sure to also set the Magento stock endpoint setting to Salable quantity, so the stock is imported from that specific stock location.
  • Generate three-level product structure - enable this setting to generate the three-level product structure (i.e.: grandparent, parent, and child) on ChannelEngine. Note that only products of type 'configurable' can be converted into a three-level product structure. Products of type 'simple' are created as standalone products. Once enabled, the Product option for parent setting becomes available. Use this setting to specify the option that distinguishes parent products from one another. On Adobe Commerce, the top option corresponds to 1 on ChannelEngine.

    The screenshot below shows an example of the variation setup on Adobe Commerce. Color is the top attribute (option 1), and Size is the next attribute (option 2).
  • Update stock on product import - enable this to update the product's stock whenever the product import is performed.
  • Check for return tracking code - enable it to capture a return tracking code for marketplaces that require it. When creating a shipment for marketplaces such as Zalando, OTTO Market, or About You, enter the return tracking code in this tracking number field. If the return tracking code is not provided, ChannelEngine rejects the shipment. To learn more, check out the article Adobe Commerce 3.0: return tracking code.
  • Enable synchronization of merchant returns - enable this to synchronize merchant returns. Returns that are registered in your webstore are imported into ChannelEngine and exported to the marketplace.
  • Enable synchronization of marketplace returns - enable this to synchronize marketplace returns. ChannelEngine starts exporting any returns registered on the marketplace to your Adobe Commerce webstore.

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.Magento_2_-_Dashboard.png
  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.

Task Frequency
Import product data from merchant every 30 minutes
Import product images from merchant once a day
Export orders to merchant every 15 minutes
Import shipments from merchant every 15 minutes
Export returns to merchant every 15 minutes
Import returns from merchant every 15 minutes

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.

Can I retrieve marketplace order extra data via Adobe Commerce 3.0?

It is currently not possible to retrieve order or order line extra data via ChannelEngine’s Adobe Commerce plugin. This is due to the complexity and variety of marketplace order extra data fields, which make them difficult to standardize.

If you must retrieve specific order extra data fields, you will need to build a custom integration with ChannelEngine to fetch this data.

Why does ChannelEngine parse buyer addresses, and how can I disable this?

ChannelEngine parses buyer addresses to standardize their format and improve compatibility with carrier and fulfillment systems. However, parsing does change the original structure, especially for US addresses, where the house number appears first – unlike in Europe.

To retrieve the original shipping and billing addresses from the marketplace, use the Disable address parser setting. To do this, go to Settings, Settings, Address and toggle Disable address validation. To learn more, check out the article ChannelEngine: address parsing.

Why does Adobe Commerce change a zero price back to the product's original price?

If you set a product’s price to zero – e.g.: to offer a 100% discount to a marketplace customer like a TikTok influencer – Adobe Commerce automatically replaces the zero price with the product’s original price when the order is imported. This is a default behavior on Adobe Commerce to prevent orders with a zero value.

Related articles

Comments

0 comments

Article is closed for comments.