Integrate with Adobe Commerce (Magento)

Suggest Edits

ℹ️

Integrate with Adobe Commerce (Magento) is in beta

Currently, the impact.com plugin integration supports version 2.4.3, 2.4.4, & 2.4.5 of Adobe Commerce.

impact.com supports a plug-in integration with Adobe Commerce (Magento) e-commerce stores, enabling you to track and send conversions directly to impact.com via our API. Once integrated, you can begin discovering and recruiting partners to drive traffic to your store, create contracts that establish payouts for conversions, access reporting data, and more.

🚧

Supported configurations

This integration does not support multi-store/scope configurations. It will only connect with your default store.

Pre-integration checklist

This section covers the key settings in impact.com that you'll need to confirm before starting the integration process. For each item, make sure your account matches the specified setting.

To begin, Sign in to your impact.com account.

Step 1: Event Type configuration

☑️

Online Sale Event Type

Confirm that your impact.com account has One (1) Event Type that is validated and set to track online sales.

  1. From the left navigation bar, select
    → Settings    .
  2. In the right side column, go down to the Tracking section and select Event Types.
  3. Confirm that the Type column reads Online Sale, Tracking reads as Web Services, Validated reads as
    , and Promo Code reads as
    .

☑️

Tracking Method & Returns Processing

Confirm that the validated event type reports conversions and modifications/reversals (i.e., order & item returns) via API.

  1. From the left navigation bar, select → Settings
  2. In the right side column, go down to the Tracking section and select Event Types.
  3. On the Event Types screen, hover your cursor over the right-most column and select
    → View/Edit.
  4. On the View/Edit Event Type screen, confirm that:
    • Tracking Method is configured as Non-Pixel Tracking (advanced) — Use system web service (API).
    • Returns Processing is configured as Automate returns processing (advanced) — Use system web service (API).

☑️

Customer Status Mapping

Confirm that impact.com can distinguish between new and existing customers in your store, which can be used to alter publisher payouts.

  1. From the left navigation bar, select → Settings
  2. In the right side column, go down to the Tracking section and select Event Types.
  3. On the Event Types screen, hover your cursor over the right-most column and select
    → View/Edit.
  4. On the View/Edit Event Type screen, select Show advanced settings.
  5. Next to the Customer Status Mapping line item, select
    .
  6. Confirm that New Customer Value has the value New, and Existing Customer Value has the value Existing.
  7. Select Save.

Step 2: Gateway Tracking configuration

☑️

Campaign Tracking Template (irclickid)

Confirm that the campaign tracking template is configured exactly the same as the steps below, otherwise tracking will not work.

  1. From the left navigation bar, select → Settings.
  2. In the right column, select Gateway.
  3. Find the Campaign Tracking Template line item. Confirm it's configured exactly identical to the screenshot below (irclickid = {clickid}):
  4. Select Save.

☑️

Deep Linking

Confirm that your website and store domain(s) are configured under deep linking, which enables partners to link traffic directly to specific pages and products.

  1. From the left navigation bar, select → Settings.
  2. In the right column, select Gateway.
  3. Find the Deep Linking line item and configure the following domains under Permitted Domains, replacing example.com with your exact domains — do not use spaces between commas:
    example.com,example.magento.com,*.example.magento.com
  4. Select Save.

Step 3: General tracking configuration

☑️

Site Definition

Confirm that your website domain(s) are configured as site definitions, which enables our tracking solution to forward traffic from our domains to yours.

  1. From the left navigation bar, select → Settings.
  2. In the right column, select General.
  3. Next to the Site Definition line item, confirm that your domains that you want tracked are specified as a comma-separated list (no spaces). For example, *.example.com,example.com tracks everything on your top domain and any subdomains, such as www.example.com or store.example.com.
  4. Select Save.

Install impact.com to Adobe Commerce via Composer

This guide follows the General CLI installation process offered by Adobe Commerce — refer to their documentation for additional information about installing extensions via a CLI.

