Catalog services

Catalog services

The Catalog services enable an external system, such as WebSphere Portal, to search for Catalog related information in WebSphere Commerce. There are three top level nouns defined in the logical model:

Catalog

A container of the other catalog entities, such as catalog entry, catalog group, attribute and so on.

CatalogGroup

A grouping mechanism for other catalog groups and catalog entries.

CatalogEntry

A catalog entry can be a product item or a kit.

Catalog services use a single verb: Get. The catalog logical model is defined with customization in mind. All the major elements have a standard extension point to add additional name-value pairs. The catalog entry object in particular has only the major elements defined. Everything else is represented as a CatalogAttributeType which can be language dependant.

Service

Get catalog details by catalog ID This service, getCatalogDetailsByID, returns catalog details by the catalog ID (the reference number of the catalog). Catalog details include:

identifier
name
thumbnail image
full image name
short description
long description

Get catalog details by catalog identifier This service request, getCatalogDetailsByIdentifier, returns catalog details by the catalog external identifier. Catalog details include:

identifier
name
thumbnail image
full image name
short description
long description

Get master catalog details This service request, getMasterCatalog, returns the master catalog for a store based on the store ID. The response displays details such as the name, short and long description, and image paths for the master catalog.
Get all catalog details This service request, getAllCatalogs, returns details on all catalogs, details include the owner ID, catalog name, thumbnail and full-size image path, short and long description.
Get CatalogGroup Summary By ID This service request, getCatalogGroupDetailsByID, obtain detailed information about a category such as:

catalog group id
owner id
catalog group identifier
name
short description
thumbnail image
The catalog group id is used in the request.
Get CatalogGroup Summary By Identifier This service request, getCatalogGroupSummaryByIdentifier, obtain detailed information about a category such as:

catalog group id
owner id
catalog group identifier
name
short description
thumbnail image
The catalog group identifier is used in the request.
Get CatalogGroup Details By ID This service request, getCatalogGroupDetailsByID, obtain detailed information about a category such as:

catalog group id
owner id
catalog group identifier
name
short description
long description
thumbnail image
full image

The catalog group id is used in the request.
Get CatalogGroup Details By Identifier This service request, getCatalogGroupDetailsByID, obtains detailed information about a category such as:

catalog group id
owner id
catalog group identifier
name
short description
long description
thumbnail image
full image
The catalog group identifier is used in the request.
Get CatalogGroup Merchandising Associations By ID This service request, getCatalogGroupMerchandisingAssociationsByID, returns the merchandising associations and the details information for the catalog group. The catalog group id is used in the request.
Get CatalogGroup Merchandising Associations By Identifier This service request, getCatalogGroupMerchandisingAssociationsByID, returns the merchandising associations and the details information for the catalog group. The catalog group identifier is used in the request.
Get Top Categories This service request, getTopCategories, returns all the top-level categories from a catalog under the store master catalog.
Get Category With Children Categories This service request, getCategoryWithChildrenCategories, returns all the child catalog groups and the displays details of a category. The catalog group id is used in the request.
Get Category With Children CatalogEntries This service request, getCategoryWithChildrenCatalogEntries, returns all the child catalog entries and the displays details of a category. The catalog group id is used in the request.
Get Category With All Children This service request, getCategoryWithAllChildren, returns all the child categories, catalog entries and the displays details of a category. The catalog group id is used in the request.
Get CatalogEntry Summary By ID
This service request, getCatalogEntryDetailsByID, returns details about a catalog entry. The display details will include:

catalog entry id
owner id
part number
display name
short description
thumbnail image
list price
standard price
contract price

For this service, the request should use the catalog entry id of the catalog entry.
Get CatalogEntry Details By ID This service request, getCatalogEntryDetailsByID, returns details about a catalog entry. The display details will include:

