Catalog Availability Data

Ecommerce Developer Product Documentation

An availability determines whether a given user can purchase a given product or variant. An availability can be a store inventory, a price list, or anything that controls which user has access to certain products or variants.

Here’s an example of a possible JSON representation of an availability for a common business-to-consumer (B2C) scenario where a local store contains a finite amount of products:

 {
    "DocumentId": "store://s000002",
    "ec_name": "Montreal Store",
    "lat": 45.4975,
    "long": -73.5687,
    "availableskus": ["001-red-8_wide","001-red-9_wide","001-red-10_wide","001-red-11_wide", "001-blue-8_wide"], 1
    "availabilityid": "s000002", 2
    "objecttype": "Availability" 3
 }

The above JSON contains generic information about the store location lat, long, and store name name.

1 The availableskus metadata defines which variants or products are available through a given channel. In your original catalog, these may have different labels.
2 In both scenarios, the availabilityid metadata uniquely identifies each availability channel or price list.
3 The objecttype metadata is crucial, as it’ll be used to identify the item as an availability in the index.
Note

Depending on the way you have structured your data, your availability metadata might be contained in another source. Refer to Leverage variants and availabilities for more information.
Important

When your catalog structure contains large amounts of items and requires availability channels, use the same field name (i.e. availableskus) on both the variant objecttype

{
  "DocumentId": "variant://001-red-8_wide",
  "FileExtension": ".html",
  "ec_name": "Coveo Soccer Shoes - Red / Size 8 - Wide",
  "sku": "001-red-8_wide",
  "availableskus": ["001-red-8_wide"],
  "productsize": "8",
  "width": "wide",
  "productid": "001-red",
  "objecttype": "Variant"
}

and availability channel objecttype written in an array.

{
  "DocumentId": "store://montreal",
  "FileExtension": ".html",
  "ec_name": "Montreal Store",
  "availableskus": ["001-red-8_wide", "001-red-7-narrow", "..."],
  "objecttype": "Availability"
}

This will improve the performance of your index.

Create Additional Availability 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.