☑️

Install impact.com

impact.com recommends installing the Partnership Cloud extension via Composer — it’s easier to install, update, and maintain your installation versus a manual installation.

  1. Using a terminal emulator, navigate to your root Adobe Commerce project directory and update your composer.json file with the following command:

     $ composer require impact_tech/module-magento-integration

  2. Enter your authentication keys — your public key is your username; your private key is your password.

  3. Wait for Composer to finish downloading and installing the impact.com Partnership Cloud.

    Updating dependencies (including require-dev)
Package operations: 1 install, 0 updates, 0 removals
   - Installing impact_tech/module-magento-integration (X.Y.Z): Downloading (100%)
Writing lock file
Generating autoload files

  4. Verify that the impact.com Partnership Cloud has been installed properly with the following command:

     $ bin/magento module:status Impact_Integration

    By default, the impact.com Partnership Cloud should be installed and disabled.

  5. To enable the impact.com Partnership Cloud, use the following command to enable and clear any Adobe Commerce-generated static view files:

    $ bin/magento module:enable Impact_Integration --clear-static-content

    You should see the following output:

    The following modules have been enabled:
- Impact_Integration
To make sure that the enabled modules are properly registered, run 'setup:upgrade'.
Cache cleared successfully.
Generated classes cleared successfully. Please run the 'setup:di:compile' command to generate classes.
Generated static view files cleared successfully.

  6. Register the impact.com Partnership Cloud with the following command:

     $ bin/magento setup:upgrade

  7. Recompile your Adobe Commerce project using the following command:

    $ bin/magento setup:di:compile

  8. If you’re running Adobe Commerce in Production mode, deploy the module’s static files with the following command:

     $ bin/magento setup:static-content:deploy

  9. Verify that Impact Partnership Cloud is enabled with the following command:

     $ bin/magento module:status Impact_Integration

    This command should return Module is enabled.

  10. Finally, flush and clean the cache with the following commands:

    $ bin/magento cache:flush
$ bin/magento cache:clean

Activate & Configure impact.com

The following instruction set shows how to enable the integration using the Adobe Commerce Admin Dashboard.

☑️

Activate impact.com

  1. In the left navigation bar of the Adobe Commerce Admin Dashboard, select Settings → Integrations.

  2. On the Integrations screen, find the ImpactIntegration line item and select Activate.

    Confirm that impact.com can access the necessary files of your store by selecting Allow, then confirm that the integration reads Active under the Status column.

  3. In the left navigation bar of the Adobe Commerce Admin Dashboard, select Stores → Configuration.

  4. Select Impact Settings from the Impact section of the Configurations screen.

  5. Navigate to the bottom of the landing page to Already have an impact.com account? and select Set up your integration.

  6. Select Existing Customer and fill in all fields with your impact.com account information.

    Account DataDescription
    Impact Account SID*Navigate to
    → Settings → API     to find your Account SID. Copy the full case-sensitive value.
    Auth Token*Navigate to
    → Settings → API     to find your Auth Token. Copy the full case-sensitive value.
    Program ID*Enter your Program ID value (a.k.a Campaign ID value). To find this value, select your brand name in the top left corner of Impact. Your Program ID is shown in gray type under your Program name in the Program column.
    Event Type ID*Navigate to
    → Settings → Event Types    . Your Event Type ID is the number in parenthesis next to the name of the event type — enter this value.
    Universal Tracking Tag (UTT)*Navigate to
    → Settings → General    . Paste your entire unique UTT code into this field.

  7. In the top right corner of the screen, select Save Config.

End-to-End Testing

Once the impact.com app is fully installed to your Adobe Commerce store, you can begin end-to-end testing to ensure everything is working properly. Follow the steps below sequentially to test your integration.

Step 1: Create a 0% Test Contract

☑️

Create 0% Test Template Terms

