Skip to main content
Integration: Magento 2

Install ReferralCandy on your Magento 2 store

Adam avatar
Written by Adam
Updated this week

Merchants on the Magento version 2.0 and above who are able to install modules via Composer can integrate ReferralCandy with their Magento store. If this procedure doesn't work for you, try email integration.

Note: Third-party checkout extensions in your store may interfere with referral detection. It's recommended to use the standard Magento checkout process when integrating with ReferralCandy.


Set up Magneto integration

Step 1: Server-side setup

To install the ReferralCandy module via Composer:

  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

Step 2: Admin dashboard setup

After ReferralCandy installation via Composer, configure the module:

  1. Log in to your Magneto 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. On the ReferralCandy dashboard, go to Profile > API Tokens and Plugin Tokens to find your API IDs and keys. Copy the values.

  5. Go back to the configuration page and paste the values into the APP ID, API Access ID, and API Secret Key fields.

  6. Enable the module and click Save Config.

Make a test purchase in your store to ensure that referral detection works. Go to your Purchases & Referrals page to verify if purchases are tracked successfully.


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


Did this answer your question?