Catalog product data

Ecommerce Developer Product Documentation

Products are searchable items. In a catalog without variants, a product is also a purchasable item.

Here’s an example of a JSON representation of a product:

 {
   "DocumentId": "product://001-red",
   "FileExtension": ".html",
   "ec_name": "Coveo Soccer Shoes - Red",
   "model": "Authentic",
   "ec_brand": ["Coveo"],
   "ec_description": "<p>The astonishing, the original, and always relevant Coveo style.</p>",
   "color": ["Red"],
   "ec_item_group_id": "001",
   "productid": "001-red", 1
   "ec_images": ["https://myimagegallery?productid"],
   "gender": "Men",
   "ec_price_dict": { 2
        "": "28.00",
        "store1": "28.00",
        "store2": "30.00"
   },
   "ec_category": "Soccer Shoes",
   "objecttype": "Product" 3
 }

The above JSON contains generic information about the Coveo Soccer Shoes - Red product, such as its description, image, and price. The use of standard fields improves your experience throughout Coveo.

1 The productid is the unique identifier of your product. In your catalog, this metadata may have a different label.
2 The ec_price_dict is a dictionary field that can be used in an environment where products need to have different prices (e.g., price based on location or seasonal pricing) for a single item, instead of sending a single price value (see Dictionary fields).
3 The objecttype metadata is crucial, as it will be used to identify the item as a product in the index.
Tip
Leading practice

In your catalog content, avoid using the same field name that you intend to use as facets, on different types of items. For example, if you’re defining the color at a product level, then you shouldn’t define the color at the variant level. If you need to include a field at both levels, prefix it with product and variant (e.g, productcolor, variantcolor) so that they’re different in the index.

Create additional product fields

Sources using Coveo’s native connectors come with a set of default system fields. If you need to create more fields, see Create additional commerce fields.

Stream your catalog data to your source

You must then stream your catalog data to your source.

Review and inspect your indexed products

The Content Browser (platform-ca | platform-eu | platform-au) is a basic Coveo demo search interface to help you navigate and inspect the content of your Coveo organization sources.

For instructions on accessing the Content Browser and making use of its many features, see Inspect items with the Content Browser.