catalog entry id
owner id
part number
display name
short description
long description
thumbnail image
full image
list price
standard price
contract price
For this service, the request should use the catalog entry id of the catalog entry.
Get CatalogEntry Merchandising Associations By ID This service request, getCatalogEntryMerchandisingAssociationsByID, returns the merchandising associations and the details information for the catalog entry. The catalog entry id is used in the request.
Get CatalogEntry Merchandising Associations By PartNumber This service request, getCatalogEntryMerchandisingAssociationsByID, returns the merchandising associations and the details information for the catalog entry. The catalog entry id is used in the request.
Get CatalogEntry Components By ID This service request, getCatalogEntryComponentsByID, returns the details of a catalog entry plus the components of this catalog entry. For example, if the catalog entry is a ProductBean, then the components will be the ItemBeans (SKUs) associated to the product. In this service, we use the catalog entry id to request the components of the catalog entry.
Get CatalogEntry Components By PartNumber This service request, getCatalogEntryComponentsByPartNumber, returns the details of a catalog entry plus the components of this catalog entry. For example, if the catalog entry is a ProductBean, then the components will be the ItemBeans (SKUs) associated to the product. In this service, we use the part number to request the components of the catalog entry.Request
Get CatalogEntry Summary By PartNumber
This service request, getCatalogEntryDetailsByID, returns details about a catalog entry. The display details will include:

catalog entry id
owner id
part number
display name
short description
thumbnail image
list price
standard price
contract price

For this service, the request should use the part number of the catalog entry.
Get CatalogEntry Details By PartNumber
This service request, getCatalogEntryDetailsByID, returns details about a catalog entry. The display details will include:

catalog entry id
owner id
part number
display name
short description
long description
thumbnail image
full image
list price
standard price
contract price

For this service, the request should use the part number of the catalog entry.
Find CatalogEntries Summary By Name This service request returns a list of catalog entries that satisfy the search criteria on the name. For each returned catalog entry, the level of information provided is the same as the service getCatalogEntrySummaryByID.
Find CatalogEntries Details By Name This service request returns a list of catalog entries that satisfy the search criteria on the name. For each returned catalog entry, the level of information provided is the same as the service getCatalogEntryDetailsByID.
Find CatalogEntries Summary By Description This service request returns a list of catalog entries that satisfy the search criteria on the description. For each returned catalog entry, the level of information provided is the same as the service getCatalogEntrySummaryByID.
Find CatalogEntries Details By Description This service request returns a list of catalog entries that satisfy the search criteria on the description. For each returned catalog entry, the level of information provided is the same as the service getCatalogEntryDetailsByID.
Get catalog entries for a parent catalog group This service request, gets a list of all catalog entries which are children of a specified catalog group. The information retrieved for each catalog entry is determined by the access profile.
Get catalog groups for a parent catalog group This service request, gets the list of catalog groups which are children of a specified catalog group. The information retrieved for each catalog group is determined by the access profile.

Related Reference

Catalog services
WebSphere Commerce foundation tag library

