For the complete documentation index, see llms.txt. This page is also available as Markdown.

Integrate with BigCommerce

impact.com's plugin for BigCommerce makes it easy to recruit, track, and manage partners who want to promote your online store. Our BigCommerce app is a quick plug-and-play solution to integrating impact.com with your website without needing coding knowledge or extensive developer help. Follow this step-by-step guide to learn about the integration process.

Prerequisites

  • One (1) Event Type tracking online sales (no recurring subscriptions).

  • A store Landing Page that is hosted by BigCommerce (not externally).

  • A store that uses a Stencil theme (Blueprint themes are not supported).

Check before integrating

impact.com will complete several integration steps on your behalf. Check with your implementation engineer to ensure that the following configuration steps have been completed: Event Type, Gateway Tracking, General Tracking.

How are conversions linked to partner clicks?

Our impact.com BigCommerce integration ensures that every sale driven by your partners is precisely tracked and attributed. Here's a simple breakdown of how it works:

  1. Customer arrives via partner link: When a customer clicks on a partner's unique tracking link and lands on your BigCommerce store, our integration captures a special identifier for that click (called an im_ref) directly from the website's address.

  2. Click ID is stored: The im_ref is securely stored in the customer's browser using a cookie. This cookie ensures the referring partner is remembered as the customer browses.

  3. UTT supports visitor identification: Impact's Universal Tracking Tag (UTT) is loaded on the storefront, sending identify requests to impact.com to establish and maintain the visitor's attribution record throughout their browsing session.

  4. Purchase completes: As the customer completes a purchase, our integration automatically retrieves all essential order details from BigCommerce, along with the stored im_ref from the cookie.

  5. Conversion reported to impact.com: The order details and im_ref are securely and automatically sent to impact.com.

  6. Accurate attribution: impact.com uses the im_ref to deterministically link the completed sale back to the original partner click, ensuring your partners are accurately credited for the sales they generate.

Add impact.com to BigCommerce

This instruction set covers installing impact.com's plugin to your BigCommerce store.

