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.

 

Request

Request BOD	GetCatalogEntry business object document (BOD).
Access profile	WC_CatalogEntrySummaryProfile
Schema	/Catalog-DataObjects/xsd/OAGIS/9.0/Overlays/IBM/Commerce/BODs/GetCatalogEntry.xsd
Service data object	com.ibm.commerce.catalog.facade.datatypes.GetCatalogEntry

 

Sample request BOD

<_cat:GetCatalogEntry xmlns:_cat="


http://www.ibm.com/xmlns/prod/commerce/9/catalog"

 xmlns:_wcf="


http://www.ibm.com/xmlns/prod/commerce/9/foundation"

 xmlns:oa="http://www.openapplications.org/oagis/9"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <oa:ApplicationArea
xsi:type="_wcf:ApplicationAreaType">
               
<oa:CreationDateTime>2007-04-19T17:17:19.250Z</oa:CreationDateTime>
               
<oa:BODID>80469b70-eed4-11db-8af2-83974628068f</oa:BODID>
                        <_wcf:BusinessContext>
                                <_wcf:ContextData
name="storeId">10001</_wcf:ContextData>
                                <_wcf:ContextData
name="catalogId">10001</_wcf:ContextData>
                        </_wcf:BusinessContext>
        </oa:ApplicationArea>
        <_cat:DataArea>
                <oa:Get>
                        <oa:Expression
expressionLanguage="_wcf:XPath">{_wcf.ap=WC_CatalogEntrySummaryProfile}
                       
/CatalogEntry[ParentCatalogGroupIdentifier[(UniqueID='10008')]]</oa:Expression>
                </oa:Get>
        </_cat:DataArea>
</_cat:GetCatalogEntry> 

Response

Response BOD	ShowCatalogEntry
Schema	/Catalog-DataObjects/xsd/OAGIS/9.0/Overlays/IBM/Commerce/BODs/ShowCatalogEntry.xsd
Service data object	com.ibm.commerce.catalog.facade.datatypes.ShowCatalogEntry

The response contains the following information:

/CatalogEntry/@catalogEntryTypeCode
/CatalogEntry/CatalogEntryIdentifier/UniqueID
/CatalogEntry/CatalogEntryIdentifier/ExternalIdentifier/@ownerID
/CatalogEntry/CatalogEntryIdentifier/ExternalIdentifier/PartNumber
/CatalogEntry/Description/@language
/CatalogEntry/Description/Name
/CatalogEntry/Description/ThumbNail
/CatalogEntry/Description/ShortDescription
/CatalogEntry/ListPrice/Price/@currency
/CatalogEntry/ListPrice/Quantity
/CatalogEntry/Price/StandardPrice/Price/Price/@currency
/CatalogEntry/Price/StandardPrice/Price/Quantity
/CatalogEntry/Price/ContractPrice/@minimumQuantity
/CatalogEntry/Price/ContractPrice/Price/Price/@currency
/CatalogEntry/Price/ContractPrice/Price/Quantity
/CatalogEntry/Price/ContractPrice/ContractIdentifier/UniqueID
/CatalogEntry/Price/ContractPrice/ContractIdentifier/ExternalIdentifier/@majorVersionNumber
/CatalogEntry/Price/ContractPrice/ContractIdentifier/ExternalIdentifier/@minorVersionNumber
/CatalogEntry/Price/ContractPrice/ContractIdentifier/ExternalIdentifier/@origin
/CatalogEntry/Price/ContractPrice/ContractIdentifier/ExternalIdentifier/@ownerID
/CatalogEntry/Price/ContractPrice/ContractIdentifier/ExternalIdentifier/Name

 

Sample response BOD

The response based on access profile WC_CatalogEntrySummaryProfile contains the following information:

