Skip to content
ShopAssist Docs
Install

Install on Adobe Commerce

ShopAssist on Adobe Commerce on-premises and Cloud: the Magento 2 module, website scope, RMA returns, staging and B2B notes.

Applies to: Magento 2 / Adobe CommerceView as Markdown

Adobe Commerce (on-premises and Commerce Cloud PaaS) uses the same module as Magento Open Source. Follow install on Magento 2; this page lists what is different.

Requirements

  • Magento Open Source / Adobe Commerce 2.4.6: >=2.4.6 <2.4.7 (PHP 8.1–8.2)
  • Magento Open Source / Adobe Commerce 2.4.7: >=2.4.7 <2.4.8 (PHP 8.2–8.3)
  • Magento Open Source / Adobe Commerce 2.4.8: >=2.4.8 <2.4.9 (PHP 8.3–8.4)
  • Magento Open Source / Adobe Commerce 2.4.9: >=2.4.9 <2.5 (PHP 8.4–8.5)
  • Mage-OS: >=1.0 (PHP 8.2–8.5)
  • Latest plugin version: 1.0.0
  • Adobe Commerce as a Cloud Service (SaaS) is not supported by the module. Headless storefronts on any edition can use the Generic connector.
  • On Commerce Cloud, add the module through your repository's composer.json and deploy through your normal pipeline; cron runs there by default.

Install

Typical setup: A Composer deploy by your developer

  1. 1.Install the module with Composer

    Run this in your Magento root. Add the optional modules for multi-source inventory (coec/module-shopassist-inventory), returns (coec/module-shopassist-rma, Adobe Commerce) and customer cancellation (coec/module-shopassist-order-cancellation) if you use them.

    composer require coec/module-shopassist

  2. 2.Enable the module and deploy

    Run the upgrade and flush the cache. In production mode also compile and deploy static content. Magento cron must run.

    bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento setup:static-content:deploy
bin/magento cache:flush

  3. 3.Paste the pairing code

    In the ShopAssist dashboard, create a pairing code. In the Magento admin open Stores → Configuration → ShopAssist at website scope, paste the code and click Connect. Connect one ShopAssist store per website.

Add coec/module-shopassist-rma if you want shoppers to start returns in the chat through Adobe Commerce RMA.

Connect

Pair each website from its website scope, exactly as on Magento 2.

Verify

See Magento 2 → Verify.

Signed-in customers

Identical to Magento Open Source. With B2B, company accounts are treated like customer accounts: the assistant shows orders of the signed-in customer only.

Stock per location

Identical to Magento 2 (MSI sources through the inventory module).

Updating

Identical to Magento 2. On Commerce Cloud, update the version constraint in composer.json and deploy.

Uninstall and data removal

Identical to Magento 2.

Troubleshooting

  • Content staging: scheduled updates change products without a save event. ShopAssist compares the catalog every hour when it detects staging, so scheduled price changes appear within an hour.
  • RMA returns are marked beta until they are verified on more Commerce installations. Returns that RMA does not allow are offered as a request to your team instead.
  • See also Magento 2 → Troubleshooting.

Last updated on

Install on Magento 2

Install the ShopAssist module with Composer, pair each website with a code, and enable stock per source, returns and customer cancellations.

Install on WooCommerce

Install the ShopAssist plugin from WordPress.org, connect in one click, and set up signed-in customers and stock per location.

On this page

RequirementsInstallConnectVerifySigned-in customersStock per locationUpdatingUninstall and data removalTroubleshooting