Install impact.com's plugin

  1. Navigate to the impact.com app page in the BigCommerce App Store, then select Get This App.

  1. Log in to your BigCommerce account (if you haven't already) and select Install.

  1. The installation process requires you to grant the access permissions required by impact.com. After agreeing to the terms and conditions, select Confirm.

  1. Scroll down and select Set up your integration.

  1. Add your impact.com account information in the relevant fields. Refer to the Settings reference table below for instructions on where to find each value.

Settings Reference
Setting
Description

Impact Account SID *

In the impact.com platform, from the top navigation bar, select [User profile] → Settings → API. Under API Tokens, select Create API Token. Set the token type to Read/Write, then select Generate Token. Copy the Account SID value.

Auth Token *

In the impact.com platform, from the top navigation bar, select [User profile] → Settings → API. If you've just created your token, copy the Auth Token value displayed on screen — this is only shown once. If you've already created a Read/Write token, locate it in the API Tokens list and copy the Auth Token from there.

Program ID *

Enter your Program ID value. To find this value, select your brand name in the top-left corner of the impact.com app. Your Program ID is the numerical value under the program name.

Sales and Subscriptions Tracker *

In the impact.com platform, from the top navigation bar, select [User profile] → Settings → Event Types. Copy the number in parentheses next to the name of the Online Sale event type.

Universal Tracking Tag *

From the top navigation bar, select [User profile] → Settings → General. Paste your entire unique UTT code into this field.

  1. Select Save. You'll receive confirmation that impact.com has been installed, after which you can begin end-to-end testing.

Once the impact.com app is fully installed, you can begin end-to-end testing to ensure everything is working properly. Learn how to proceed with End-to-End Testing.

  1. Clear cache and cookies, or use a new private browser window (e.g. Incognito), and ensure ad-blocking browser extensions are disabled. This prevents data from previous tests influencing your results.

  2. Generate a tracking link using a test partner paired to the Advertiser account. Copy and paste the tracking link into your web browser.

  3. Open Chrome DevTools before visiting the link and filter by the following regex in the Network tab: /impactcdn/

  4. Visit the link and record the im_ref value from the URL.

  5. Verify that the following two network requests received 200 responses:

    • UTT — Name will resemble A4097096-9b4f-412a-b9c8-27c35eb11b5a1.js; Type: script

    • Identify Function tag — Name will be the {campaignId} (e.g. 18999); Type: xhr. Confirm that the payload includes the clickid in the payload tab. After the initial xhr request on the landing page, this appears as a ping request on subsequent pages.

  6. Complete a conversion event on the website and record the Order ID and payload parameters from the Thank You / Order Confirmation page.

  1. If relevant, complete several tests with multiple SKUs, a minimum quantity of 2 per SKU, and some tests with and without a promo code and discount. This verifies that multiple items, promo codes, and item quantities/amounts are handled correctly.

  2. Verify that the information in the payload is correct (multiple items, promo codes, and item quantities/amounts are handled correctly) and that the event was attributed to the correct test partner. Note: attribution can take 20–120+ minutes depending on processing delays.

Troubleshooting

My test conversion isn't appearing in impact.com

If your test conversion isn't appearing, check the following:

  • You accessed your BigCommerce store using the test partner tracking link. If you don't use this link, the conversion won't be credited to your test partner and may not appear.

  • You've waited at least 30 minutes since the test conversion. Conversion reporting can take up to 2–4 hours during peak times.

  • Your ActionTrackerId in BigCommerce exactly matches the ActionTrackId in impact.com.

  • Use the OrderId (OID) Lookup tool to search for the BigCommerce Order ID of the test order.

  • Add your BigCommerce domains in impact.com:

    • Site definition: Navigate to Settings → Tracking → General. Add all domains and subdomains (production and sandbox), then select Save.

    • Deeplinking: Navigate to Settings → Tracking → Gateway. Add all domains and subdomains, including a wildcard to cover all subdomains (e.g. *.mystore.com), then select Save.

  • Confirm the UTT is firing on the landing page: open Developer Tools → Network tab → add the filter impactcdn. You should see a 200 OK request named as your UTT JavaScript file.

Testing with multiple BigCommerce stores (sandbox and production)

If you are running a sandbox BigCommerce store alongside your production store, you must register both environments in two places within impact.com.

Site definition

Navigate to Settings → Tracking → General and add all domains associated with both stores. For example:

  • mystore.com

  • mywebsite.mybigcommerce.com

  • store-mywebsite.mybigcommerce.com

  • mysandboxwebsite.mybigcommerce.com

  • store-mysandboxwebsite.mybigcommerce.com

Select Save once all domains have been added.

Deeplinking

Navigate to Settings → Tracking → Gateway and add all domains for both environments, including a wildcard to cover all subdomains. For example:

  • mystore.com

  • *.mystore.com

  • mywebsite.mybigcommerce.com

  • store-mywebsite.mybigcommerce.com

  • mysandboxwebsite.mybigcommerce.com

  • store-mysandboxwebsite.mybigcommerce.com

Select Save.

Supported parameters

Field
Example
Description

ActionTrackerId

16027

Also known as the Event Type ID, this is the ID number for your impact.com event type.

CampaignId

8882

Also known as a Program ID, this is the ID number for your impact.com program/campaign.

ClickId

2uz3sQWFlxyJRcqwUx0Mo34VUkiyyO0tIzeG3U0

The Click ID associated with the action.

CurrencyCode

USD

The currency code for the currency recorded in the action.

CustomerEmail

38b85baa75385758d44d3dbfd97921c32e0d09a9

If you're tracking and passing customer info, this is the SHA1 hash of the customer's email.

CustomerEmailSHA256

987669e572d2cc2eba5f690b8f766ab58986779638d4c880e056aeb996b6ce76

If you're tracking and passing customer info, this is the SHA256 hash of the customer's email.

CustomerId

3222174466122

If you're tracking and passing customer info, this is an ID number referencing the customer associated with the order.

CustomerStatus

EXISTING or NEW

If you're tracking and passing customer info, this is the status of the customer associated with the order.

EventDate

2020-06-18T14%3A33%3A49

Tracks the date that the action occurred.

IntegrationSource

Impact_BigCommerce_Plugin

Identifies the integration type. Always sends Impact_BigCommerce_Plugin.

IpAddress

1.1.1.1

The IP address associated with the action.

OrderId

2516623458378

The impact.com OID (Order ID) value associated with the action (Order ID column in BigCommerce orders page).

OrderPromoCode

Welcome10

Promo code used for the order. The code will be passed here unless it is set to be applied to a specific product.

ItemSku{N}

KS944RUR

The SKU number of the BigCommerce product (called SKU on BigCommerce).

ItemQuantity{N}

1

The quantity amount for the item in the action.

ItemCategory{N}

Course

he category of the BigCommerce product (called Categories on BigCommerce).

ItemName{N}

Course

The name of the BigCommerce product.

ItemSubtotal{N}

60.00

The subtotal amount of the item before taxes, shipping, discount, and any other costs.

ItemDiscount{N}

10

Discount applied for each item. Shows the proportionate value if the customer used OrderPromoCode.

ItemPromoCode{N}

Spanish10Off

Item-level promo code. Passes the first non-null value. The code will be passed here if it is set to be applied to a specific product.

This value is available for reporting only and cannot be used for contracting in impact.com.

Modifications & Reversals

BigCommerce offers support in their Help Center — see the links in the table below for instructions on how to edit and refund orders in BigCommerce.

Scenario
Outcome

Process a full refund (entire order)

Each item's reversal payload will be sent to impact.com. The entire order will be reversed.

Process a partial refund (individual items)

The individual item's reversal payload will be sent to impact.com.

Edit an order (adding a new item)

No modification payload will be sent to impact.com.

Change the order status to Cancelled, Declined, Refunded, or Disputed

No reversal payload will be sent to impact.com.

Customer return request (processed from dashboard)

Once you've completed the Return Requests process in your BigCommerce dashboard, the reversal payload will be sent to impact.com.

Last updated