Setup checklist

This is for:

Developer System Administrator Merchandising Hub Implementer

This article provides a checklist to verify that your Coveo for Commerce implementation includes all the essential components for a fully functional and optimized setup.

Note

This checklist supports only implementations that target the Commerce API.

Map your storefront architecture

Before you start setting up Coveo for Commerce, you must map your storefront architecture in a way that’s compatible with Coveo.

For more information on how to map your storefront architecture to Coveo, see Map your storefront architecture to Coveo.

Product catalog indexing

  1. Have you ensured that all your products, their variants, and the various availability channels are correctly indexed within your Catalog source? See Push and update your catalog data for details.

    • If you’re supporting multiple combinations of languages and currencies, have you created a Catalog source for each combination?

    • If your product offering differs depending on regions (for example, different products in different countries), have you created a Catalog source for each region?

  2. Are the standard commerce fields appropriately mapped to relevant metadata in your catalog configuration?

  3. Have you set up fields to help you structure your catalog entity with products, variants and/or availability, and mapped them to the relevant metadata? See catalog structure fields for details.

  4. Have you created and mapped additional commerce fields with relevant metadata?

  5. Is your catalog entity fully configured to support your products, variants, and availabilities?

    • If you’re supporting multiple combinations of languages and currencies, have you created a catalog entity for each combination?

    • If your product offering differs depending on regions (for example, different products in different countries), have you created a catalog entity for each region?

  6. Have you implemented a system that allows for convenient updates without requiring you to re-upload your entire catalog data every time?

Define storefront associations

  1. Have you identified every locale that each storefront supports?

  2. Have you defined your storefront associations using the Storefront Associations (platform-ca | platform-eu | platform-au) page?

Log commerce events

It’s crucial that you track touchpoints to analyze storefront performance, create reports, and power Coveo Machine Learning (Coveo ML).

At this stage, start logging events from your existing storefront before you build your Coveo-powered interfaces. Use the following checks to validate this early event collection. After you build these interfaces, validate their event tracking again before launch.

Tip
Leading practices

  • Building commerce interfaces with a Coveo UI library, such as Coveo Headless, considerably simplifies the implementation of commerce events tracking.

    In particular, the Coveo Headless Commerce controllers automatically log specific commerce events that track behaviors, such as when a purchase is made or when a product is added to a cart.

  • Start logging commerce events as early as possible, before you configure Coveo ML models and build your commerce interfaces, and ideally before go-live. If your storefront isn’t yet integrated with Coveo, you can use Relay to start logging commerce events from your current storefront. Logging events early provides two key benefits:

    • You collect behavioral data that Coveo ML models can use once configured, helping improve relevance at launch.

    • You establish a baseline of your storefront’s performance before Coveo is live, which lets you measure the impact of your Coveo for Commerce implementation.

  1. Are product clicks being logged?

  2. Are product views being logged?

  3. Are products being added/removed from the cart being logged?

    • If products can be added to a cart directly from the search results page, product listing pages, or recommendation slots, are you sending an additional click event?

  4. Are purchases being logged?

  5. Have you performed data validation to ensure that the events are being sent to Coveo and contain accurate information?

For more information on how to log commerce events, see Log commerce events.

Configure Coveo ML

  1. Have you configured the recommended Coveo ML models for each product discovery interface that you’ve built?

    • Are the models associated with the correct query pipelines?

  2. When using product grouping to group products in commerce interfaces, have you done the required configurations? See Product grouping for all configuration details.

Build commerce interfaces

Your storefront visitors use commerce interfaces to search, browse, and purchase products. Each of these interfaces is powered by a product discovery solution.

  1. Have you built and configured your commerce search pages?

    • Once you’ve built and configured your search pages, have you verified that search requests being sent to the Coveo Commerce API?

  2. Have you built and configured your commerce product listing pages?

    • Once you’ve built and configured your product listing pages, have you verified that product listing requests are being sent to the Coveo Commerce API?

  3. Have you built and configured your commerce recommendation interfaces?

    • Once you’ve built and configured your recommendation interfaces, have you verified that recommendation requests are being sent to the Coveo Commerce API?

  4. Before launch, have you tested complete user journeys, from product discovery through purchase, in each Coveo-powered interface and confirmed that the expected commerce events are sent to Coveo?

    • Have you repeated data validation to confirm that the events accurately represent interactions with your Coveo-powered interfaces?

  5. Do your commerce interfaces comply with Coveo’s SEO best practices?

Tip
Leading practice

  • Building commerce interfaces with a Coveo UI library, such as Coveo Headless, considerably simplifies the implementation process.

  • Coveo Headless allows you to build server-side rendered commerce interfaces, which enhances performance and SEO. See Headless commerce usage (server-side rendering) for details.

Commerce authentication

Important

Ensure that the chosen authentication method doesn’t specify a search hub value. In Coveo for Commerce implementations, this is automatically handled by the Coveo Commerce API.

Coveo Merchandising Hub

See Coveo Merchandising Hub (CMH) for more information.