Get catalog entry summary by ID

This service request, getCatalogEntryDetailsByID, returns details about a catalog entry. A list of all CatalogEntry returns if you pass in multiple catalog entry IDs. The display details include:

For this service, the request should use the catalog entry ID of the catalog entry.

 

Request

Request BOD GetCatalogEntry
Access profile WC_CatalogEntrySummaryProfile
Schema /Catalog-DataObjects/xsd/OAGIS/9.0/Overlays/IBM/Commerce/BODs/GetCatalogEntry.xsd
Service data object GetCatalogEntryType

 

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-01-25T14:43:56.118Z
                </oa:CreationDateTime>
               
<oa:BODID>649faca0-acac-11db-aad3-832d45b9087c</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[CatalogEntryIdentifier[(UniqueID='10001')]]
                        </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 ShowCatalogEntryType

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

<_cat:ShowCatalogEntry
        xmlns:Oagis9="http://www.openapplications.org/oagis/9"
       
xmlns:_cat="http://www.ibm.com/xmlns/prod/commerce/9/catalog"
       
xmlns:_wcf="http://www.ibm.com/xmlns/prod/commerce/9/foundation"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <Oagis9:ApplicationArea
xsi:type="_wcf:ApplicationAreaType">
                <Oagis9:CreationDateTime>
                        2007-01-25T14:44:02.897Z
                </Oagis9:CreationDateTime>
                <Oagis9:BODID>
                        688e9a10-acac-11db-83a9-832d45b8fe37
                </Oagis9:BODID>
        </Oagis9:ApplicationArea>
        <_cat:DataArea>
                <Oagis9:Show />
                <_cat:CatalogEntry
catalogEntryTypeCode="ProductBean">
                        <_cat:CatalogEntryIdentifier>
                               
<_wcf:UniqueID>10001</_wcf:UniqueID>
                                <_wcf:ExternalIdentifier
                                       
ownerID="7000000000000000002">
                                       
<_wcf:PartNumber>A0000101</_wcf:PartNumber>
                                </_wcf:ExternalIdentifier>
                        </_cat:CatalogEntryIdentifier>
                        <_cat:Description language="-1">
                                <_cat:Name>Kevlar Brake
Pads</_cat:Name>
                                <_cat:Thumbnail>
                                        images/Brake_Pad1-50.jpg
                                </_cat:Thumbnail>
                                <_cat:ShortDescription>
                                        Kevlar Brake Pads
                                </_cat:ShortDescription>
                        </_cat:Description>
                        <_cat:ListPrice>
                                <_wcf:Price
currency="USD">26.75</_wcf:Price>
                        </_cat:ListPrice>
                        <_cat:Price>
                                <_wcf:StandardPrice>
                                        <_wcf:Price>
                                                <_wcf:Price
currency="USD">26.75</_wcf:Price>
                                        </_wcf:Price>
                                </_wcf:StandardPrice>
                                <_wcf:ContractPrice
minimumQuantity="1.0">
                                        <_wcf:Price>
                                                <_wcf:Price
currency="USD">26.75</_wcf:Price>
                                        </_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, you have the choices between two expression builders: getCatalogEntrySummaryByID and getCatalogEntrySummaryByIDs. The getCatalogEntrySummaryByID accept one catEntryId as parameter and maps to the following XPath expression:

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

The default is: accessProfile=WC_CatalogEntrySummaryProfile.

The getCatalogGroupSummaryByIDs accept a list of catEntryId as parameters and as such should be used to return the details of multiple catalog entries. The accessProfile used is WC_CatalogEntrySummaryProfile. Here is an example on how to use this in a JSP page: 

<wcf:getData
type="com.ibm.commerce.catalog.facade.datatypes.CatalogEntryType[]"
var="catalogEntries"
expressionBuilder="getCatalogEntrySummaryByIDs">
<c:forEach var="uniqueId" uniqueIDs="the list of Ids">
<wcf:param name="UniqueID" value="${uniqueID}" />
</c:forEach>
</wcf:getData>

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:

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