> For the complete documentation index, see [llms.txt](https://integrations.impact.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://integrations.impact.com/integration-guides/for-brands/plugin-integrations/e-commerce/integrate-with-shopify.md).
# Integrate with Shopify
[**impact.com Affiliate Marketing**](https://apps.shopify.com/impact-1) on Shopify integrates impact.com's conversion tracking and reporting with your Shopify store, allowing you to manage your programs efficiently. The app is a no-code plugin, meaning you can integrate and end-to-end test without web development expertise.
## Prerequisites
Confirm the following about your Shopify store and impact.com account:
* **Event Type:** You have one (1) [Event Type](https://help.impact.com/brand/what-would-you-like-to-learn-about/platform-features/event-types/create-an-event-type) tracking online sales. First subscription orders are tracked through this event type too.
* **Hosted on Shopify:** Your store landing page is hosted on Shopify, not externally. [Custom shopping experiences](https://help.shopify.com/en/manual/custom-storefronts) aren’t supported at this time.
* **Cookie banner required:** You have the [Customer Privacy](https://shopify.dev/docs/api/customer-privacy) cookie banner enabled, as required by Shopify. EMEA-based storefronts require customers to opt in for tracking consent.
* **SKUs assigned by default:** All products in your Shopify store are automatically [assigned a SKU](https://help.shopify.com/en/manual/products/details/sku) (stock keeping unit). Learn how to [edit products in Shopify.](https://help.shopify.com/en/manual/products/add-update-products#edit-a-product)
* **Recurring subscriptions need extra setup:** This guide tracks one-time purchases and first subscription orders. To also track recurring subscription orders (renewals), follow [Integrate with Shopify & Recharge Subscriptions](/integration-guides/for-brands/plugin-integrations/e-commerce/integrate-with-shopify/integrate-with-shopify-and-recharge-subscriptions.md) or [Integrate with Shopify & Bold Subscriptions](/integration-guides/for-brands/plugin-integrations/e-commerce/integrate-with-shopify/integrate-with-shopify-and-bold-subscriptions.md) instead. See [How subscription orders are tracked](#how-subscription-orders-are-tracked).
## Install the impact.com app on your Shopify store
1. While [logged in](https://www.shopify.com/login) to Shopify, open the [***impact.com Affiliate Marketing***](https://apps.shopify.com/impact-1) app in the Shopify App Store and select **Install**.
2. Shopify will prompt you to install *Impact: Partnership Cloud*. Review the details on the screen, and select **Install**.
3. Once installed, find the app in your list of Shopify apps. To begin, select **Set up your integration**.
4. Select a tab to view the next setup steps for your impact.com program. When you first install the app, the **Affiliate Settings**, **Creator Settings**, and **Advocate Settings** tabs are all available alongside **Account Settings**.
{% hint style="warning" %}
**Important:** After you save your settings for the first time, the app removes any tabs you haven't configured. If you're setting up more than one program type, complete every tab you need before you select **Save**.
To set up another program type later, such as Creator or Advocate after Affiliate, contact support and ask them to make that tab visible again.
{% endhint %}
{% tabs %}
{% tab title="Account Settings" %}
Under the *Account Settings* tab, input your impact.com account settings.
See the *Settings reference* below for instructions on where to find the details needed.
**Settings reference**
| Setting | Description |
| ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Impact Account SID and Auth Token \*** | To enable this integration, verify that you have enabled [Conversion API Scopes](https://integrations.impact.com/integration-guides/for-brands/plugin-integrations/e-commerce/spaces/wMLlMoFBtKJa8ptd3zaw/pages/ttnRX5LlF952voxlvtfY#id-3.-api-scopes) within your settings, specifically the *Create conversion* endpoint. This step is required for your conversions to pass through the Shopify/impact.com integration. |
| **Universal Tracking Tag** | In the impact.com platform, navigate to  **\[User profile] → Settings → Tracking → General**. Copy the code in the Universal Tracking Tag field and paste it here. |
Alternatively, refer to your *Program Elements* document for your specific account information.
{% endtab %}
{% tab title="Affiliate Settings" %}
If you're using Performance, then input your impact.com Performance details in the *Affiliate Settings* tab.
**Settings reference**
| Setting | Description |
| ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Program ID** | Enter your Program ID. To find it, select your brand name in the upper-left corner of your impact.com account. It appears under your program name. |
| **Sale and Subscriptions Tracker \*** | In the impact.com platform, navigate to  **\[User profile] → Settings →** [**Event Types**](https://app.impact.com/secure/advertiser/tracking-settings/actiontracker/view-actiontracker-flow.ihtml). Copy the number in parenthesis next to the name of the *Online Sale* event type. |
| **Recurring Subscriptions Tracker** | Leave this field blank unless you track recurring subscriptions. To track them, follow the [Recharge](/integration-guides/for-brands/plugin-integrations/e-commerce/integrate-with-shopify/integrate-with-shopify-and-recharge-subscriptions.md) or [Bold](/integration-guides/for-brands/plugin-integrations/e-commerce/integrate-with-shopify/integrate-with-shopify-and-bold-subscriptions.md) guide instead. |
| {% endtab %} | |
{% tab title="Creator Settings" %}
If you're using Creator to compensate your creators on a CPA model, then input your impact.com Creator details in the *Creator Settings* tab.
**Settings reference**
| Setting | Description |
| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Creator Program ID** | Enter the Program ID of your Creator program. To find it, select your brand name in the upper-left corner of your impact.com account. It appears under your program name. |
| **Product Gift Tracker** | In the impact.com platform, navigate to  **\[User profile] → Settings →** [**Event Types**](https://app.impact.com/secure/advertiser/tracking-settings/actiontracker/view-actiontracker-flow.ihtml). Copy the number in parenthesis next to the name of the *Product Gift* event type. |
| **Sale and Subscriptions Tracker \*** | In the impact.com platform, navigate to  **\[User profile] → Settings →** [**Event Types**](https://app.impact.com/secure/advertiser/tracking-settings/actiontracker/view-actiontracker-flow.ihtml). Copy the number in parenthesis next to the name of the *Online Sale* event type. |
| **Recurring Subscriptions Tracker** | Leave this field blank unless you track recurring subscriptions. To track them, follow the [Recharge](/integration-guides/for-brands/plugin-integrations/e-commerce/integrate-with-shopify/integrate-with-shopify-and-recharge-subscriptions.md) or [Bold](/integration-guides/for-brands/plugin-integrations/e-commerce/integrate-with-shopify/integrate-with-shopify-and-bold-subscriptions.md) guide instead. |
{% hint style="warning" %}
**Important:** If you want to configure Product Gifting for your creator campaign, you must enter the **Product Gift Tracker** ID and take additional steps. Refer to [Integrate with Shopify for Product Gifting](/integration-guides/for-brands/plugin-integrations/e-commerce/integrate-with-shopify/integrate-with-shopify-for-product-gifting.md) for further instructions.
{% endhint %}
{% endtab %}
{% tab title="Advocate Settings" %}
If you're using Advocate, then input your impact.com Advocate details in the *Advocate Settings* tab.
* **Program ID:** Enter your Program ID value. To find this, select your brand name in the upper-left corner of your impact.com account. It appears under your program name.
* **Sale and Subscriptions Tracker:** Input the Event Type ID for your **Online Sale** event. To find your Event Type ID:
* From the top navigation bar, select  **\[User profile] → Settings**.
* Under *Tracking*, select [**Event Types**](https://app.impact.com/secure/advertiser/tracking-settings/actiontracker/view-actiontracker-flow.ihtml).
* Your Event Type ID is in parentheses next to the event name. e.g., Online Sale (xxxxxx)
* **Recurring Subscriptions Tracker:** Leave this field blank.
* **Widget page URL:** If you enter a URL, a button is added to your thank-you page that redirects customers to the referral widget page.
* **Widget button text:** Enter the text for the button that redirects customers to the widget page. The default is "Refer a friend."
* Save your changes when you're done.
A new Shopify page will be set up for you based on your selections. If you want to edit this page after setup, please reach out to our [support team](mailto:saasquatch-support@impact.com) for assistance.
{% endtab %}
{% endtabs %}
{% hint style="success" %}
**Note:** This integration does not overwrite any existing or new notes you apply to customers in Shopify. Any customer notes you had will remain untouched, and new notes can be created manually.
{% endhint %}
5. Select **Save**. You'll see a confirmation screen for the enabled integration, along with your impact.com account info.
Once you have fully integrated the impact.com API, you can begin end-to-end testing to ensure everything is working properly. Learn how to proceed with [End-to-End Testing](/integration-guides/end-to-end-tests.md).
## Troubleshooting
My test conversion isn't appearing in impact.com
If your test conversion isn't appearing, check the following:
* You've waited at least 30 minutes since the test conversion occurred in your Shopify store. Conversion reporting can take up to 2–4 hours during peak times — consider checking back later in a few hours.
* Your Event Type ID in Shopify exactly matches the Event Type ID in impact.com.
* Use the [OrderId (OID) Lookup](https://help.impact.com/brand/what-would-you-like-to-learn-about/platform-features/multi-program-reports/orderid-lookup-report) tool to search for the Shopify Order ID of the test order.
If the conversion still hasn't appeared after several hours, there may be something wrong with integration. Reverse the order in Shopify, verify that you've followed the installation instructions & end-to-end testing instructions closely, then try again.
irclickid doesn't always appear on my Shopify order page
The absence of `irclickid` under the *Additional Details* section on a Shopify order doesn't necessarily mean there's a problem with your tracking setup.
In some cases, `irclickid` appears, showing that the order came from an impact.com click. However, it doesn't always appear even when the order is properly tracked. This can happen because of the way the customer reached your store or settings that affect tracking.
## Modifications & reversals
Once integrated, you can modify and reverse items or entire orders in Shopify, and impact.com will update actions accordingly.
{% hint style="warning" %}
**Important:** Modifications and reversals you make in impact.com will not be sent to Shopify — we recommend always modifying or reversing items and orders in Shopify first, then confirm it was modified/reversed in impact.com's platform.
{% endhint %}
A few things to keep in mind:
* A **SKU** represents an item within an order. For example, if an order has 1 item with the SKU 1ABC23 priced at 10.00, the line item SKU amount would be 10.00.
* A **line item SKU** is a SKU with a quantity larger than 1 in an order (e.g., the order has multiples of the same item). For example, if an order has 2 items, both with the SKU 1ABC23 priced at 10.00 each, the line item SKU amount would be 20.00. **impact.com will always show the line item SKU amount**.
* When applying order-level reversals, the amount reversed from the order is distributed and weighted across all items within an order. In some cases, reversing certain amounts at the order-level could completely reverse an item if the item's price is less than the weighted amount that's applied to it.
* When applying item-level reversals after an order-level discount has already been applied, the remaining amount for the item will be weighted/deducted across the remaining items.
### Item-level reversals
When modifying a SKU in Shopify, impact.com will receive the updated `Quantity` and `Amount` and apply it to the item.
#### Example
1. Shopify reports an order to impact.com with two different SKUs that both have the same price:
| ITEM | PRICE |
| --------- | --------- |
| 1ABC23 | 10.00 |
| 9XYZ87 | 10.00 |
| **TOTAL** | **20.00** |
2. In Shopify, a 5.00 reversal is applied to this order, which is distributed across all SKUs in the order. It will now show in impact.com as:
| ITEM | PRICE |
| --------- | --------- |
| 1ABC23 | 07.50 |
| 9XYZ87 | 07.50 |
| **TOTAL** | **15.00** |
> The 5.00 is split evenly across the price of the two items in the order.
3. Let's reverse an individual line item: SKU `1ABC23` is fully reversed, which at its original price of 10.00, means that 10.00 is reduced from the order.
| ITEM | PRICE |
| --------- | --------- |
| 1ABC23 | 00.00 |
| 9XYZ87 | 05.00 |
| **TOTAL** | **05.00** |
> Since the item was already reduced at the order level, the remaining 2.50 that can't be removed from `1ABC23` (since it was already reduced) is applied evenly to the rest of the items in the order.
4. One final step: reverse `9XYZ87`, meaning 10.00 is reduced from the order. Since it's the only item left and has been reduced down to 5.00, reversing this will refund the entire order in Shopify and reverse the action in impact.com.
### Order-level reversals
#### Example
1. Shopify reports an order to impact.com with two different SKUs that both have the same price:
| ITEM | PRICE |
| --------- | --------- |
| 1ABC23 | 10.00 |
| 9XYZ87 | 10.00 |
| **TOTAL** | **20.00** |
2. In Shopify, a 5.00 reversal is applied to this order, which is distributed across all SKUs in the order. It will now show in impact.com as:
| ITEM | PRICE |
| --------- | --------- |
| 1ABC23 | 07.50 |
| 9XYZ87 | 07.50 |
| **TOTAL** | **15.00** |
The 5.00 is split evenly across the price of the two items in the order.
3. Going another step further, the order has a 15.00 reversal applied to it in Shopify. The order is fully refunded in Shopify and reversed in impact.com:
| ITEM | PRICE |
| --------- | --------- |
| 1ABC23 | 00.00 |
| 9XYZ87 | 00.00 |
| **TOTAL** | **00.00** |
## How subscription orders are tracked
The app checks whether each order is a one-time purchase or a subscription order, then picks the event type and sets the `Text2` parameter:
| Order | Event type | Text2 |
| -------------------------------------- | ------------------------------- | ----------- |
| One-time purchase | Sale and Subscriptions Tracker | Not sent |
| First subscription order | Sale and Subscriptions Tracker | `FIRST` |
| Recurring subscription order (renewal) | Recurring Subscriptions Tracker | `RECURRING` |
* Recurring subscription orders are only sent when the **Recurring Subscriptions Tracker** is set. This guide leaves it blank, so renewals aren't tracked. To track them, follow the [Recharge](/integration-guides/for-brands/plugin-integrations/e-commerce/integrate-with-shopify/integrate-with-shopify-and-recharge-subscriptions.md) or [Bold](/integration-guides/for-brands/plugin-integrations/e-commerce/integrate-with-shopify/integrate-with-shopify-and-bold-subscriptions.md) guide instead.
* The app identifies subscription orders from the order tags your subscription app adds (for example, `Subscription First Order` from Recharge or `first_order` from Bold), or from Shopify selling plans on the order's items.
* `Text2` is set per order, not per item. If an order contains both a one-time item and a subscription item, the whole order is sent with `Text2` set to `FIRST`.
* Use `Text2` to pay a different commission on first subscription orders than on one-time purchases.
## Supported parameters
The table below lists all of the supported parameters of the integration — in other words, data that impact.com captures from Shopify.
| Parameter | Example | Description |
| ------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| CampaignId | 8882 | Also known as a *Program ID*, this is the ID number for your impact.com program/campaign. |
| ActionTrackerId | 16027 | Also known as the *Event Type ID*, this is the ID number for your impact.com event type. |
| EventDate | 2020-06-18T14:33:49 | Tracks the date that the action occurred. |
| ClickId | 2uz3sQWFlxyJRcqwUx0Mo34VUkiyyO0tIzeG3U0 | This is the Click Id associated with the action. |
| CustomProfileId | 8f14e45fceea167a5a36dedd4bea2543 | If you're tracking visitor identification, this is the Custom Profile Id associated with the visitor. |
| MediaId | 12345 | Value of the "Impact Partner" order attribute, if present. |
| CreatorCampaignId | 67890 | Value of the "Impact Creator Campaign" order attribute, if present. |
| OrderId | 19796 | Shopify's order number (e.g., `#19796`), submitted as the **impact.com OID**. |
| OrderPromoCode | SAVE20 | The first discount code applied to the order. |
| CustomerId | 3222174466122 | If you're tracking and passing customer info, this is an ID number to reference the customer associated with the order. |
| CustomerEmail | 38b85baa75385758d44d3dbfd97921c32e0d09a9 | If you're tracking and passing customer info, this is the SHA1 hash of the customer's email. |
| CustomerEmailSHA256 | 9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08 | SHA256 hash of the customer's email. Sent only if the merchant allows sending customer data. |
| CustomerStatus | EXISTING or NEW | If you're tracking and passing customer info, this is the status of the customer associated with the order. |
| CurrencyCode | USD | This is the currency code for the currency recorded in the action. |
| IpAddress | 1.1.1.1 | The IP address associated with the action. |
| UserAgent | Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0 | The user agent string associated with the action. |
| IntegrationSource | Impact\_Shopify\_Plugin | Hardcoded identifier for this integration. |
| Text2 | FIRST | Subscription order type: `FIRST` on the first subscription order, `RECURRING` on later subscription orders (sent only when the Recurring Subscriptions Tracker is set). Not sent on one-time purchases. See [How subscription orders are tracked](#how-subscription-orders-are-tracked). |
| Text3 | 4f7a2e19 | Klaviyo profile ID. Sent only when Klaviyo is wired up. |
| Text4 | 5842819432 | Shopify's numeric order ID (`legacyResourceId`). Sent via GraphQL conversion. |
| Text10 | mystore.myshopify.com | The plugin's `storefront_url`. Sent when present. |
| Text22 | US | Shipping country code (`countryCodeV2`). Sent when present. |
> For item-level data, the `{i}` value is replaced with an integer (e.g., 1), and increased for each item that's reported to Impact. For example, If an order had two items, it'd report `ItemSku1`, `ItemQuantity1`, `ItemCategory1`, `ItemSubtotal1`, then `ItemSku2`, `ItemQuantity2`, etc.
| Parameter | Example | Description |
| --------------------- | -------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| ItemSku`{i}` | KS944RUR | The Shopify SKU number for an item in the action. |
| ItemQuantity`{i}` | 1 | The quantity amount for the first item in the action. |
| ItemCategory`{i}` | Wireless Bluetooth Headphones | The product's name/title in Shopify. |
| ItemSubtotal`{i}` | 60.00 | The subtotal amount of the item before taxes, shipping, and any other costs are added onto the total. |
| ItemName`{i}` | xTool M2 Color Craft Laser Cutter & Engraver | The product name of the item. |
| ItemBrand`{i}` | xTool | The brand associated with the item. |
| ItemPromoCode`{i}` | XTOOL20 | The discount code applied to the item. |
| ItemDiscount`{i}` | 19.69 | The discount amount applied to the item. |
| ItemDiscountRate`{i}` | 2.38 | The markdown rate of the item: the discount amount as a percentage of the item price. |
| ItemOnSale`{i}` | true | Whether the item was on sale (`true` or `false`). |
### Track subcategory orders
While the Shopify app does not currently support passing a "subcategory" parameter directly at the order level, you can still utilize subcategories by leveraging your **Shopify Product Catalog** and setting up payout groups for subcategories.
Because the subcategory data is synced from your catalog rather than the order itself, you must use a specific field mapping when setting up your payout groups.
#### Set up subcategory-based payouts
To use subcategory data for your payout logic, follow these steps:
1. **Verify your Shopify catalog sync:** Ensure your Shopify Product Catalog is [active and synced](https://help.impact.com/brand/what-would-you-like-to-learn-about/platform-features/product-catalogs/add-product-catalogs-as-a-brand#integrated-shopping-cart-import) with your impact.com account. This allows the platform to automatically associate every ordered item with its corresponding catalog details.
2. **Access Payout Groups:** Within your contract configuration, set to your [subcategory payout group](https://help.impact.com/brand/what-would-you-like-to-learn-about/platform-features/contracts-and-template-terms/template-terms/payout-adjustments/set-payout-rules-using-payout-groups). When creating a new rule, select the following field to trigger your subcategory logic:
* `Item catalog subcategory`
3. **Enter Subcategory Values:** Input the subcategory names exactly as they are defined in your Shopify admin (e.g., "Accessories" or "Home Decor").
4. **Verify via Reporting:** To confirm the data is flowing correctly, reference the [Advanced Action Listing Report](https://help.impact.com/brand/what-would-you-like-to-learn-about/platform-features/multi-program-reports/performance-reports-for-brands/advanced-action-listing-report). This report displays the specific subcategory data associated with each action, allowing you to audit your payout groups and ensure items are being categorized as expected.
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://integrations.impact.com/integration-guides/for-brands/plugin-integrations/e-commerce/integrate-with-shopify.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