Creates a new set of template terms with a 0% default payout (or "commission"), used for testing with a test partner account.

  1. From the left navigation menu, select Contracts → Template Terms.
  2. In the upper right corner, select Create Template Term.
  3. For the Name, enter Test Terms.
  4. For Event Type, select Online Sale.
  5. Set the Default Payout to 0% of order sale amount.
  6. Scroll down and select Save.

Step 2: Get Branded Links

☑️

0% Template Terms sign up link

Gets the unique URL that will send users to sign up as a new direct partner to your impact.com program on your 0% template terms.

  1. From the left navigation menu, select Contracts → Template Terms.
  2. In the list, find your test template terms you created in the last step. Under the Actions column, select
    → Get Branded Links.
  3. Next to Promo Page Link, copy the the full URL and paste it somewhere accessible, such as a text editor.

Step 3: Create a test partner account

☑

Direct Partner sign up

Create a new direct partner account that's applying to your impact.com program on the 0% test template terms.

  1. In an incognito/private browser window, copy and follow the link from the last step.
  2. Follow the prompts onscreen to create a direct partner account for your brand.

    📘

    Note

    Make sure to use a different email address and username from your impact.com brand account. Keep the username and password saved somewhere easily accessible, as you'll need to access it later.

  3. Select Sign Up.

We recommend adding TestPartner somewhere in the partner's name (e.g., YourBrand_TestPartner) to ensure everyone with access to your impact.com account knows this is a test account. Be sure to save the password somewhere safe.

Step 4: Accept your test partner account

☑

Accept partner proposal

Accepts the test partner account's application and signs them to the 0% test template.

  1. Back in your impact.com Brand Account, in the left navigation menu, select Partners → Proposals.
  2. Under Received Proposals, find your test account name and select View Terms.
  3. In the top right corner of the screen, select Actions → Accept.

Step 5: Get a partner tracking link

☑

Create a Link

Creates a new tracking link in the test partner account, which is used to forward traffic to your store and attributes conversions to the partner.

  1. In an incognito/private browser window, sign in to your test partner account.
  2. On the dashboard, find the Create a Link widget.
  3. Select the link to copy it to your clipboard.

Step 6: Test Conversion Events

❗️

Important!

When testing, make sure to disable any ad/content blocker extensions that may be active in your browser. Make sure you use your test partner tracking link to access your site!

For the most accurate results and fastest launch time, impact.com recommends testing a conversion in your live Adobe Commerce store, then canceling the order once you've confirmed that impact.com tracked it.

☑️

Complete a test conversion event

  1. In a fresh browser tab, paste & follow the tracking link from Step 5.
  2. Once you've reached the landing page, complete a test conversion event in-store with the following:
    • At least two (2) items with different SKUs
    • An item with a quantity value of 2 or more
    • Apply a promo code (or coupon code) to the order
  3. Complete the order and check out, making sure to reach your store's "Thank You" or "Confirmation" page that the order went through.

Step 7: Verify actions in impact.com & reverse orders in Adobe Commerce

📘

Note

Your test conversion should appear in impact.com within 30 minutes but can take up to 2 hours before appearing. If your conversion doesn't appear in impact.com within 24 hours of the test conversion occurring, reverse the order in Adobe Commerce, verify that the Event Type ID in Adobe Commerce matches your Event Type ID in impact.com, then try another test conversion through your test partner link.

☑️

View Pending Payouts

  1. In your impact.com brand account, navigate to Transactions → Pending Payouts → Actions.
  2. Verify that your test conversion events appears as a pending payouts.
  3. Select the linked Action ID to view action details. Order ID should match your Adobe Commerce entity_id, Items and SKUs should appear, and the promo code used should appear as well.
  4. Once you can verify the conversion was accurately reported in impact.com, make sure to cancel the order in Adobe Commerce. Modifications and reversals you do in Adobe Commerce are automatically sent to impact.com.

Updated 3 months ago