Get catalog entry <a href="http://www.setgetweb.com/p/commerce/com.ibm.commerce.base.doc/concepts/covmerchan.htm">merchandising</a> associations by part number

Get catalog entry merchandising associations by part number

This service request, getCatalogEntryMerchandisingAssociationsByID, returns the merchandising associations and the details information for the catalog entry. A list of CatalogEntry nouns returns if you pass in multiple catalog entry identifiers. The catalog entry ID is used in the request.

Request

Request BOD	GetCatalogEntry
Access profile	WC_CatalogEntryMerchandisingAssociationsProfile
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:59:39.525Z
                </oa:CreationDateTime>
               
<oa:BODID>5a427f40-acbf-11db-ac9a-832d45b9284b</oa:BODID>
                <_wcf:BusinessContext>
                        <_wcf:ContextData
name="storeId">511</_wcf:ContextData>
                </_wcf:BusinessContext>
        </oa:ApplicationArea>
        <_cat:DataArea>
                <oa:Get>
                        <oa:Expression
expressionLanguage="wcf:XPath">
                               
{_wcf.ap=WC_CatalogEntryMerchandisingAssociationsProfile}/CatalogEntry[CatalogEntryIdentifier[ExternalIdentifier[(PartNumber='SKU-51101098')]]]
                        </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/Description
/CatalogEntry/CatalogEntryAttributes/StringValue/Value
/CatalogEntry/CatalogEntryAttributes/IntegerValue/Value
/CatalogEntry/CatalogEntryAttributes/FloatValue/Value
/CatalogEntry/Association/@quantity
/CatalogEntry/Association/@sequence
/CatalogEntry/Association/Name
/CatalogEntry/Association/AssociationCodeType
/CatalogEntry/Association/CatalogEntryReference/@catalogEntryTypeCode
/CatalogEntry/Association/CatalogEntryReference/displayName
/CatalogEntry/Association/CatalogEntryReference/CatalogEntryIdentifier/UniqueID
/CatalogEntry/Association/CatalogEntryReference/CatalogEntryIdentifier/ExternalIdentifier/@ownerID
/CatalogEntry/Association/CatalogEntryReference/CatalogEntryIdentifier/ExternalIdentifier/PartNumber

Here AssociationCodeType is MerchandisingAssociation

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:16:37.578Z
                </Oagis9:CreationDateTime>
                <Oagis9:BODID>
                        b9344e00-acc1-11db-986f-827045b7cf58
                </Oagis9:BODID>
        </Oagis9:ApplicationArea>
        <_cat:DataArea>
                <Oagis9:Show />
                <_cat:CatalogEntry
catalogEntryTypeCode="ProductBean">
                        <_cat:CatalogEntryIdentifier>
                               
<_wcf:UniqueID>51101098000</_wcf:UniqueID>
                                <_wcf:ExternalIdentifier
                                       
ownerID="7000000000000000002">
                                       
<_wcf:PartNumber>SKU-51101098</_wcf:PartNumber>
                                </_wcf:ExternalIdentifier>
                        </_cat:CatalogEntryIdentifier>
                        <_cat:Description language="-1">
                                <_cat:Name>V-Neck
Sweater</_cat:Name>
                               
<_cat:Thumbnail>images/vneck.gif</_cat:Thumbnail>
                               
<_cat:FullImage>images/vneck.gif</_cat:FullImage>
                                <_cat:ShortDescription>
                                        V-Neck Sweater
                                </_cat:ShortDescription>
                                <_cat:LongDescription>
                                        A contemporary look with
ribbed neckline. 100% wool.
                                        Machine wash. Available in
(Small, Blue), (Medium,
                                        Black), (Large, Brown)
                                </_cat:LongDescription>
                        </_cat:Description>
                        <_cat:CatalogEntryAttributes>
                                <_cat:Attributes
displaySequence="1.0" language="-1"
                                        usage="1">
                                       
<_cat:Name>Size</_cat:Name>
                                </_cat:Attributes>
                                <_cat:Attributes
displaySequence="2.0" language="-1"
                                        usage="1">
                                       
<_cat:Name>Color</_cat:Name>
                                </_cat:Attributes>
                        </_cat:CatalogEntryAttributes>
                        <_cat:ListPrice>
                                <_wcf:Price
currency="USD">80.00</_wcf:Price>
                        </_cat:ListPrice>
                        <_cat:Price>
                                <_wcf:StandardPrice>
                                        <_wcf:Price>
                                                <_wcf:Price
currency="USD">80.00</_wcf:Price>
                                        </_wcf:Price>
                                </_wcf:StandardPrice>
                                <_wcf:ContractPrice
minimumQuantity="1.0">
                                        <_wcf:Price>
                                                <_wcf:Price
currency="USD">80.00</_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:Association
                               
AssociationCodeType="MerchandisingAssociation" sequence="1.0">
                               
<_cat:Name>UPSELL</_cat:Name>
                                <_cat:CatalogEntryReference
                                       
catalogEntryTypeCode="ProductBean">
                                       
<_cat:CatalogEntryIdentifier>
                                               
<_wcf:UniqueID>51101099000</_wcf:UniqueID>
                                               
<_wcf:ExternalIdentifier
                                                       
ownerID="7000000000000000002">
                                                       
<_wcf:PartNumber>
                                                               
SKU-51101099
                                                       
</_wcf:PartNumber>
                                               
</_wcf:ExternalIdentifier>
                                       
</_cat:CatalogEntryIdentifier>
                                        <_cat:displayName>
                                                Ribbed Knit Sweater
                                        </_cat:displayName>
                                </_cat:CatalogEntryReference>
                        </_cat:Association>
                </_cat:CatalogEntry>
        </_cat:DataArea>
</_cat:ShowCatalogEntry>

Usage

To use this service request on a JSP page use the expression-builder, getCatalogEntryMerchandisingAssociationsByPartNumber, and pass the partNumber parameter.

The expression-builder maps to the following XPath expression:

{_wcf.ap=$accessProfile$}/CatalogEntry[CatalogEntryIdentifier[ExternalIdentifier[(PartNumber='$partNumber$')]]

The default is: accessProfile=WC_CatalogEntryMerchandisingAssociationsProfile.

By default, the expression builder in the get-data-config.xml file associated to this service only accept one id or partnumber. By using the pattern from getCatalogEntrySummaryByIDs or getCatalogEntryDetailsByIDs, you can create your own expression builder that will accept multiple IDs or part numbers.

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 Reference

WebSphere Commerce foundation tag library