---
title: Get started with the Coveo app for Shopify
slug: p2la0421
canonical_url: https://docs.coveo.com/en/p2la0421/
collection: coveo-for-commerce
source_format: adoc
---
# Get started with the Coveo app for Shopify

You can use the **Coveo AI Search & Discovery** app to add a Coveo-powered [search interface](https://docs.coveo.com/en/2741/) to your Shopify [storefront](https://docs.coveo.com/en/p33g0410/).
The setup process is mostly documented within the app itself, and it includes the following steps:

* [Link organization](#link-organization)

* [Catalog sync](#catalog-sync)

* [Storefront](#storefront)

* [Track events](#track-events)

* [Manage search rules](#manage-search-rules)

* [Manage AI models](#manage-ai-models)

This article provides additional information about these steps, where necessary, or links to relevant articles.

Each step has a corresponding tab in the app with the same functionality, although the interface may differ.
All of the screenshots in this article are from the guided setup process, but you can access any app function at any time from the relevant tab.

## Prerequisites

. To [index](https://docs.coveo.com/en/204/) your Shopify products, you need a [Coveo organization](https://docs.coveo.com/en/185/).

If you've never used the [Coveo Platform](https://docs.coveo.com/en/186/) before, [log in now](https://docs.coveo.com/en/1697/).

> **Notes**
>
> * You can't use the **Coveo AI Search & Discovery** app with a trial [Coveo organization](https://docs.coveo.com/en/185/).
> 
> * Contact your sales representative to enable the following in your [organization](https://docs.coveo.com/en/185/):
> 
> ** Coveo for Commerce extension
> 
> ** Coveo for Shopify integration

. {empty}

The following table indicates the [privileges](https://docs.coveo.com/en/228/) required for your [organization](https://docs.coveo.com/en/185/)’s [groups](https://docs.coveo.com/en/2867/) to view or edit elements of the [**Catalogs**](https://platform.cloud.coveo.com/admin/#/orgid/commerce/catalogs/) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/commerce/catalogs/) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/commerce/catalogs/) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/commerce/catalogs/)) page and its associated panels (see [Manage privileges](https://docs.coveo.com/en/3151/) and [Privilege reference](https://docs.coveo.com/en/1707/)).
The **Commerce** domain is only available to [organizations](https://docs.coveo.com/en/185/) in which Coveo for Commerce features are enabled.

[cols="3",options="header"]
|===
|Action
|Service - Domain
|Required access level

|View catalogs
|Commerce - Catalogs  
Content - Sources  
Content - Fields  
Organization - Organization
|View

.3+.^|Edit catalogs
|Content - Fields  
Content - Sources  
Organization - Organization
|View

|Commerce - Catalogs
|Edit

|Search - Execute Query
|Allowed
|===

. [Install](https://apps.shopify.com/coveo/) the **Coveo AI Search & Discovery** app in your Shopify store.
After you install it, you'll be restricted to the **Welcome** page until you [link your organization](#link-organization).

![Welcome page | Coveo app for Shopify](https://docs.coveo.com/en/assets/images/coveo-for-commerce/images/shopify/welcome-page.png)

## App home page

The home page of the **Coveo AI Search & Discovery** app has several cards with useful information.

![App home page | Coveo app for Shopify](https://docs.coveo.com/en/assets/images/coveo-for-commerce/images/shopify/app-home-page.png)

These cards include the following:

* **Setup guide**

This is a checklist of the steps to set up the **Coveo AI Search & Discovery** app.
When selected, each item displays its status and has a button which takes you to that step in the setup process.

> **Notes**
>
> * The [Storefront](#storefront) step doesn't display its status because the app can't track whether you've implemented Coveo in your storefront.
> 
> * The steps don't check themselves off automatically.
> You can check them off manually to keep track of your progress.

* **Coveo Merchandising Hub**

This card displays important data from the [Coveo Merchandising Hub (CMH)](https://docs.coveo.com/en/o5290573/).
The **View all** button takes you directly to the [Search manager](https://docs.coveo.com/en/o4nh0587/) tool in your [Coveo organization](https://docs.coveo.com/en/185/).

* **Revenue** and **Recorded events**

These cards provide insight into key metrics for monitoring the health and performance of your Coveo-powered [storefront](https://docs.coveo.com/en/p33g0410/).
You can view these metrics over the last 24 hours, 7 days, or 14 days.

Once you've started logging some revenue and event data points, you'll see a percentage next to the reported value.
This represents the change between the first and last hour of the selected reporting period, not a comparison relative to another period.
On the **Revenue** card, you'll also see a small line graph that displays the hourly revenue over the selected reporting period.

**Example**

You're looking at the app home page at 2:00 PM (14:00) UTC on January 20th.
You select **Last 7 days** from the dropdown menu.

The amount of revenue shown is $102,890, and the percentage shows an increase of 22%.
However, the percentage isn't directly related to the total revenue over the reporting period.
Instead, it compares the hourly revenue values at the beginning and end of the period.

* Hourly revenue at 2:00 PM UTC on January 13th: $550

* Hourly revenue at 2:00 PM UTC on January 20th: $671

The increase of 22% represents the difference between these two hourly revenue values.

The **View detailed revenue** button takes you to the [**Overview**](https://docs.coveo.com/en/m16b0577/) [dashboard](https://docs.coveo.com/en/256/) on the [**Advanced Reports**](https://platform.cloud.coveo.com/admin/#/orgid/usage/advanced-reports/) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/usage/advanced-reports/) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/usage/advanced-reports/) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/usage/advanced-reports/)) page of the [Coveo Administration Console](https://docs.coveo.com/en/183/).
The **Manage events** button takes you to the **Events** page of the **Coveo AI Search & Discovery** app.

## Link organization

The first step is to link your [Coveo organization](https://docs.coveo.com/en/185/) to the **Coveo AI Search & Discovery** app.
This step is mandatory, so you won't be able to leave the **Welcome** page and access the [app home page](#app-home-page) or the other steps until you complete it.

![Link your organization | Coveo app for Shopify](https://docs.coveo.com/en/assets/images/coveo-for-commerce/images/shopify/link-organization.png)

> **Important**
>
> As noted in the [prerequisites section](#prerequisites), you can't use a trial [Coveo organization](https://docs.coveo.com/en/185/).
> Your [organization](https://docs.coveo.com/en/185/) also needs to have Coveo for Commerce features enabled.
> If you try to link an [organization](https://docs.coveo.com/en/185/) that's not compatible, you'll see an error message after you try to grant access and are redirected back to Shopify.

After you click **Link organization**, a **Choose organization region** modal appears.
Select your [Coveo organization](https://docs.coveo.com/en/185/)’s region and click **Link organization** again.

![Select your region | Coveo app for Shopify](https://docs.coveo.com/en/assets/images/coveo-for-commerce/images/shopify/shopify-org-region-modal.png)

You'll be redirected to the [Coveo Platform](https://docs.coveo.com/en/186/) [login screen](https://docs.coveo.com/en/1697#login-options) for your region.
After you log in, select your [Coveo organization](https://docs.coveo.com/en/185/) from the dropdown menu and click **Next**.
On the following screen, click **Authorize** to let the app access your [organization](https://docs.coveo.com/en/185/), and you'll be redirected to the **Link organization** step in the app.

![Organization linked successfully | Coveo app for Shopify](https://docs.coveo.com/en/assets/images/coveo-for-commerce/images/shopify/link-organization-success.png)

### Unlinking and relinking organizations

When you unlink a [Coveo organization](https://docs.coveo.com/en/185/) from the **Coveo AI Search & Discovery** app, all of your Shopify-related resources will be deleted from the [organization](https://docs.coveo.com/en/185/) after 48 hours.
If you relink to the same [organization](https://docs.coveo.com/en/185/) within 48 hours, these resources won't be deleted and you won't have to reconfigure your settings in the app.

If you link to another [organization](https://docs.coveo.com/en/185/), all of your Shopify-related resources in the first [organization](https://docs.coveo.com/en/185/) will be deleted immediately.
You'll have to sync your Shopify product catalog with the new [organization](https://docs.coveo.com/en/185/) and reconfigure your settings.

## Catalog sync

The second step is to sync your Shopify product catalog.
When you launch a sync, the **Coveo AI Search & Discovery** app [indexes](https://docs.coveo.com/en/oc2d1151/) all products and [variants](https://docs.coveo.com/en/q2bb0284/) that meet the prerequisites in your [Coveo organization](https://docs.coveo.com/en/185/).
It also [deploys a web pixel](#coveo-web-pixel) the first time you sync your Shopify product catalog.

Before you launch the sync, you may want to select one or more custom [fields](https://docs.coveo.com/en/200/) to [index](https://docs.coveo.com/en/204/).
If you do, you may also want to select them to use as filters (or [facets](https://docs.coveo.com/en/198/) in the [Coveo Platform](https://docs.coveo.com/en/186/)).
You'll [set up your facets](#set-up-facets) in the next step.

Later steps depend on your Shopify product catalog having been synced, and the other pages display a warning if you skip it.

![Sync your product catalog | Coveo app for Shopify](https://docs.coveo.com/en/assets/images/coveo-for-commerce/images/shopify/catalog-sync.png)

When you sync your Shopify product catalog, the app creates the following resources in your [organization](https://docs.coveo.com/en/185/):

* [Sources](https://docs.coveo.com/en/q2bb0227#sources)

* [Catalog entities](https://docs.coveo.com/en/q2bb0227#catalog-entities)

* [Fields](https://docs.coveo.com/en/q2bb0227#fields)

* [Tracking IDs and properties](https://docs.coveo.com/en/q2bb0227#tracking-ids-and-properties)

* [Storefront associations](https://docs.coveo.com/en/q2bb0227#storefront-associations)

* [Query pipelines](https://docs.coveo.com/en/q2bb0227#query-pipelines)

### Coveo web pixel

The **Coveo AI Search & Discovery** app deploys a [web pixel](https://shopify.dev/docs/api/web-pixels-api) the first time you sync your Shopify product catalog.

This web pixel must be initialized before it can log events.
[Initialize it](https://docs.coveo.com/en/oc2d1152#initialize-the-web-pixel) as soon as possible, even before you [set up your storefront](#storefront), so that it can start logging events to power your [Coveo ML](https://docs.coveo.com/en/188/) [models](https://docs.coveo.com/en/1012/).

## Storefront

The third step is to set up your storefront.
This step includes two parts:

* [Set up search page & search box](#set-up-search-page-search-box)

* [Set up facets](#set-up-facets)

![Set up your storefront | Coveo app for Shopify](https://docs.coveo.com/en/assets/images/coveo-for-commerce/images/shopify/storefront.png)

### Set up search page & search box

You can't [build a search interface](https://docs.coveo.com/en/oc2d1156/) directly in the **Coveo AI Search & Discovery** app.
Instead, the app directs you to documentation to help with your implementation.

> **Note**
>
> You won't be able to [track](#track-events) click and search events until you've implemented your [search interface](https://docs.coveo.com/en/2741/).

![Example Shopify search page | Coveo app for Shopify](https://docs.coveo.com/en/assets/images/coveo-for-commerce/images/shopify/example-shopify-search-page.png)

### Set up facets

After you sync your Shopify product catalog, you must [create a facet collection](https://docs.coveo.com/en/p3oa0420#create-a-facet-collection) to display [facets](https://docs.coveo.com/en/198/) in product discovery.

However, you can't manage [facet](https://docs.coveo.com/en/198/) settings or create [facet collections](https://docs.coveo.com/en/p5890502/) directly in the **Coveo AI Search & Discovery** app.
Instead, the app provides links to the relevant [Facet manager](https://docs.coveo.com/en/p63f0211/) tabs in the [Coveo Merchandising Hub (CMH)](https://docs.coveo.com/en/o5290573/).
It also provides links to helpful documentation resources.

![Set up facets in the Storefront step | Coveo app for Shopify](https://docs.coveo.com/en/assets/images/coveo-for-commerce/images/shopify/storefront-set-up-facets.png)

## Track events

The fourth step is to make sure that you're [tracking events](https://docs.coveo.com/en/oc2d1152/) for analytics reporting and to [create AI models](#manage-ai-models).
All of the Coveo AI [models](https://docs.coveo.com/en/1012/) require certain [events](https://docs.coveo.com/en/260/) to be tracked, with the specific events required depending on the [model](https://docs.coveo.com/en/1012/).

In the app, you can view the number of [events](https://docs.coveo.com/en/260/) that were logged over the last 24 hours, 7 days, or 14 days.

![Track events | Coveo app for Shopify](https://docs.coveo.com/en/assets/images/coveo-for-commerce/images/shopify/track-events.png)

For each [event](https://docs.coveo.com/en/260/) type, if any [events](https://docs.coveo.com/en/260/) have been logged for the selected reporting period, the **View events** button takes you to the [**Data Health**](https://platform.cloud.coveo.com/admin/#/orgid/usage/health/) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/usage/health/) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/usage/health/) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/usage/health/)) page in the [Coveo Administration Console](https://docs.coveo.com/en/183/).
On the **Data Health** page, the date range will automatically match the period selected in the app.

> **Tip**
>
> Whenever you manually navigate to the [**Data Health**](https://platform.cloud.coveo.com/admin/#/orgid/usage/health/) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/usage/health/) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/usage/health/) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/usage/health/)) page, it always defaults to displaying [events](https://docs.coveo.com/en/260/) from the past week, excluding the current day.

![Administration Console: Data health page | Coveo Platform](https://docs.coveo.com/en/assets/images/coveo-for-commerce/images/shopify/admin-console-data-health-page.png)

## Manage search rules

The fifth step is to add merchandising rules to determine how products are queried and displayed.
This step isn't mandatory, and you can move on to [create AI models](#manage-ai-models) without setting up any rules.

The buttons on this page take you to the [Coveo Merchandising Hub (CMH)](https://docs.coveo.com/en/o5290573/) [Search manager](https://docs.coveo.com/en/o4nh0587/) tool in your [Coveo organization](https://docs.coveo.com/en/185/), where you can review queries and create or modify rules.

![Manage search rules | Coveo app for Shopify](https://docs.coveo.com/en/assets/images/coveo-for-commerce/images/shopify/manage-search-rules.png)

## Manage AI models

The final step is to create the AI [models](https://docs.coveo.com/en/1012/) that will power your [storefront](https://docs.coveo.com/en/p33g0410/)’s [search interface](https://docs.coveo.com/en/2741/).

![Manage AI models | Coveo app for Shopify](https://docs.coveo.com/en/assets/images/coveo-for-commerce/images/shopify/manage-ai-models.png)

The buttons on this page take you directly to the creation tool for each type of [model](https://docs.coveo.com/en/1012/) in the [Coveo Administration Console](https://docs.coveo.com/en/183/).

![Administration Console: AI model creation tool | Coveo Platform](https://docs.coveo.com/en/assets/images/coveo-for-commerce/images/shopify/admin-console-ai-model-creation-tool.png)

Every [model](https://docs.coveo.com/en/1012/) has its own set of [events](https://docs.coveo.com/en/260/) that must be tracked, and you can verify that you've recorded the necessary [events](https://docs.coveo.com/en/260/) in the collapsible **Prerequisites** section for each one.

![Collapsible AI model prerequisites section | Coveo app for Shopify](https://docs.coveo.com/en/assets/images/coveo-for-commerce/images/shopify/ai-model-prerequisites.png)

## Uninstall and reinstall the app

If you uninstall the **Coveo AI Search & Discovery** app without unlinking your [Coveo organization](https://docs.coveo.com/en/185/) and then reinstall the app within 48 hours (before the Shopify-related resources have been automatically deleted from your [organization](https://docs.coveo.com/en/185/)), your [organization](https://docs.coveo.com/en/185/) will still appear to be linked and your Shopify product catalog will initially appear to be synced.

However, each installation generates new API keys for [authenticating](https://docs.coveo.com/en/2120/) with the [Coveo Platform](https://docs.coveo.com/en/186/).
You won't be able to launch a manual sync or access the **Events**, **Search**, or **Models** pages of the app.

![Catalog sync error after uninstalling and reinstalling the app | Coveo app for Shopify](https://docs.coveo.com/en/assets/images/coveo-for-commerce/images/shopify/catalog-sync-error.png)

You'll have to manually [unlink and relink](#unlinking-and-relinking-organizations) your [organization](https://docs.coveo.com/en/185/) to resolve the [authentication](https://docs.coveo.com/en/2120/) error and begin using the **Coveo AI Search & Discovery** app again.