Service
Get catalog details by catalog ID	This service, getCatalogDetailsByID, returns catalog details by the catalog ID (the reference number of the catalog). Catalog details include: identifier name thumbnail image full image name short description long description
Get catalog details by catalog identifier	This service request, getCatalogDetailsByIdentifier, returns catalog details by the catalog external identifier. Catalog details include: identifier name thumbnail image full image name short description long description
Get master catalog details	This service request, getMasterCatalog, returns the master catalog for a store based on the store ID. The response displays details such as the name, short and long description, and image paths for the master catalog.
Get all catalog details	This service request, getAllCatalogs, returns details on all catalogs, details include the owner ID, catalog name, thumbnail and full-size image path, short and long description.
Get CatalogGroup Summary By ID	This service request, getCatalogGroupDetailsByID, obtain detailed information about a category such as: catalog group id owner id catalog group identifier name short description thumbnail image The catalog group id is used in the request.
Get CatalogGroup Summary By Identifier	This service request, getCatalogGroupSummaryByIdentifier, obtain detailed information about a category such as: catalog group id owner id catalog group identifier name short description thumbnail image The catalog group identifier is used in the request.
Get CatalogGroup Details By ID	This service request, getCatalogGroupDetailsByID, obtain detailed information about a category such as: catalog group id owner id catalog group identifier name short description long description thumbnail image full image The catalog group id is used in the request.
Get CatalogGroup Details By Identifier	This service request, getCatalogGroupDetailsByID, obtains detailed information about a category such as: catalog group id owner id catalog group identifier name short description long description thumbnail image full image The catalog group identifier is used in the request.
Get CatalogGroup Merchandising Associations By ID	This service request, getCatalogGroupMerchandisingAssociationsByID, returns the merchandising associations and the details information for the catalog group. The catalog group id is used in the request.
Get CatalogGroup Merchandising Associations By Identifier	This service request, getCatalogGroupMerchandisingAssociationsByID, returns the merchandising associations and the details information for the catalog group. The catalog group identifier is used in the request.
Get Top Categories	This service request, getTopCategories, returns all the top-level categories from a catalog under the store master catalog.
Get Category With Children Categories	This service request, getCategoryWithChildrenCategories, returns all the child catalog groups and the displays details of a category. The catalog group id is used in the request.
Get Category With Children CatalogEntries	This service request, getCategoryWithChildrenCatalogEntries, returns all the child catalog entries and the displays details of a category. The catalog group id is used in the request.
Get Category With All Children	This service request, getCategoryWithAllChildren, returns all the child categories, catalog entries and the displays details of a category. The catalog group id is used in the request.
Get CatalogEntry Summary By ID	This service request, getCatalogEntryDetailsByID, returns details about a catalog entry. The display details will include: catalog entry id owner id part number display name short description thumbnail image list price standard price contract price For this service, the request should use the catalog entry id of the catalog entry.
Get CatalogEntry Details By ID	This service request, getCatalogEntryDetailsByID, returns details about a catalog entry. The display details will include: catalog entry id owner id part number display name short description long description thumbnail image full image list price standard price contract price For this service, the request should use the catalog entry id of the catalog entry.
Get CatalogEntry Merchandising Associations By ID	This service request, getCatalogEntryMerchandisingAssociationsByID, returns the merchandising associations and the details information for the catalog entry. The catalog entry id is used in the request.
Get CatalogEntry Merchandising Associations By PartNumber	This service request, getCatalogEntryMerchandisingAssociationsByID, returns the merchandising associations and the details information for the catalog entry. The catalog entry id is used in the request.
Get CatalogEntry Components By ID	This service request, getCatalogEntryComponentsByID, returns the details of a catalog entry plus the components of this catalog entry. For example, if the catalog entry is a ProductBean, then the components will be the ItemBeans (SKUs) associated to the product. In this service, we use the catalog entry id to request the components of the catalog entry.
Get CatalogEntry Components By PartNumber	This service request, getCatalogEntryComponentsByPartNumber, returns the details of a catalog entry plus the components of this catalog entry. For example, if the catalog entry is a ProductBean, then the components will be the ItemBeans (SKUs) associated to the product. In this service, we use the part number to request the components of the catalog entry.Request
Get CatalogEntry Summary By PartNumber	This service request, getCatalogEntryDetailsByID, returns details about a catalog entry. The display details will include: catalog entry id owner id part number display name short description thumbnail image list price standard price contract price For this service, the request should use the part number of the catalog entry.
Get CatalogEntry Details By PartNumber	This service request, getCatalogEntryDetailsByID, returns details about a catalog entry. The display details will include: catalog entry id owner id part number display name short description long description thumbnail image full image list price standard price contract price For this service, the request should use the part number of the catalog entry.
Find CatalogEntries Summary By Name	This service request returns a list of catalog entries that satisfy the search criteria on the name. For each returned catalog entry, the level of information provided is the same as the service getCatalogEntrySummaryByID.
Find CatalogEntries Details By Name	This service request returns a list of catalog entries that satisfy the search criteria on the name. For each returned catalog entry, the level of information provided is the same as the service getCatalogEntryDetailsByID.
Find CatalogEntries Summary By Description	This service request returns a list of catalog entries that satisfy the search criteria on the description. For each returned catalog entry, the level of information provided is the same as the service getCatalogEntrySummaryByID.
Find CatalogEntries Details By Description	This service request returns a list of catalog entries that satisfy the search criteria on the description. For each returned catalog entry, the level of information provided is the same as the service getCatalogEntryDetailsByID.
Get catalog entries for a parent catalog group	This service request, gets a list of all catalog entries which are children of a specified catalog group. The information retrieved for each catalog entry is determined by the access profile.
Get catalog groups for a parent catalog group	This service request, gets the list of catalog groups which are children of a specified catalog group. The information retrieved for each catalog group is determined by the access profile.