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:
CatalogItemBase
Catalog
Category
SellableItem
CatalogManagedList
RelationshipDefinition
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 |
---|---|
| 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. |
| A list of the Sitecore IDs of the catalogs directly related to this Catalog entity (for example, |
| The list of parent catalog entities. |
| The list of the parent category entities. |
| The list of children category entities. |
| The list of children sellable item entities. |
| The list of variations of the sellable item. |
| 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 |
---|---|
| 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. |
| The name of the price book associated with this catalog. |
| The name of the default inventory set for this catalog. |
| 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 |
---|---|
| 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. |
| 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 |
---|---|
| 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. |
| A generic product identifier, for example ISBN. |
| A description of the sellable item. |
| The manufacturer of the sellable item. |
| The brand. |
| The type of good the item belongs to. |
| 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. |