Catalog service
The Catalog service is provided by the Sitecore.Commerce.Plugin.Catalog.
The Catalog service capabilities include:
- managing and storing standardized catalogs or lists of catalogs
- managing and storing categories within catalogs
- creating and managing sellable items, including product bundles
- associating sellable items to multiple catalogs, and to categories within catalogs
- associating sellable items from multiple catalogs to product bundles
- calculating bulk pricing for a catalog item
- managing and storing list pricing for a sellable item, in multiple currencies
Catalog entities
The Catalog plugin defines the following entity classes:
CatalogItemBaseCatalogCategorySellableItemCatalogManagedListRelationshipDefinition
CatalogItemBase
The CatalogItemBase class inherits from the core CommerceEntity class, and represents the base class for all catalog item entities.
Properties of the CatalogItemBase class are:
| Property | Definition |
|---|---|
SitecoreId | A unique identifier (string) that allows to map an instance of a catalog item in Sitecore Content Editor back to its original Commerce entity ID in the Commerce Engine. Used in the catalog mappings system. |
CatalogToEntityList | A list of the Sitecore IDs of the catalogs directly related to this Catalog entity (for example, CatalogToCategory or CatalogToSellableItem relationship). |
ParentCatalogList | The list of parent catalog entities. |
ParentCategoryList | The list of the parent category entities. |
ChildrenCategoryList | The list of children category entities. |
ChildrenSellableItemList | The list of children sellable item entities. |
ItemVariations | The list of variations of the sellable item. |
IsBundle | Specifies whether the item is a bundle. |
Catalog
The Catalog class inherits from the core CatalogItemBase class, and defines the Catalog entity.
Properties of the Catalog entity class are:
| Property | Definition |
|---|---|
SitecoreId | A unique identifier (string) that allows to map an instance of a catalog item in Sitecore Content Editor back to its original Commerce entity ID in the Commerce Engine. Used in the catalog mappings system. |
PriceBookName | The name of the price book associated with this catalog. |
DefaultInventorySetName | The name of the default inventory set for this catalog. |
PromotionBookName | The name of the promotion book. |
Category
The Category class inherits from the core CatalogItemBase class, and defines the Category entity.
Properties of the Category entity class are:
| Property | Definition |
|---|---|
SitecoreId | A unique identifier (string) that allows to map an instance of a catalog item in Sitecore Content Editor back to its original Commerce entity ID in the Commerce Engine. Used in the catalog mappings system. |
Description | The description of a category. |
CatalogManagedList
The CatalogManagedList class and defines a specialized list to enumerate catalog items.
Properties of the CatalogManagedList entity class are:
| Property | Definition |
|---|---|
SitecoreId | A unique identifier (string) that allows to map an instance of a catalog item in Sitecore Content Editor back to its original Commerce entity ID in the Commerce Engine. Used in the catalog mappings system. |
ProductID | A generic product identifier, for example ISBN. |
Description | A description of the sellable item. |
Manufacturer | The manufacturer of the sellable item. |
Brand | The brand. |
TypeOfGood | The type of good the item belongs to. |
Tags | A list of item tags used to categorize the item. Tags can serve a purpose in fulfillment, for example, to indicates if an item is a tangible product, a service, a digital item, and so on. |