Commerce Foundation Catalog
A Commerce Server 2009 Catalog commerce entity is an organizational unit in a site, acting as a container and logical grouping for all CatalogEntities (categories, products, and product variants). All objects retrieved from the Catalog System belong to a Catalog. The properties of a Catalog apply to all child objects.
Model
This commerce entity can be modified, as required. This model, taken from the out-of-the-box site, is provided as an example.
<CommerceEntity name="Catalog">
<DisplayName value="Catalog" />
<EntityMappings>
<EntityMapping csType="Microsoft.CommerceServer.Catalog.ProductCatalog" csAssembly="Microsoft.CommerceServer.Catalog" >
<PropertyMappings>
<PropertyMapping property="Id" csProperty="CatalogName"/>
<PropertyMapping property="ActiveLanguage" csProperty="ActiveLanguage"/>
<PropertyMapping property="IsVirtualCatalog" csProperty="IsVirtualCatalog"/>
<PropertyMapping property="DisplayName" csProperty="DisplayName" />
<PropertyMapping property="DefaultLanguage" csProperty="DefaultLanguage" />
<PropertyMapping property="Currency" csProperty="Currency" />
<PropertyMapping property="EndDate" csProperty="EndDate" />
<PropertyMapping property="StartDate" csProperty="StartDate" />
<PropertyMapping property="WeightMeasure" csProperty="WeightMeasure" />
<PropertyMapping property="InternalId" csProperty="CatalogId" />
<PropertyMapping property="Languages" csProperty="Languages" />
</PropertyMappings>
</EntityMapping>
</EntityMappings>
<Properties>
<remove name="Locale"/>
<remove name="VariantId"/>
<remove name="ProductId"/>
<remove name="CatalogFlags"/>
<remove name="ProductTableUpdated"/>
<remove name="ReportingLanguage"/>
<remove name="VirtualCatalogStatus"/>
<Property name="IsVirtualCatalog" dataType="Boolean" isStronglyTyped="true"/>
<Property name="ActiveLanguage" dataType="String" isStronglyTyped="true"/>
<Property name="DisplayName" dataType="String" />
<Property name="Id"dataType="String"/>
<Property name="DefaultLanguage" dataType="String" />
<Property name="Currency" dataType="String" />
<Property name="EndDate" dataType="Date" />
<Property name="StartDate" dataType="Date" />
<Property name="WeightMeasure" dataType="String" />
<Property name="InternalId" dataType="Integer" />
<Property name="Languages" dataType="Array" isStronglyTyped="true"/>
</Properties>
</CommerceEntity>
Properties
Property |
Type |
Description |
|---|---|---|
ActiveLanguage |
String |
Active language for this catalog instance. |
Currency |
String |
Currency for this catalog. |
DefaultLanguage |
String |
Default language for this catalog. |
DisplayName |
String |
Display name for this catalog in the current active language or default language, if no value is set for the active language. |
EndDate |
DateTime? |
Date after which this catalog should not be available. |
Id |
String |
Unique identifier of the commerce entity. This value is the catalog name. |
InternalId |
int |
Maps to the Commerce Server objects CatalogId property, it unique database key. |
IsVirtualCatalog |
bool? |
Type of Catalog. If True: catalog is virtual |
Languages |
String[] |
String array of the enabled languages for this catalog. |
StartDate |
DateTime? |
Date on which this catalog should be available. |
WeightMeasure |
String |
Weight measure assigned for this catalog. |
Relationships
Property |
Description |
|---|---|
SourceCatalogs |
The source catalogs for this catalog. |
DependantCatalogs |
The dependant catalogs for this catalog. |
SearchableCategories |
A list of searchable categories for the catalog |
RootCategories |
The root category for the catalog |
Supported Operations
The following operations are supported for this catalog entity:
Commerce Foundation Catalog CommerceQuery
Commerce Foundation CatalogEntity CommerceQuery
Commerce Foundation Category CommerceQuery
Commerce Foundation Product CommerceQuery
Commerce Foundation Site CommerceQuery