CatalogGroup noun is used to model a catalog group (or category).
A catalog group represents a node in a catalog hierarchy or a tree. A node has a parent and can have zero or more child
catalog groups or catalog entries.
CatalogGroup noun is used by the Catalogs Tool at authoring time, and the store front at runtime.
BOD | Action Code / Access Profile | Action Expression | Service Provided | Sample XML Message | Client Library / Expression Builder |
---|---|---|---|---|---|
ProcessCatalogGroup | Create | /CatalogGroup[i] |
Creates a new catalog group in the master or sales catalog. Exceptions: An error results if one of the following conditions occurs:
|
Request
Response |
CatalogGroupFacadeClient.processCatalogGroup(ProcessCatalogGroupType) |
Delete | /CatalogGroup[i] |
Marks for delete a catalog group in the database. Exceptions: An error results if one of the following conditions occurs:
|
Request
Response |
CatalogGroupFacadeClient.processCatalogGroup(ProcessCatalogGroupType) | |
Link | /CatalogGroup[i] |
Links catalog groups between a sales catalog and another sales or master catalog. The source catalog can be a sales or
master catalog, but the target catalog must be a sales catalog. Exceptions: An error results if one of the following conditions occurs:
|
LinkToParentCategoryRequest LinkToParentCategoryResponseLinkAsTopCategoryRequest LinkAsTopCategoryResponse |
CatalogGroupFacadeClient.processCatalogGroup(ProcessCatalogGroupType) | |
UnLink | /CatalogGroup[i] |
Removes links between catalog groups in a sales catalog and another sales or master catalog. The source catalog can be
a sales or master catalog, but the target catalog must be a sales catalog. Exceptions: An error results if one of the following conditions occurs:
|
UnLinkNonTopCategoryRequest UnLinkNonTopCategoryResponseUnLinkTopCategoryRequest UnLinkTopCategoryResponse |
CatalogGroupFacadeClient.processCatalogGroup(ProcessCatalogGroupType) | |
Copy | /CatalogGroup[i] |
Duplicates a catalog group structure from a source master or sales catalog to the target sales catalog. Exceptions: An error results if one of the following conditions occurs:
|
Request
Response |
CatalogGroupFacadeClient.processCatalogGroup(ProcessCatalogGroupType) | |
ChangeCatalogGroup | Change | /CatalogGroup[i] |
Updates the following catalog group attributes in the master or sales catalog:
|
Request
Response |
CatalogGroupFacadeClient.changeCatalogGroup(ChangeCatalogGroupType) |
Change | /CatalogGroup[i]/CatalogGroupIdentifier |
Updates the identifier field of a catalog group in the master or sales catalog. Exceptions: An error results if one of the following conditions occurs:
|
Request
Response |
CatalogGroupFacadeClient.changeCatalogGroup(ChangeCatalogGroupType) | |
Change | /CatalogGroup[i]/Description[i] |
Updates the description of a catalog group in the master or sales catalog. If the description to be updated is not found
in the database, a new description is created. The description is locale-dependant data. The following description fields can be updated using this action:
|
Request
Response |
CatalogGroupFacadeClient.changeCatalogGroup(ChangeCatalogGroupType) | |
Change | /CatalogGroup[i]/SEOURL[i] |
Creates or updates the SEO URL of a catalog group in a given language Exceptions: An error results if one of the following conditions occurs:
|
Request
Response |
CatalogGroupFacadeClient.changeCatalogGroup(ChangeCatalogGroupType) | |
Change | /CatalogGroup[i]/SEOProperties[i] |
Creates or updates the SEO properties of a catalog group in a given language The following values can be changed:
|
Request
Response |
CatalogGroupFacadeClient.changeCatalogGroup(ChangeCatalogGroupType) | |
Add | /CatalogGroup[i]/SEOURL[i] |
Creates or updates the SEO URL of a catalog group in a given language Exceptions: An error results if one of the following conditions occurs:
|
Request
Response |
CatalogGroupFacadeClient.changeCatalogGroup(ChangeCatalogGroupType) | |
Delete | /CatalogGroup[i]/SEOURL[i] | Deletes the SEO URL of a catalog group in a given language. |
Request
Response |
CatalogGroupFacadeClient.changeCatalogGroup(ChangeCatalogGroupType) | |
Delete | /CatalogGroup[i]/SEOProperties[i] | Deletes the SEO properties of a catalog group in a given language. |
Request
Response |
CatalogGroupFacadeClient.changeCatalogGroup(ChangeCatalogGroupType) | |
Change | /CatalogGroup[i]/ParentCatalogGroupIdentifier |
Changes the parent of a catalog group or sets the given catalog group as the top-level catalog group in the master catalog.
If the catalog group whose parent has to be changed does not have an existing parent, the new parent relationship is created. Republishes the affected product sets of the parent and ancestors catalog groups where needed. Changes the display sequence of a top-level catalog group under sales catalog. Exceptions: An error results if one of the following conditions occurs:
|
Request
Response |
CatalogGroupFacadeClient.changeCatalogGroup(ChangeCatalogGroupType) | |
Add | /CatalogGroup[i]/ParentCatalogGroupIdentifier |
Adds a new parent catalog group to a given catalog group in the sales catalog. Only the relation is created. More than
one parent cannot be added to a given catalog group. Sets a catalog group to a top-level catalog group in the sales catalog. Exceptions: An error results if one of the following conditions occurs:
|
Request
Response |
CatalogGroupFacadeClient.changeCatalogGroup(ChangeCatalogGroupType) | |
Delete | /CatalogGroup[i]/ParentCatalogGroupIdentifier |
Deletes the parent catalog group of a catalog group in the sales catalog. Only the relation is removed. Sets a catalog group to a non top-level catalog group in the sales catalog. Exceptions: An error results if one of the following conditions occurs:
|
Request
Response |
CatalogGroupFacadeClient.changeCatalogGroup(ChangeCatalogGroupType) | |
Change | /CatalogGroup[i]/NavigationRelationship[i] |
Changes the display sequence of the following relationships in the master or sales catalog:
|
Request
Response |
CatalogGroupFacadeClient.changeCatalogGroup(ChangeCatalogGroupType) | |
Add | /CatalogGroup[i]/NavigationRelationship[i] |
Adds a child catalog group or child catalog entry to a given catalog group in the sales catalog. Exceptions: An error results if one of the following conditions occurs:
|
Request
Response |
CatalogGroupFacadeClient.changeCatalogGroup(ChangeCatalogGroupType) | |
Delete | /CatalogGroup[i]/NavigationRelationship[i] |
Deletes the child catalog group or child catalog entry of a given catalog group in the sales catalog. Exceptions: An error results if one of the following conditions occurs:
|
Request
Response |
CatalogGroupFacadeClient.changeCatalogGroup(ChangeCatalogGroupType) | |
GetCatalogGroup | All access profiles listed in the 'Access Profile' section can be applied to this expression. | /CatalogGroup[@topCatalogGroup='true'] |
Get top level categories. Returns the top-level categories for the catalog ID and store ID in the context. |
Request
Response |
getTopCategoriesDetails |
All access profiles listed in the 'Access Profile' section can be applied to this expression. |
/CatalogGroup[CatalogGroupIdentifier[ (UniqueID=$uniqueId$)]] |
Get Catalog Group by Unique ID. Returns the catalog group for the given unique ID. |
Request
Response |
getCatalogGroupSummaryByIDs getCatalogGroupSummaryByID getCatalogGroupDetailsByIDs getCatalogGroupDetailsByID getCatalogGroupMerchandisingAssociationsByID getCategoryWithChildrenCategories getCategoryWithChildrenCatalogEntries getCategoryWithAllChildren | |
All access profiles listed in the 'Access Profile' section can be applied to this expression. |
/CatalogGroup[CatalogGroupIdentifier[ ExternalIdentifier[( GroupIdentifier=$groupIdentifier$)]]] |
Get Catalog Group by Identifier. Returns the catalog group for the given identifier. |
Request
Response |
getCatalogGroupSummaryByIdentifier getCatalogGroupDetailsByIdentifier getCatalogGroupMerchandisingAssociationsByIdentifier | |
All access profiles listed in the 'Access Profile' section can be applied to this expression. |
/CatalogGroup[CatalogGroupIdentifier[ ExternalIdentifier[(@ownerID=$ownerId$ and GroupIdentifier=$groupIdentifier$)]]] |
Get Catalog Group by Identifier and Member ID. Returns the catalog group for the given identifier and member ID. |
Request
Response |
CatalogGroupFacadeClient.getCatalogGroup(GetCatalogGroupType) | |
All access profiles listed in the 'Access Profile' section can be applied to this expression. |
/CatalogGroup[ParentCatalogGroupIdentifier[ (UniqueID=$groupIdentifier$)]] /CatalogGroup[ParentCatalogGroupIdentifier[ ExternalIdentifier[( GroupIdentifier=$groupIdentifier$)]]] |
Get child categories of a Catalog Group. Returns the child categories for the given catalog group unique ID or identifier, under the catalog ID in the context. |
Request
Response |
getCatalogGroupDetailsByParentCatalogGroupId | |
All access profiles listed in the 'Access Profile' section can be applied to this expression. |
/CatalogGroup[NavigationRelationship[ CatalogEntryReference[CatalogEntryIdentifier[ (UniqueID=$uniqueId$ and type='child')]]]] /CatalogGroup[NavigationRelationship[ CatalogEntryReference[CatalogEntryIdentifier[ ExternalIdentifier[(PartNumber= $partNumber$ and type='child')]]]]] |
Get Parent Catalog Group(s) of Catalog Entry. Returns the parent catalog groups for the given catalog entry unique ID or part number, under the catalog ID in the context. |
Request
Response |
getParentCatalogGroupsOfCatentryById | |
All access profiles listed in the 'Access Profile' section can be applied to this expression. |
/CatalogGroup[NavigationRelationship[ CatalogGroupReference[CatalogGroupIdentifier[ (UniqueID=$uniqueId$ and type='child')]]]] /CatalogGroup[NavigationRelationship[ CatalogGroupReference[CatalogGroupIdentifier[ ExternalIdentifier[(GroupIdentifier= $groupIdentifier$ and type='child')]]]]] |
Get Parent Catalog Group(s) of Catalog Group. Returns the parent catalog groups for the given catalog group unique ID or identifier, under the catalog ID in the context. |
Request
Response |
CatalogGroupFacadeClient.getCatalogGroup(GetCatalogGroupType) | |
All access profiles listed in the 'Access Profile' section can be applied to this expression. | /CatalogGroup[search($searchCriteria$)] |
Catalog Group Search in catalog. Returns the catalog group(s) that match the given search criteria, under the catalog ID in the context. Search is case sensitive and can be performed using one field or combination of multiple fields as specified in the request expression. The following fields can be used to specify search criteria.
|
Request
Response |
findAllCategoriesDetails | |
All access profiles listed in the 'Access Profile' section can be applied to this expression. |
/CatalogGroup[@salesCategories='true' and search($searchCriteria$)] |
Catalog Group Search in all sales catalogs. Returns the catalog groups in any sales catalogs that match the given search criteria, belonging to the store ID in the context. Search is case sensitive and can be performed using one field or combination of multiple fields as specified in the request expression. The following fields can be used to specify search criteria.
|
Request
Response |
findAllSalesCategoriesDetails | |
All access profiles listed in the 'Access Profile' section can be applied to this expression. |
/CatalogGroup[@allCategories='true' and search($searchCriteria$)] |
Catalog Group Search in all catalogs. Returns the catalog groups in any catalog, that match the given search criteria, belonging the store ID in the context. Search is case sensitive and can be performed using one field or combination of multiple fields as specified in the request expression. The following fields can be used to specify search criteria.
|
Request
Response |
findAllCategoriesDetailsBasicSearch | |
All access profiles listed in the 'Access Profile' section can be applied to this expression. |
/CatalogGroup[Association[ CatalogGroupReference[CatalogGroupIdentifier [(UniqueID=$uniqueId$)]]]] /CatalogGroup[Association[ CatalogGroupReference[CatalogGroupIdentifier [ExternalIdentifier[( GroupIdentifier=$groupIdentifier$)]]]]] |
Get Merchandising Association Reference for Catalog Group. Returns the catalog groups which reference the given catalog group unique ID or identifier through merchandising associations, in the store ID in the context. |
Request
Response |
getCatalogGroupMerchandisingAssociationReferencesById | |
IBM_Admin_CatalogGroupSalesCatalogReference |
/CatalogGroup[CatalogGroupIdentifier[ (UniqueID=$uniqueId$)]] |
Get Sales Catalog Reference for Catalog Group. Returns information about all sales catalogs under the store ID in the context, which refer to the given catalog group unique ID. The sales catalog reference can be established, if the given catalog group is a top category or has a parent category in a catalog. The sales catalog information is returned as a navigational relationship under the catalog group noun. The type of navigation relationship is 'child-parent'. The navigation path for the catalog group in each sales catalog is also returned. |
Request
Response |
getCatalogGroupSalesCatalogReferencesById | |
IBM_Admin_SEO |
/CatalogGroup[CatalogGroupIdentifier[ (UniqueID=$uniqueId$)]] |
Get the SEO URL and SEO properties of a catalog group. |
Request
Response |
getCatalogGroup | |
All access profiles listed in the 'Access Profile' section that begin with 'IBM_Store' can be applied to this expression. |
/CatalogGroup[CatalogGroupIdentifier[ (UniqueID=$catGroupId$)] and Description[Attributes[published=1]]] |
Get Catalog Group by Unique ID. Returns the catalog group for the given unique ID. |
Request
Response |
getPublishedCatalogGroupSummaryByIDs getPublishedCatalogGroupSummaryByID getPublishedCatalogGroupDetailsByIDs getPublishedCatalogGroupDetailsByID getPublishedCatalogGroupMerchandisingAssociationsByID getPublishedCategoryWithChildrenCategories getPublishedCategoryWithChildrenCatalogEntries getPublishedCategoryWithAllChildren | |
All access profiles listed in the 'Access Profile' section that begin with 'IBM_Store' can be applied to this expression. |
/CatalogGroup[CatalogGroupIdentifier[ ExternalIdentifier[( GroupIdentifier=$catGroupIdentifier$)]] and Description[Attributes[published=1]]] |
Get Catalog Group by Identifier. Returns the catalog group for the given identifier. |
Request
Response |
getPublishedCatalogGroupSummaryByIdentifier getPublishedCatalogGroupDetailsByIdentifier getPublishedCatalogGroupMerchandisingAssociationsByIdentifier | |
All access profiles listed in the 'Access Profile' section that begin with 'IBM_Store' can be applied to this expression. | /CatalogGroup[@topCatalogGroup='true' and Description[Attributes[published=1]]] |
Get top level categories. Returns the top-level categories for the catalog ID and store ID in the context. |
Request
Response |
getPublishedTopCategories | |
All access profiles listed in the 'Access Profile' section that begin with 'IBM_Store' can be applied to this expression. |
/CatalogGroup[Description[Attributes[published=1]] and ParentCatalogGroupIdentifier[ (UniqueID=$catGroupId$)]] |
Get child categories of a Catalog Group. Returns the child categories for the given catalog group unique ID, under the catalog ID in the context. |
Request
Response |
getPublishedCatalogGroupByParentCatalogGroupId |
Some sample XML request and response web service messages are provided for each noun. These sample messages might not include all properties or attributes. To view a sample message that includes other properties or attributes, enable logging and tracing for the appropriate component and then call the web service to set or change the properties or attributes. Review the corresponding log file to see the request or response information.
Access Profile | Data Returned | |
---|---|---|
IBM_Admin_Summary |
|
This access profile is designed for the Catalogs tool. It returns the summary information of a category. |
IBM_Admin_Details |
IBM_Admin_Summary +
|
This access profile is designed for the Catalogs tool. It returns the detailed information of a category. |
IBM_Admin_CatalogGroupMerchandisingAssociations |
IBM_Admin_Details +
|
This access profile is designed for the Catalogs tool. It returns the merchandising association of a category. |
IBM_Admin_CatalogGroupNavRelCatalogGroup |
IBM_Admin_Details +
|
This access profile is designed for the Catalogs tool. It returns the child categories of a category. |
IBM_Admin_CatalogGroupNavRelCatalogEntry |
IBM_Admin_Details +
|
This access profile is designed for the Catalogs tool. It returns the child catalog entries and parent category of a category. It returns the parent category as a Navigation Relationship of the type "child-parent". |
IBM_Admin_CatalogGroupNavRelAll |
IBM_Admin_CatalogGroupNavRelCatalogGroup + IBM_Admin_CatalogGroupNavRelCatalogEntry |
This access profile is designed for the Catalogs tool. It returns the child catalog entries and child categories of a category. |
IBM_Admin_All |
IBM_Admin_CatalogGroupMerchandisingAssociations + IBM_Admin_CatalogGroupNavRelAll |
This access profile is designed for the Catalogs tool. It returns all details, merchandising associations, child categories and child catalog entries of a category. |
IBM_Store_Summary |
|
This access profile is designed for the Catalogs tool. It returns the summary information of a category. |
IBM_Store_Details |
IBM_Store_Summary +
|
This access profile is designed for the Catalogs tool. It returns the basic information and detailed description of the catalog. |
IBM_Store_CatalogGroupMerchandisingAssociations |
IBM_Store_Details +
|
This access profile is designed for the Catalogs tool. It returns the merchandising association of a category. |
IBM_Store_CatalogGroupCatalogGroupChildren |
IBM_Store_Details +
|
This access profile is designed for the Catalogs tool. It returns children categories of a category. |
IBM_Store_CatalogGroupCatalogEntryChildren |
IBM_Store_Details +
|
This access profile is designed for the Catalogs tool. It returns children Catalog entries of a category. |
IBM_Store_CatalogGroupAllChildren |
IBM_Store_CatalogGroupCatalogGroupChildren + IBM_Store_CatalogGroupCatalogEntryChildren |
This access profile is designed for the Catalogs tool. It returns all children Catalog entries of a category. |