Item Catalog

A catalog is a group of items with a structure defined by one or more item schemas.

Definition

Registering a catalog creates a version. Only one catalog version can be activated. The activated catalog version is set to "active" and will be used by the search and recommendation. Only 2 catalogs at the same time are managed by the API. If this limit is reached, one catalogue must be deleted to create another one.

Having different versions of the catalog allows preparing a version to be activated, or to go back and activate an old version.

Structure

Name	type	Description
tenant	string	Tenant of the account
environment	string	Environment to use
version	integer	Automatically created
name	string	Optional catalog name
state		List of states: INACTIVE, ACTIVATING, ACTIVE
catalogItemSchemas	list	List of itemSchema used in the catalog
catalogCategoryTrees	list	List of categoryTreed used in the catalog

The catalog_item_schemas and catalogCategoryTrees fields are a list of objects containing the name and version of the item schema/category tree and should look like this:

[
    {
        "name": "product",
        "version": 2
    }
]