Get catalog entry details 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:

• catalog entry ID

• owner ID

• part number

• display name

• short description

• long description

• thumbnail image

• full image

• list price

• standard price

• contract price

• attributes

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

 

Request

Request BOD	GetCatalogEntry
Access profile	WC_CatalogEntryDetailsProfile
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-25T16:44:16.004Z
                </oa:CreationDateTime>
               
<oa:BODID>341d6660-acbd-11db-a3a8-832d45b924b0</oa:BODID>
                <_wcf:BusinessContext>
                        <_wcf:ContextData
name="storeId">511</_wcf:ContextData>
                </_wcf:BusinessContext>
        </oa:ApplicationArea>
        <_cat:DataArea>
                <oa:Get>
                        <oa:Expression
expressionLanguage="wcf:XPath">
                               
{ibmwcf.ap=WC_CatalogEntryDetailsProfile}/CatalogEntry[CatalogEntryIdentifier[(UniqueID='51100000117')]]
                        </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/Description/FullImage
/CatalogEntry/Description/LongDescription
/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
/CatalogEntry/CatalogEntryAttributes/@displaySequence 
/CatalogEntry/CatalogEntryAttributes/@language
/CatalogEntry/CatalogEntryAttributes/@usage
/CatalogEntry/CatalogEntryAttributes/Name
/CatalogEntry/CatalogEntryAttributes/DisplayTemplate
/CatalogEntry/CatalogEntryAttributes/StringValue/Value
/CatalogEntry/CatalogEntryAttributes/IntegerValue/Value
/CatalogEntry/CatalogEntryAttributes/FloatValue/Value

 

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-25T17:01:18.297Z
                </Oagis9:CreationDateTime>
                <Oagis9:BODID>
                        954527f0-acbf-11db-986f-827045b7cf58
                </Oagis9:BODID>
        </Oagis9:ApplicationArea>
        <_cat:DataArea>
                <Oagis9:Show />
                <_cat:CatalogEntry
catalogEntryTypeCode="ProductBean">
                        <_cat:CatalogEntryIdentifier>
                               
<_wcf:UniqueID>51100000117</_wcf:UniqueID>
                                <_wcf:ExternalIdentifier
                                       
ownerID="7000000000000000002">
                                       
<_wcf:PartNumber>TAWI-03</_wcf:PartNumber>
                                </_wcf:ExternalIdentifier>
                        </_cat:CatalogEntryIdentifier>
                        <_cat:Description language="-1">
                                <_cat:Name>"Corrolus"
Wineglasses</_cat:Name>
                                <_cat:Thumbnail>
                                       
images/catalog/TAWI_03_sm.jpg
                                </_cat:Thumbnail>
                                <_cat:FullImage>
                                        images/catalog/TAWI_03.jpg
                                </_cat:FullImage>
                                <_cat:ShortDescription>
                                        "Corrolus" wineglasses.
                                </_cat:ShortDescription>
                                <_cat:LongDescription>
                                        "Corrolus" wineglasses.
                                </_cat:LongDescription>
                        </_cat:Description>
                        <_cat:CatalogEntryAttributes>
                                <_cat:Attributes>
                                       
<_cat:Name>displayTemplate</_cat:Name>
                                        <_cat:StringValue>
                                       
<_cat:Value>ShoppingArea/CatalogSection/CatalogEntrySubsection/ProductDisplay</_cat:Value>
                                        </_cat:StringValue>
                                </_cat:Attributes>
                        </_cat:CatalogEntryAttributes>
                        <_cat:ListPrice>
                                <_wcf:Price
currency="USD">6.95</_wcf:Price>
                        </_cat:ListPrice>
                        <_cat:Price>
                                <_wcf:StandardPrice>
                                        <_wcf:Price>
                                                <_wcf:Price
currency="USD">7.99</_wcf:Price>
                                        </_wcf:Price>
                                </_wcf:StandardPrice>
                                <_wcf:ContractPrice
minimumQuantity="1.0">
                                        <_wcf:Price>
                                                <_wcf:Price
currency="USD">7.99</_wcf:Price>
                                        </_wcf:Price>
                                       
<_wcf:ContractIdentifier>
                                               
<_wcf:UniqueID>51100000001</_wcf:UniqueID>
                                               
<_wcf:ExternalIdentifier majorVersionNumber="1"
                                                       
minorVersionNumber="0" origin="0"
                                                       
ownerID="7000000000000000002">
                                                       
<_wcf:Name>
                                                               
ConsumerDirectATP Default Contract
                                                       
</_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: getCatalogEntryDetailsByID and getCatalogEntryDetailsByIDs. The getCatalogEntryDetailsByID accept one catEntryId as parameter and maps to the following XPath expression:

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

The default is: accessProfile=WC_CatalogEntryDetailsProfile.

The getCatalogGroupDetailsByIDs 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_CatalogEntryDetailsProfile.

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="getCatalogEntryDetailsByIDs">
<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:

• Create your own implementation of the interface ComposeCatalogEntryTaskCmd. The ComposeCatalogEntryTaskCmd and yourAccessProfileName 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