<_cat:ShowCatalogEntry
xmlns:_cat="http://www.ibm.com/xmlns/prod/commerce/9/catalog"
xmlns:_wcf="http://www.ibm.com/xmlns/prod/commerce/9/foundation"
xmlns:oa="http://www.openapplications.org/oagis/9"
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<oa:ApplicationArea xsi:type="_wcf:ApplicationAreaType">
<oa:CreationDateTime>2007-04-19T17:17:25.078Z</oa:CreationDateTime>
<oa:BODID>83d31d90-eed4-11db-8981-839746255b7f</oa:BODID>
</oa:ApplicationArea>
<_cat:DataArea>
<oa:Show/>
<_cat:CatalogEntry catalogEntryTypeCode="ItemBean">
<_cat:CatalogEntryIdentifier>
<_wcf:UniqueID>10029</_wcf:UniqueID>
<_wcf:ExternalIdentifier ownerID="7000000000000000002">
<_wcf:PartNumber>A0000334</_wcf:PartNumber>
</_wcf:ExternalIdentifier>
</_cat:CatalogEntryIdentifier>
<_cat:Description language="-1">
<_cat:Name>Ferro Carbon Brake Pads</_cat:Name>
<_cat:Thumbnail>images/Brake_Pad3-50.jpg</_cat:Thumbnail>
<_cat:ShortDescription>Ferro Carbon Brake
Pads</_cat:ShortDescription>
</_cat:Description>
<_cat:ListPrice>
<_wcf:Price currency="USD">47.85</_wcf:Price>
</_cat:ListPrice>
<_cat:Price>
<_wcf:StandardPrice>
<_wcf:Price>
<_wcf:Price currency="USD">47.85</_wcf:Price>
<_wcf:Quantity>1.0</_wcf:Quantity>
</_wcf:Price>
</_wcf:StandardPrice>
<_wcf:ContractPrice minimumQuantity="1.0">
<_wcf:Price>
<_wcf:Price currency="USD">47.85</_wcf:Price>
<_wcf:Quantity>1.0</_wcf:Quantity>
</_wcf:Price>
<_wcf:ContractIdentifier>
<_wcf:UniqueID>10001</_wcf:UniqueID>
<_wcf:ExternalIdentifier majorVersionNumber="1"
minorVersionNumber="0" origin="0" ownerID="7000000000000000002">
<_wcf:Name>AdvancedB2BDirect Contract number
1234</_wcf:Name>
</_wcf:ExternalIdentifier>
</_wcf:ContractIdentifier>
</_wcf:ContractPrice>
</_cat:Price>
</_cat:CatalogEntry>
<_cat:CatalogEntry catalogEntryTypeCode="ItemBean">
<_cat:CatalogEntryIdentifier>
<_wcf:UniqueID>10028</_wcf:UniqueID>
<_wcf:ExternalIdentifier ownerID="7000000000000000002">
<_wcf:PartNumber>A0000333</_wcf:PartNumber>
</_wcf:ExternalIdentifier>
</_cat:CatalogEntryIdentifier>
<_cat:Description language="-1">
<_cat:Name>Ferro Carbon Brake Pads</_cat:Name>
<_cat:Thumbnail>images/Brake_Pad3-50.jpg</_cat:Thumbnail>
<_cat:ShortDescription>Ferro Carbon Brake
Pads</_cat:ShortDescription>
</_cat:Description>
<_cat:ListPrice>
<_wcf:Price currency="USD">47.85</_wcf:Price>
</_cat:ListPrice>
<_cat:Price>
<_wcf:StandardPrice>
<_wcf:Price>
<_wcf:Price currency="USD">47.85</_wcf:Price>
<_wcf:Quantity>1.0</_wcf:Quantity>
</_wcf:Price>
</_wcf:StandardPrice>
<_wcf:ContractPrice minimumQuantity="1.0">
<_wcf:Price>
<_wcf:Price currency="USD">47.85</_wcf:Price>
<_wcf:Quantity>1.0</_wcf:Quantity>
</_wcf:Price>
<_wcf:ContractIdentifier>
<_wcf:UniqueID>10001</_wcf:UniqueID>
<_wcf:ExternalIdentifier majorVersionNumber="1"
minorVersionNumber="0" origin="0" ownerID="7000000000000000002">
<_wcf:Name>AdvancedB2BDirect Contract number
1234</_wcf:Name>
</_wcf:ExternalIdentifier>
</_wcf:ContractIdentifier>
</_wcf:ContractPrice>
</_cat:Price>
</_cat:CatalogEntry>
<_cat:CatalogEntry catalogEntryTypeCode="ItemBean">
<_cat:CatalogEntryIdentifier>
<_wcf:UniqueID>10027</_wcf:UniqueID>
<_wcf:ExternalIdentifier ownerID="7000000000000000002">
<_wcf:PartNumber>A0000332</_wcf:PartNumber>
</_wcf:ExternalIdentifier>
</_cat:CatalogEntryIdentifier>
<_cat:Description language="-1">
<_cat:Name>Ferro Carbon Brake Pads</_cat:Name>
<_cat:Thumbnail>images/Brake_Pad3-50.jpg</_cat:Thumbnail>
<_cat:ShortDescription>Ferro Carbon Brake
Pads</_cat:ShortDescription>
</_cat:Description>
<_cat:ListPrice>
<_wcf:Price currency="USD">47.85</_wcf:Price>
</_cat:ListPrice>
<_cat:Price>
<_wcf:StandardPrice>
<_wcf:Price>
<_wcf:Price currency="USD">47.85</_wcf:Price>
<_wcf:Quantity>1.0</_wcf:Quantity>
</_wcf:Price>
</_wcf:StandardPrice>
<_wcf:ContractPrice minimumQuantity="1.0">
<_wcf:Price>
<_wcf:Price currency="USD">47.85</_wcf:Price>
<_wcf:Quantity>1.0</_wcf:Quantity>
</_wcf:Price>
<_wcf:ContractIdentifier>
<_wcf:UniqueID>10001</_wcf:UniqueID>
<_wcf:ExternalIdentifier majorVersionNumber="1"
minorVersionNumber="0" origin="0" ownerID="7000000000000000002">
<_wcf:Name>AdvancedB2BDirect Contract number
1234</_wcf:Name>
</_wcf:ExternalIdentifier>
</_wcf:ContractIdentifier>
</_wcf:ContractPrice>
</_cat:Price>
</_cat:CatalogEntry>
</_cat:DataArea>
</_cat:ShowCatalogEntry> 

 

Usage

To use this service request on a JSP page use the expression-builder, getCatalogEntryByParentCatalogGroupId.

The expression-builder maps to the following XPath expression:

{_wcf.ap=$accessProfile$}/CatalogEntry[ParentCatalogGroupIdentifier[(UniqueID='$catGroupId$')]]

The default value is: accessProfile= WC_CatalogEntrySummaryProfile. This service request uses the
CatalogEntryDataBean data bean.

 

Exceptions

If there is an error the error is reported in the Response message. You can see the error details in the trace log, SystemOut.log.

 

Customization

The following extensions are supported:

• Create your own implementation of the interface
  ComposeCatalogTaskCmd. By creating your own implementation of the
  ComposeCatalogTaskCmd, and an access profile, you can control the information returned by the service.

Related concepts

../../com.ibm.commerce.business_process.doc/concepts/processFind_product_(ConsumerDirect).htm
Design pattern for Get service implementation

Related Reference

WebSphere Commerce foundation tag library