Skip to main content
Integration: Magento 2

Install ReferralCandy on your Magento 2 store

Adam avatar
Written by Adam
Updated over a week ago

If you are using Magento version 2.0 and above, and your team is able to install modules via Composer, you can use ReferralCandy with your Magento store. If not, follow this Email Integration guide instead.

Note: Our Magento 2 module integration is designed to work with the standard Magento checkout. Using third-party checkout extensions may interfere with the detection of referred purchases. We recommend you implement the Magento 2 module integration with ReferralCandy using the standard checkout process.


Server side setup

To install the ReferralCandy module via Composer, please follow the steps below:

  1. Install the referralcandy/magento2-module-integration package from Composer:

    composer require referralcandy/magento2-module-integration
  2. Update the Composer your project's dependencies:

    composer update
  3. Enable the module using the magento-cli:

    bin/magento module:enable ReferralCandy_Integration
  4. Perform a setup upgrade:

    bin/magento setup:upgrade
  5. Run the code compiler for Magento:

    bin/magento setup:di:compile
  6. Flush your store's cache (recommended by Magento after module installations)

    bin/magento cache:flush

After installation, follow the steps below to configure the module.

Admin dashboard setup

  1. Log in to your store's admin panel.

  2. Navigate to STORES and click Configuration.

  3. On the configuration page, a new section called REFERRALCANDY should be available. Navigate to REFERRALCANDY and click General.

  4. Copy and paste the necessary values for APP ID, API Access ID, and API Secret Key, which can be found on your My Profile page under the "API Tokens" section.

  5. Enable the module, and click on Save Config.

That's it! Your Magento store is now integrated with ReferralCandy!


๐Ÿ’ฌ Need help? Click the chat widget on the right to start a conversation. Learn more


Did this answer your question?