Creating a Coveo Commerce Catalog

A Coveo commerce catalog defines the structure of commerce-related items in your index. In other words, it establishes relationships between a set of items representing catalog products, variants, and availability channels.

In a commerce-enabled Coveo organization, members of the Administrators built-in group can use the Catalogs page to initially create catalogs, and come back anytime to manage them.

You can also create catalogs using the Catalog API.

Step 1: Add a New Catalog

To add a new catalog

  1. Access the Catalogs page.

  2. Click Add catalog. This will open the Add a catalog panel.

  3. Enter a suitable Name for your catalog (e.g., acme-full-catalog).

    This name appears in the catalog list in the Administration Console. It can also be used to reference the catalog when querying its content from a search interface.

  4. (Optional) Enter a suitable Description for your catalog (e.g., The various products and services offered by the ACME Corporation).

  5. In the Associated Sources drop-down menu, select one or multiple sources to filter items in the catalog preview.

    The selected sources only affect the scope of the catalog preview. They have no effect on other search interfaces.

  6. Define the hierarchy of your products as desired:

    • If all of your sellable items are all uniquely identifiable, select Standard product.

      Product ID
      Red Lazer Headphones 0001
      Blue Lazer Headphones 0002
    • If some or all of your sellable items are offered in different variations (e.g., color, size), select Product with variants.

      Product ID SKU
      Lazer Headphones 0001 N/A
      Variant ID SKU
      Red Lazer Headphones 0001 SKU0001
      Blue Lazer Headphones 0001 SKU0002
  7. Define your channel as desired:

    • If all of your products are available from a unique distribution channel, select Single channel.

    • If the availability of some or all of your products may vary depending on certain factors (e.g., customer location, distribution structure), select Multiple channels.

      Channel Available products
      Québec Store 0001, 0002
      London Store 0001
  8. Click Add catalog.

Once your Commerce Catalog is created, stream your catalog data into the source once more. This ensures that the catalog is properly registered.

Step 2: Define Your Products, Variants, and Availability Channels

New catalogs are automatically configured with default object types and relationships.

To customize the object types and fields that define your catalog

  1. On the Catalogs page, click the catalog you created in step 1, and then in the Action bar, click Edit.

  2. In the Product tab:

    1. Configure your products.

    2. If the Variants Structure section is visible, configure your variants.

  3. If the Availability tab is visible, select it and configure your availability channels.

The visible tabs and sections depend on the product hierarchy structure and distribution channel structure you selected when you created your catalog in step 1.

Configure Your Products

In the Products section:

  1. In the first drop-down menu, select the objecttype field value that identifies items as products in your index (e.g., Product).

  2. In the second drop-down menu, select the field that uniquely identifies each distinct product (e.g., productid).

    • Ensure that the selected field has the Facet and Use cache for nested queries settings enabled.

    • If the catalog hierarchy has variants, the product unique identifier will link each variant to its parent product. Select a field whose value is the same for any given product and all of its variants.

    • If your catalog hierarchy has no variants, but many channels, the product unique identifier will link each product to the channels it’s available in. Select a field whose value for any given product is also contained in the values of a listing field on each channel in which this product is available.

Configure Your Variants

In the Variants Structure section:

  1. In the first drop-down menu, select the objecttype field value that identifies items as variants in your index (e.g., Variant).

  2. In the second drop-down menu, select the field that uniquely identifies each distinct variant (e.g., sku).

    • Ensure that the selected field has the Facet and Use cache for nested queries settings enabled.

    • If your catalog hierarchy has many channels, the variant unique identifier will link each variant to the channels it’s available in. Select a field whose value for any given variant is also contained in the values of a listing field on each channel in which this variant is available.

Configure Your Availability Channels

In the Define your channel section:

  1. Select the objecttype field value that identifies items as availability channels in your index (e.g., Store).

  2. Select the field to use to uniquely identify each availability channel in your index (e.g., availabilityid)

    Ensure that the selected field has the Facet and Use cache for nested queries settings enabled.

  3. Select the multi-value field that lists all sellable items (product or variants) available from each distinct availability channel (e.g., availableskus).

    • Ensure that the selected field has the Multi-value facet and Use cache for nested queries settings enabled.

    • If your catalog hierarchy has variants, the listing field should contain one or more variant unique identifiers. Otherwise, it should contain one or more product unique identifiers.

Recommended Articles