Reference > WebSphere Commerce Web services > Catalog


Catalog


Noun CatalogEntry


Description

CatalogEntry noun is used to model a catalog entry.
A catalog entry can be a product, an item, a package, kit or a bundle. The catalog ID, store ID and language are assumed to be set in the business contexts. The entitlement context is required for retrieving the offer prices. CatalogEntry noun is used by the Catalogs Tool at authoring time, and the store front at runtime.


BOD Summary

Access Profile and Expression Builder columns are for Get BOD only.

BOD Action Code / Access Profile Action Expression Service Provided Sample XML Message Client Library / Expression Builder
ProcessCatalogEntry Create /CatalogEntry[i] Creates a new catalog entry and corresponding inventory and fulfillment data in the database.

Exceptions: An error results if one of the following conditions occurs:

  • The target catalog is not specified.

  • The current catalog context is not a master catalog.

  • The part number provided for the catalog entry already exists for the given owner or store.

  • The external identifier (part number) is missing.

  • The owner ID passed in the request BOD is different from the owner ID of the store in the context.

  • The catalog entry to be created is a SKU for which the parent product is not specified, and the inventory system of the current store is ATP.

  • The type of catalog entry (e.g. product, SKU, bundle or dynamic kit) to be created is not provided.

Request
Response
CatalogEntryFacadeClient.processCatalogEntry(ProcessCatalogEntryType)
Delete /CatalogEntry[i] Marks for delete a catalog entry in the database.

Exceptions: An error results if one of the following conditions occurs:

  • The current catalog context is not a master catalog.

  • The given catalog entry does not exist.

  • The owner ID passed in the request BOD is different from the owner ID of the store in the context.

Request
Response
CatalogEntryFacadeClient.processCatalogEntry(ProcessCatalogEntryType)
DeleteAllAssociationsForSource /CatalogEntry[i] Delete all merchandising associations associated with the source catalog entry.
Request
Response
CatalogEntryFacadeClient.processCatalogEntry(ProcessCatalogEntryType)
DeleteAllAssociationsForTarget /CatalogEntry[i] Delete all merchandising associations associated with the target catalog entry.
Request
Response
CatalogEntryFacadeClient.processCatalogEntry(ProcessCatalogEntryType)
ChangeCatalogEntry Change /CatalogEntry[i]/CatalogEntryIdentifier Updates the part number field of a catalog entry in the master catalog.

Exceptions: An error results if one of the following conditions occurs:

  • The current catalog context is not a master catalog.

  • The part number provided for the catalog entry already exists for the given owner or store.

Request
Response
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType)
Change /CatalogEntry[i]/CatalogEntry/Description Updates the description of a catalog entry.
If a description is not found in the database, a new one is created.
The description is locale-dependent data.
Use this action to change the thumbnail image and full image as well as the following fields:

  • Name

  • Description and description attributes

  • Keyword

The following additional attributes can be changed:

  • Published

  • Additional Description 1

  • Additional Description 2

  • Available

  • Availability Date


Exceptions: An error results if one of the following conditions occurs:

  • The current catalog context is not a master catalog.

  • The language ID provided is not supported in the given store.

Request
Response
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType)
Add /CatalogEntry[i]/CatalogEntryAttributes/Attributes[i] New attributes can be created. Request
Response
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType)
Change /CatalogEntry[i]/CatalogEntryAttributes/Attributes[i] Updates the existing attributes. Request
Response
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType)
Delete /CatalogEntry[i]/CatalogEntryAttributes/Attributes[i] Deletes the existing attributes. Request
Response
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType)
Add /CatalogEntry[i]/ListPrice/AlternativeCurrencyPrice[i] Creates a new list price for different currencies.

Exceptions: An error results if one of the following conditions occurs:

  • The current catalog context is not a master catalog.

  • The given list price already exists.

  • The currency provided is not supported by the store.

Request
Response
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType)
Change /CatalogEntry[i]/ListPrice/AlternativeCurrencyPrice[i] Updates the list price for a catalog entry for different currencies.
If the given list price does not exist, a new list price is added for the given currency, or if the given list price does exist, the existing list price is updated.

Exceptions: An error results if one of the following conditions occurs:

  • The current catalog context is not a master catalog.

  • The currency provided is not supported by the store.

Request
Response
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType)
Delete /CatalogEntry[i]/ListPrice/AlternativeCurrencyPrice[i] Deletes the list price for a catalog entry for different currencies.
If the given list price does exist, the Web service deletes the list price, or, if the given list price does not exist, the Web service does nothing and does not return an error.
Request
Response
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType)
Change /CatalogEntry[i]/ParentCatalogGroupIdentifier Changes the parent category of a catalog entry in the master catalog.

Exceptions: An error results if one of the following conditions occurs:

Request
Response
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType)
Add /CatalogEntry[i]/ParentCatalogGroupIdentifier Adds the parent category of a catalog entry in the sales catalog.

Exceptions: An error results if one of the following conditions occurs:

  • The current catalog context is not a sales catalog.

  • The catalog entry to catalog group relationship already exists in the given catalog.

  • The parent category provided does not exist.

Request
Response
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType)
Delete /CatalogEntry[i]/ParentCatalogGroupIdentifier Deletes the parent category of a catalog entry in the sales catalog.

Exceptions: An error results if one of the following conditions occurs:

  • The current catalog context is not a sales catalog.

  • The catalog entry to catalog group relationship does not exist in the given catalog.

Request
Response
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType)
Change /CatalogEntry[i]/ParentCatalogEntryIdentifier Changes the parent product for a SKU in the master catalog.

Exceptions: An error results if one of the following conditions occurs:

Request
Response
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType)
Change /ChangeCatalogEntry[i]/NavigationRelationship[i] Changes the display sequence of an item, of a given parent product, in the master catalog.

Exceptions: An error results if one of the following conditions occurs:

  • The current catalog context is not a master catalog.

  • The catalog entry provided is not a product.

  • The child catalog entry provided is not a SKU.

  • The product-item relationship does not exist in the catalog.

Request
Response
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType)
Add /CatalogEntry[i]/Association[i] Adds merchandising associations to the master catalog.
The following properties can be set using this service:

  • Quantity

  • Display Sequence

  • Semantic specifier

  • Association name

  • Custom fields (e.g. field1, field2, field3, date1)


Exceptions: An error results if one of the following conditions occurs:

Request
Response
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType)
Change /CatalogEntry[i]/Association[i] Updates existing merchandising associations.
If the merchandising association unique ID is provided, the Web service uses it to search for the association. Otherwise, the Web service searches for the merchandising association using the following values passed from the request:

The previous fields can only be updated when the merchandising association unique ID is provided.
Exceptions: An error results if one of the following conditions occurs:

Request1 (Change the association by using identifiers other than the unique id)
Response1 (Change the association by using identifiers other than the unique id) Request2 (Change the association by using association unique id)
Response2 (Change the association by using association unique id)
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType)
Delete /CatalogEntry[i]/Association[i] Deletes existing merchandising associations.
If the merchandising association unique ID is provided, the Web service uses the ID to search for the merchandising association to be deleted. Otherwise, the following values passed from the request are used to do the search:

  • the source catalog entry

  • the target catalog entry

  • the type of the association code (e.g. "MerchandisingAssocation")

  • the name of the association (e.g. "ACCESSORY")

  • The semantic specifier


Exceptions: An error results if one of the following conditions occurs:

Request1 (Delete the association by using identifiers other than the unique id)
Response1 (Delete the association by using identifiers other than the unique id) Request2 (Delete the association by using association unique id)
Response2 (Delete the association by using association unique id)
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType)
Add /CatalogEntry[i]/KitComponent[i] Adds a kit component to the kit.
The following properties can be set using this service:

  • Display sequence

  • Quantity associated with this kit relationship

  • Custom fields (e.g. field1, field2, field3)

    • The attribute 'field1' is of type string

    • The attribute 'field2' is of type integer

    • The attribute 'field3' is of type decimal number


Exceptions: An error results if one of the following conditions occurs:

Request
Response
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType)
Change /CatalogEntry[i]/KitComponent[i] Updates the existing relationship between the kit component and the kit.
The following properties can be set using this service:

  • Display sequence

  • Quantity associated with this kit relationship

  • Custom fields (e.g. field1, field2, field3)

    • The attribute 'field1' is of type string

    • The attribute 'field2' is of type integer

    • The attribute 'field3' is of type decimal number


Exceptions: An error results if one of the following conditions occurs:

Request
Response
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType)
Delete /CatalogEntry[i]/KitComponent[i] Deletes the existing relationship between the kit component and the kit.

Exceptions: An error results if one of the following conditions occurs:

Request
Response
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType)
GetCatalogEntry All access profiles listed in the 'Access Profile' section can be applied to this expression. /CatalogEntry[CatalogEntryIdentifier
[(UniqueID=$uniqueId$)]]
Get Catalog Entry By Unique Id.
Returns the catalog entry for the given unique ID.
Request
Response
getCatalogEntrySummaryByID getCatalogEntrySummaryByIDs getCatalogEntryDetailsByID getCatalogEntryDetailsByIDs getCatalogEntryMerchandisingAssociationsByID getCatalogEntryComponentsByID getCatalogEntryFullDetailsByID
All access profiles listed in the 'Access Profile' section can be applied to this expression. /CatalogEntry[CatalogEntryIdentifier
[ExternalIdentifier[(PartNumber=$partNumber$)]]]
Get Catalog Entry By Part Number.
Returns the catalog entry for the given part number.
Request
Response
getCatalogEntrySummaryByPartNumber getCatalogEntrySummaryByPartNumbers getCatalogEntryDetailsByPartNumber getCatalogEntryDetailsByPartNumbers getCatalogEntryMerchandisingAssociationsByPartNumber getCatalogEntryComponentsByPartNumber
All access profiles listed in the 'Access Profile' section can be applied to this expression. /CatalogEntry[CatalogEntryIdentifier
[ExternalIdentifier[(PartNumber=$partNumber$
and @ownerID=$ownerId$)]]]
Get catalog entry by Part Number and Member Id.
Returns the catalog entry for the given part number and member ID.
Request
Response
getCatalogEntryByPartNumberAndMemberId
All access profiles listed in the 'Access Profile' section can be applied to this expression. /CatalogEntry[(@catalogEntryTypeCode=
$catalogEntryType$)
and search($searchCriteria$)]
Catalog entry basic search.
Returns the catalog entries that match the given search criteria, under the store ID in the context. Search is case sensitive and can be performed using one field or a combination of multiple fields as specified in the request expression.

The following fields can be used to specify catalog entry search criteria:

  • Part number

  • Name

  • Type

Request
Response
findAllCatentriesBasicSearch
All access profiles listed in the 'Access Profile' section can be applied to this expression. /CatalogEntry[(@catalogEntryTypeCode=
$catalogEntryType$) and ParentCatalogGroupIdentifier[
ExternalIdentifier[GroupIdentifier=
$groupIdentifier$]] and
search($searchCriteria$)]
Catalog entry advanced search.
Returns the catalog entries that match the given search criteria, under the store ID in the context. Search is case sensitive and can be performed using one field or combination of multiple fields as specified in the request expression.

Following is the list of database columns, and their corresponding Xpath, that can be used to specify catalog entry advanced search criteria.

To perform search on any of the following columns, its Xpath should be passed to the search function in action expression:

  • CATENTRY.PARTNUMBER - CatalogEntryIdentifier/ExternalIdentifier/PartNumber

  • CATENTRY.MFPARTNUMBER - CatalogEntryAttribute/Attributes/mfPartNumber

  • CATENTRY.MFNAME - CatalogEntryAttribute/Attributes/mfName

  • CATENTRY.FIELD1 - CatalogEntryAttribute/Attributes/field1

  • CATENTRY.FIELD2 - CatalogEntryAttribute/Attributes/field2

  • CATENTRY.FIELD3 - CatalogEntryAttribute/Attributes/field3

  • CATENTRY.FIELD4 - CatalogEntryAttribute/Attributes/field4

  • CATENTRY.FIELD5 - CatalogEntryAttribute/Attributes/field5

  • CATENTDESC.NAME - Description/Name

  • CATENTDESC.SHORTDESCRIPTION - Description/ShortDescription

  • CATENTDESC.PUBLISHED - Description/Attributes/published

Following search criteria should be specified outside the search function in action expression.

  • Parent Category

  • CatalogEntry Type

Request1 (Search on CatEntryType, PartNumber, Name)
Response1 (Search on CatEntryType, PartNumber, Name) Request2 (Search on CatEntryType, PartNumber, Name, Field1)
Response2 (Search on CatEntryType, PartNumber, Name, Field1) Request3 (Search on CatEntryType, PartNumber, Name, Field1, Field2, Field3, Field4, Field5)
Response3 (Search on CatEntryType, PartNumber, Name, Field1, Field2, Field3, Field4, Field5)
findAllCatentriesAdvancedSearch
All access profiles listed in the 'Access Profile' section can be applied to this expression. /CatalogEntry[KitComponent[
CatalogEntryReference[CatalogEntryIdentifier
[(UniqueID=$uniqueId$)]]]]

/CatalogEntry[KitComponent[
CatalogEntryReference[CatalogEntryIdentifier[
ExternalIdentifier[(PartNumber=$partnumber$)]]]]]
Get parent catalog entry of a catalog entry.
The parent catalog entry can only be a package, bundle or dynamic kit.
Request
Response
CatalogEntryFacadeClient.getCatalogEntry(GetCatalogEntryType)
All access profiles listed in the 'Access Profile' section can be applied to this expression. /CatalogEntry[NavigationRelationship[
CatalogEntryReference[CatalogEntryIdentifier[
(@type='child' and (UniqueID=$uniqueId$))]]]]
Get parent product of an item (SKU).
Returns the parent product of an item (SKU).
Request
Response
CatalogEntryFacadeClient.getCatalogEntry(GetCatalogEntryType)
All access profiles listed in the 'Access Profile' section can be applied to this expression. /CatalogEntry[ParentCatalogEntryIdentifier[
(UniqueID=$uniqueId$)]]

/CatalogEntry[ParentCatalogEntryIdentifier[
ExternalIdentifier[(PartNumber=
$partNumber$)]]]
Get child catalog entries of a catalog entry.
Returns the child catalog entries of the given catalog entry unique ID or partnumber.
Request
Response
getCatalogEntryByParentCatalogEntryId
All access profiles listed in the 'Access Profile' section can be applied to this expression. /CatalogEntry[Association[
CatalogEntryReference[CatalogEntryIdentifier
[(UniqueID=$uniqueId$)]]]]
Get merchandising association reference for catalog entry.
Returns the catalog entries which reference the given catalog entry unique ID through merchandising associations, under the store ID in the context.
Request
Response
getCatalogEntryMerchandisingAssociationReferencesById getCatalogEntryMerchandisingAssociationReferencesDetailsById
All access profiles listed in the 'Access Profile' section can be applied to this expression. /CatalogEntry Get unassigned catalog entries.
Returns the catalog entries, under the store ID in the context, which do not have a parent catalog group assigned.
Request
Response
getUnassignedCatalogEntriesDetails
All access profiles listed in the 'Access Profile' section can be applied to this expression. /CatalogEntry[ParentCatalogGroupIdentifier
[(UniqueID=$uniqueId$)]]

/CatalogEntry[ParentCatalogGroupIdentifier
[ExternalIdentifier[(
GroupIdentifier=$groupIdentifier$)]]]
Get child catalog entries of a catalog group.
Returns all child catalog entries of the given catalog group unique ID or identifier, except for SKUs having a parent product, under the given catalog ID in the context.
Request
Response
getCatalogEntryByParentCatalogGroupId getCatalogEntryDetailsByParentCatalogGroupId
All access profiles listed in the 'Access Profile' section can be applied to this expression. /CatalogEntry[KitComponent[
CatalogEntryReference[CatalogEntryIdentifier
[(@catalogEntryTypeCode='BundleBean'
and UniqueID=$uniqueId$)]]]]
Get bundle reference for a catalog entry.
Returns the catalog entries of type 'Bundle' where the given catalog entry is referenced (for example, the given catalog entry is a component).
Request
Response
getCatalogEntryBundleReferencesById
All access profiles listed in the 'Access Profile' section can be applied to this expression. /CatalogEntry[KitComponent[
CatalogEntryReference[CatalogEntryIdentifier
[(@catalogEntryTypeCode='DynamicKitBean'
and UniqueID=$uniqueId$)]]]]
Get kit reference for a catalog entry.
Returns the catalog entries of type 'Kit' where the given catalog entry is referenced (for example, the given catalog entry is a component).
Request
Response
getCatalogEntryKitReferencesById
IBM_Admin_CatalogEntrySalesCatalogReference /CatalogEntry[CatalogEntryIdentifier[
(UniqueID=$uniqueId$)]]
Get sales catalog reference from a catalog entry.
Returns information about all sales catalogs under the store ID in the context, which refer to the given catalog entry unique ID. The sales catalog reference can be established if the given catalog entry has a parent category in a catalog.
The sales catalog information is returned as a navigational relationship under the catalog entry noun. The type of the navigation relationship is 'child-parent'. The navigation path for the catalog entry in each sales catalog is also returned.
Request
Response
getCatalogEntrySalesCatalogReferencesById
All access profiles listed in the 'Access Profile' section that begin with 'IBM_Store' can be applied to this expression. /CatalogEntry[CatalogEntryIdentifier
[UniqueID=$uniqueId$] and Description[Attributes[published=1]]]
Get Catalog Entry By Unique Id.
Returns the catalog entry for the given unique ID.
Request
Response
getPublishedCatalogEntrySummaryByID getPublishedCatalogEntrySummaryByIDs getPublishedCatalogEntryDetailsByID getPublishedCatalogEntryDetailsByIDs getPublishedCatalogEntryMerchandisingAssociationsByID getPublishedCatalogEntryComponentsByID
All access profiles listed in the 'Access Profile' section that begin with 'IBM_Store' can be applied to this expression. /CatalogEntry[CatalogEntryIdentifier
[(UniqueID=)] and Description[Attributes[published=1]]]
Get Catalog Entry By Unique Id.
We can pass multiple Unique Ids
Returns the list of catalog entries for the given unique IDs.
Request
Response
getPublishedCatalogEntrySummaryByID getPublishedCatalogEntrySummaryByIDs getPublishedCatalogEntryDetailsByID getPublishedCatalogEntryDetailsByIDs getPublishedCatalogEntryMerchandisingAssociationsByID getPublishedCatalogEntryComponentsByID
All access profiles listed in the 'Access Profile' section that begin with 'IBM_Store' can be applied to this expression. /CatalogEntry[CatalogEntryIdentifier
[ExternalIdentifier[(PartNumber=$partNumber$)]] and Description[Attributes[published=1]]]
Get Catalog Entry By Part Number.
Returns the catalog entry for the given part number.
Request
Response
getPublishedCatalogEntrySummaryByPartNumber getPublishedCatalogEntryDetailsByPartNumber getPublishedCatalogEntryMerchandisingAssociationsByPartNumber getPublishedCatalogEntryComponentsByPartNumber
All access profiles listed in the 'Access Profile' section that begin with 'IBM_Store' can be applied to this expression. /CatalogEntry[Description[Attributes[published=1]] and ParentCatalogGroupIdentifier
[(UniqueID=$catGroupId$)]]

Get child catalog entries of a catalog group.
Returns all child catalog entries of the given catalog group unique ID, except for SKUs having a parent product, under the given catalog ID in the context.
Request
Response
getPublishedCatalogEntryByParentCatalogGroupId
All access profiles listed in the 'Access Profile' section that begin with 'IBM_Store' can be applied to this expression. /CatalogEntry[CatalogEntryIdentifier
[ExternalIdentifier[contains(@PartNumber,'$partNumber$')]] and Description[Attributes[published=1]]]
Get Catalog Entry By Part Number.
Returns the catalog entry if '$partNumber$' parameter contains '@PartNumber' value.
Request
Response
findPublishedCatalogEntriesSummaryByPartNumber findPublishedCatalogEntriesDetailsByPartNumber
All access profiles listed in the 'Access Profile' section that begin with 'IBM_Store' can be applied to this expression. /CatalogEntry[Description[Attributes[published=1]] and Description[contains(@Name,'$name$')]] Get Catalog Entry By Name.
Returns the catalog entry if '$name$' parameter contains '@Name' value.
Request
Response
findPublishedCatalogEntriesSummaryByName findPublishedCatalogEntriesDetailsByName
All access profiles listed in the 'Access Profile' section that begin with 'IBM_Store' can be applied to this expression. /CatalogEntry[Description[Attributes[published=1]] and Description[contains(@ShortDescription,'$description$')]] Get Catalog Entry By Short Description.
Returns the catalog entry if '$description$' parameter contains '@ShortDescription' value.
Request
Response
findPublishedCatalogEntriesSummaryByDescription findPublishedCatalogEntriesDetailsByDescription
Access profiles IBM_Admin_CatalogEntryMerchandisingAssociations_Paging can be applied to this expression. /CatalogEntry[Association[Attributes[@storeID=$storeId$]] and CatalogEntryIdentifier[UniqueID=$UniqueID$]]/Association Get the current page of merchandising associations owned by given store for the Catalog Entry. Request
Response
getCatalogEntryLocalMerchandisingAssociationsByIDWithPaging
Access profiles IBM_Admin_CatalogEntryMerchandisingAssociations_Paging can be applied to this expression. /CatalogEntry[Association[Attributes[@storeID!=$storeId$]] and CatalogEntryIdentifier[UniqueID=$UniqueID$]]/Association Get the current page of merchandising associations in store path but exclude the associations owned by the given store for the Catalog Entry. Request
Response
getCatalogEntryInheritedMerchandisingAssociationsByIDWithPaging
Access profiles IBM_Admin_CatalogEntryMerchandisingAssociations_Paging can be applied to this expression. /CatalogEntry[Association[Attributes[@storeID=$storeId$]] and CatalogEntryIdentifier[ExternalIdentifier[PartNumber=$PartNumber$]]]/Association Get the current page of merchandising associations owned by given store for the Catalog Entry according to part number. Request
Response
getCatalogEntryLocalMerchandisingAssociationsByIDWithPaging
Access profiles IBM_Admin_CatalogEntryMerchandisingAssociations_Paging can be applied to this expression. /CatalogEntry[Association[Attributes[@storeID!=$storeId$]] and CatalogEntryIdentifier[ExternalIdentifier[PartNumber=$PartNumber$]]]/Association Get the current page of merchandising associations in store path but exclude the associations owned by the given store for the Catalog Entry according to the part number. Request
Response
getCatalogEntryInheritedMerchandisingAssociationsByIDWithPaging
Access profiles IBM_Admin_CatalogEntryDescriptiveAttributes_Paging can be applied to this expression. /CatalogEntry[CatalogEntryAttributes[Attributes[(@usage=$usage$)]] and CatalogEntryIdentifier[UniqueID=$UniqueID$]]/CatalogEntryAttributes Get the current page of classic descriptive attributes (usage='2') for the Catalog Entry. Request
Response
getCatalogEntryDescriptiveAttributesByIDWithPaging
Access profiles IBM_Admin_CatalogEntryAttrDictDescriptiveAttributes_Paging can be applied to this expression. /CatalogEntry[CatalogEntryAttributes[Attributes[(@usage=$usage$) and AttributeIdentifier]] and CatalogEntryIdentifier[UniqueID=$UniqueID$]]/CatalogEntryAttributes Get the current page of attribute dictionary descriptive attributes (usage='2' and AttributeIdentifier is not null) for the Catalog Entry. Request
Response
getCatalogEntryAttrDictDescriptiveAttributesByIDWithPaging



Access Profile

Access Profile Data Returned Description Sample XML Message
IBM_Store_CatalogEntryAttributes

  • /CatalogEntry/CatalogEntryIdentifier/UniqueID

  • /CatalogEntry/Attributes@displaySequence

  • /CatalogEntry/Attributes@language

  • /CatalogEntry/Attributes@usage

  • /CatalogEntry/Attributes/AttributeIdentifier/UniqueId

  • /CatalogEntry/Attributes/Name

  • /CatalogEntry/Attributes/Description

  • /CatalogEntry/Attributes/AttributeDataType

  • /CatalogEntry/Attributes/AllowedValue@displaySequence

  • /CatalogEntry/Attributes/AllowedValue@identifier

  • /CatalogEntry/Attributes/AllowedValue/Value

  • /CatalogEntry/Attributes/Value@identifier

  • /CatalogEntry/Attributes/Value

  • /CatalogEntry/Attributes/StringValue

    • Include optional base CatalogEntryAttributes:

      • manufacturer

This access profile is designed for store front to use. It returns the attributes definitions and their values for a specified catalog entry in the current language.

Only the catalog entries entitled to current user are returned.

The "Defining" and "Descriptive" attributes are ordered according to the display sequence of the attributes. The allowed values are order according to the display sequence of the allowed values.
Get Product Attributes Request
Get Product Attributes Response Get SKU Attributes Request
Get SKU Attributes Response
IBM_Store_CatalogEntryAttributesParent IBM_Store_CatalogEntryAttributes
+
IBM_Store_CatalogEntryAttributes of the parent (if applicable)
This access profile is designed for store front to use. It returns the attributes definitions and their values for a specified catalog entry as well as its parent (if applicable) in the current language.

For example, if the catalog entry is a SKU, the attributes of itself and its parent product are returned. Only the catalog entries entitled to current user are returned.

The "Defining" and "Descriptive" attributes are ordered according to the display sequence of the attributes. The allowed values are order according to the display sequence of the allowed values.
Get SKU and Parent Attributes Request
Get SKU and Parent Attributes Response
IBM_Admin_CatalogEntryAttributes

  • /CatalogEntry/CatalogEntryIdentifier/

  • /CatalogEntry/Attributes@language

  • /CatalogEntry/Attributes@usage

  • /CatalogEntry/Attributes@displaySequence

  • /CatalogEntry/Attributes/AttributeIdentifier/UniqueId

  • /CatalogEntry/Attributes/AttributeIdentifier/ExternalIdentifier/Identifier

  • /CatalogEntry/Attributes/AttributeIdentifier/ExternalIdentifier/StoreIdentifier/UniqueId

  • /CatalogEntry/Attributes/Name

  • /CatalogEntry/Attributes/Description

  • /CatalogEntry/Attributes/AttributeDataType

  • /CatalogEntry/Attributes/AllowedValue@identifier

  • /CatalogEntry/Attributes/AllowedValue@displaySequence

  • /CatalogEntry/Attributes/AllowedValue@storeID

  • /CatalogEntry/Attributes/AllowedValue/Value

  • /CatalogEntry/Attributes/AllowedValue/StringValue

  • /CatalogEntry/Attributes/AllowedValue/IntegerValue

  • /CatalogEntry/Attributes/AllowedValue/FloatValue

  • /CatalogEntry/Attributes/ExtendedData

  • /CatalogEntry/Attributes/Value@identifier

  • /CatalogEntry/Attributes/Value@storeID

  • /CatalogEntry/Attributes/Value

  • /CatalogEntry/Attributes/StringValue

  • /CatalogEntry/Attributes/IntegerValue

  • /CatalogEntry/Attributes/FloatValue

  • /CatalogEntry/Attributes/ExtendedValue

This access profile is designed for the Catalogs tool. It returns all information of the attribute definitions and their values of a specified catalog entry in the specified languages.

For attribute dictionary attributes, the attribute dictionary id, store id for the attribute and for the allowed values are also returned.

There is no entitlement check for this access profile.

This access profile supports extended site. This means the attributes and values owned by the asset store will also be returned if current store is a extended site store.

The attributes are ordered according to the original order when they are created. The allowed values are order according to the original order when they are created.
Get Product Attributes Request
Get Product Attributes Response Get SKU Attributes Request
Get SKU Attributes Response Get Product Classic Attributes Request
Get Product Classic Attributes Response
IBM_Admin_CatalogEntryDescriptiveAttributes_Paging

  • /CatalogEntry/CatalogEntryIdentifier/

  • /CatalogEntry/Attributes@language

  • /CatalogEntry/Attributes@usage

  • /CatalogEntry/Attributes@displaySequence

  • /CatalogEntry/Attributes/Name

  • /CatalogEntry/Attributes/Description

  • /CatalogEntry/Attributes/AttributeDataType

  • /CatalogEntry/Attributes/ExtendedData

  • /CatalogEntry/Attributes/Value@identifier

  • /CatalogEntry/Attributes/Value@storeID

  • /CatalogEntry/Attributes/Value

  • /CatalogEntry/Attributes/StringValue

  • /CatalogEntry/Attributes/IntegerValue

  • /CatalogEntry/Attributes/FloatValue

  • /CatalogEntry/Attributes/ExtendedValue

This access profile is designed for the Catalogs tool. It returns current page of the classic descriptive attributes and their values of a specified catalog entry in the specified languages.

It can only used with Action Expression end with /CatalogEntryAttributes.
 
IBM_Admin_CatalogEntryAttrDictDescriptiveAttributes_Paging

  • /CatalogEntry/CatalogEntryIdentifier/

  • /CatalogEntry/Attributes@language

  • /CatalogEntry/Attributes@usage

  • /CatalogEntry/Attributes@displaySequence

  • /CatalogEntry/Attributes/AttributeIdentifier/UniqueId

  • /CatalogEntry/Attributes/AttributeIdentifier/ExternalIdentifier/Identifier

  • /CatalogEntry/Attributes/AttributeIdentifier/ExternalIdentifier/StoreIdentifier/UniqueId

  • /CatalogEntry/Attributes/Name

  • /CatalogEntry/Attributes/Description

  • /CatalogEntry/Attributes/AttributeDataType

  • /CatalogEntry/Attributes/ExtendedData

  • /CatalogEntry/Attributes/Value@identifier

  • /CatalogEntry/Attributes/Value@storeID

  • /CatalogEntry/Attributes/Value

  • /CatalogEntry/Attributes/StringValue

  • /CatalogEntry/Attributes/IntegerValue

  • /CatalogEntry/Attributes/FloatValue

  • /CatalogEntry/Attributes/ExtendedValue

This access profile is designed for the Catalogs tool. It returns current page of the attribute dictionary descriptive attributes and their values of a specified catalog entry in the specified languages.

It can only used with Action Expression end with /CatalogEntryAttributes.
 
IBM_Admin_CatalogEntryDefiningAttributes

  • /CatalogEntry/CatalogEntryIdentifier/

  • /CatalogEntry/Attributes@language

  • /CatalogEntry/Attributes@usage

  • /CatalogEntry/Attributes@displaySequence

  • /CatalogEntry/Attributes/Name

  • /CatalogEntry/Attributes/Description

  • /CatalogEntry/Attributes/AttributeDataType

  • /CatalogEntry/Attributes/AllowedValue@identifier

  • /CatalogEntry/Attributes/AllowedValue@displaySequence

  • /CatalogEntry/Attributes/AllowedValue@storeID

  • /CatalogEntry/Attributes/AllowedValue/Value

  • /CatalogEntry/Attributes/AllowedValue/StringValue

  • /CatalogEntry/Attributes/AllowedValue/IntegerValue

  • /CatalogEntry/Attributes/AllowedValue/FloatValue

  • /CatalogEntry/Attributes/ExtendedData

  • /CatalogEntry/Attributes/Value@identifier

  • /CatalogEntry/Attributes/Value@storeID

  • /CatalogEntry/Attributes/Value

  • /CatalogEntry/Attributes/StringValue

  • /CatalogEntry/Attributes/IntegerValue

  • /CatalogEntry/Attributes/FloatValue

  • /CatalogEntry/Attributes/ExtendedValue

This access profile is designed for the Catalogs tool. It returns classic defining attribute definitions and their values of a specified catalog entry in the specified languages.

 
IBM_Admin_CatalogEntryAttrDictDefiningAttributes

  • /CatalogEntry/CatalogEntryIdentifier/

  • /CatalogEntry/Attributes@language

  • /CatalogEntry/Attributes@usage

  • /CatalogEntry/Attributes@displaySequence

  • /CatalogEntry/Attributes/AttributeIdentifier/UniqueId

  • /CatalogEntry/Attributes/AttributeIdentifier/ExternalIdentifier/Identifier

  • /CatalogEntry/Attributes/AttributeIdentifier/ExternalIdentifier/StoreIdentifier/UniqueId

  • /CatalogEntry/Attributes/Name

  • /CatalogEntry/Attributes/Description

  • /CatalogEntry/Attributes/AttributeDataType

  • /CatalogEntry/Attributes/AllowedValue@identifier

  • /CatalogEntry/Attributes/AllowedValue@displaySequence

  • /CatalogEntry/Attributes/AllowedValue@storeID

  • /CatalogEntry/Attributes/AllowedValue/Value

  • /CatalogEntry/Attributes/AllowedValue/StringValue

  • /CatalogEntry/Attributes/AllowedValue/IntegerValue

  • /CatalogEntry/Attributes/AllowedValue/FloatValue

  • /CatalogEntry/Attributes/ExtendedData

  • /CatalogEntry/Attributes/Value@identifier

  • /CatalogEntry/Attributes/Value@storeID

  • /CatalogEntry/Attributes/Value

  • /CatalogEntry/Attributes/StringValue

  • /CatalogEntry/Attributes/IntegerValue

  • /CatalogEntry/Attributes/FloatValue

  • /CatalogEntry/Attributes/ExtendedValue

This access profile is designed for the Catalogs tool. It returns attribute dictionary defining attributes and their values of a specified catalog entry in the specified languages.

 
IBM_Admin_CatalogEntryPrice

  • /CatalogEntry/CatalogEntryIdentifier/UniqueID

  • /CatalogEntry/CatalogEntryIdentifier/ExternalIdentifier(@ownerID)

  • /CatalogEntry/CatalogEntryIdentifier/ExternalIdentifier(@ownerID)/PartNumber

  • /CatalogEntry/CatalogEntryIdentifier/ExternalIdentifier(@ownerID)/StoreIdentifier/UniqueID

  • /CatalogEntry/Price/StandardPrice/Price/Price(@currency)

  • /CatalogEntry/Price/StandardPrice/Price/Quantity

This access profile is designed for the Catalogs tool. It returns the price information of a catalog entry.  
IBM_Admin_Summary IBM_Admin_CatalogEntryPrice
+

  • /CatalogEntry(@catalogEntryTypeCode @displaySequence @navigationPath)

  • /CatalogEntry/Description(@language)/Name

  • /CatalogEntry/Description(@language)/ThumbNail

  • /CatalogEntry/Description(@language)/ShortDescription

  • /CatalogEntry/ListPrice/Price(@currency)

  • /CatalogEntry/ListPrice/Price

  • /CatalogEntry/ListPrice/Quantity

This access profile is designed for the Catalogs tool. It returns the base description and price information of a catalog entry.  
IBM_Admin_Details IBM_Admin_Summary
+

  • /CatalogEntry/Description(@language)/FullImage

  • /CatalogEntry/Description(@language)/LongDescription

  • /CatalogEntry/Description(@language)/keyword

  • /CatalogEntry/Description(@language)/Attributes

  • Required Description Attributes:

    • AlternateDescription1

    • AlternateDescription2

  • Required CatalogEntryAttributes:

    • Manufacturer

    • ManufacturerPartNumber

    • ForPurchase

    • OnSpecial

    • OnAuction

    • AnnouncementDate

    • WithdrawalDate

    • AvailabilityDate

    • LastDateToOrder

    • EndOfServiceDate

    • DiscontinuedDate

    • Field1

    • Field2

    • Field3

    • Field4

    • Field5

    • DisplayTemplate

    • ReferenceURL

    • ForPurchase

    • DisplayToCustomer

  • /CatalogEntry/ParentCatalogGroupIdentifier/UniqueID

  • /CatalogEntry/ParentCatalogGroupIdentifier/ExternalIdentifier(@ownerID)

  • /CatalogEntry/ParentCatalogGroupIdentifier/ExternalIdentifier(@ownerID)/GroupIdentifier

This access profile is designed for the Catalogs tool. It returns the detailed information of a catalog entry.  
IBM_Admin_CatalogEntryMerchandisingAssociations

  • /CatalogEntry/Association(@quantity @displaySequence @AssociationCodeType @uniqueId)

  • /CatalogEntry/Association/Name

  • /CatalogEntry/Association/ AssociationCodeType

  • /CatalogEntry/Association/CatalogEntryReference(@catalogEntryTypeCode @navigationPath)

  • /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'.

This access profile is designed for the Catalogs tool. It returns the merchandising association information of a catalog entry.  
name=IBM_Admin_CatalogEntryMerchandisingAssociations_Paging

  • /CatalogEntry/Association(@quantity @displaySequence @AssociationCodeType @uniqueId)

  • /CatalogEntry/Association/Name

  • /CatalogEntry/Association/ AssociationCodeType

  • /CatalogEntry/Association/CatalogEntryReference(@catalogEntryTypeCode @navigationPath)

  • /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'.

This access profile is designed for the Catalogs tool. It returns the the current page of merchandising association information of a catalog entry. It can only used with Action Expression ended with "/Associaiton"  
IBM_Admin_CatalogEntryComponents IBM_Admin_Details
+
(For Product - Item Relationship):

  • /CatalogEntry/NavigationRelationship(@displaySequence @type)

  • /CatalogEntry/NavigationRelationship/CatalogEntryReference(@catalogEntryTypeCode)

  • /CatalogEntry/NavigationRelationship/CatalogEntryReference(@navigationPath)

  • /CatalogEntry/NavigationRelationship/CatalogEntryReference/CatalogEntryIdentifier/UniqueId

  • /CatalogEntry/NavigationRelationship/CatalogEntryReference/CatalogEntryIdentifier/ExternalIdentifier(@ownerID)

  • /CatalogEntry/NavigationRelationship/CatalogEntryReference/CatalogEntryIdentifier/ExternalIdentifier/PartNumber

  • /CatalogEntry/NavigationRelationship/CatalogEntryReference/DisplayName

(For Package, Bundle and DynamicKit Relationship ):

  • /CatalogEntry/KitComponent(@displaySequence @quantity @KitComponentCodeType)

  • /CatalogEntry/KitComponent/CatalogEntryReference(@catalogEntryTypeCode)

  • /CatalogEntry/KitComponent/CatalogEntryReference(@navigationPath)

  • /CatalogEntry/KitComponent/CatalogEntryReference/CatalogEntryIdentifier/UniqueId

  • /CatalogEntry/KitComponent/CatalogEntryReference/CatalogEntryIdentifier/ExternalIdentifier(@ownerID)

  • /CatalogEntry/KitComponent/CatalogEntryReference/CatalogEntryIdentifier/ExternalIdentifier/PartNumber

  • /CatalogEntry/KitComponent/CatalogEntryReference/DisplayName

KitComponentCodeType for Package 'PACKAGE_COMPONENT'
KitComponentCodeType for Bundle 'BUNDLE_COMPONENT'
KitComponentCodeType for Dynamic Kit 'DYNAMIC_KIT_COMPONENT'

This access profile is designed for the Catalogs tool. It returns the child catalog entries of the given catalog entry.  
IBM_Admin_All IBM_CatalogEntryMerchandisingAssociations
+
IBM_CatalogEntryComponents
+

  • /CatalogEntry/ParentCatalogEntryIdentifier/UniqueID

  • /CatalogEntry/ParentCatalogEntryIdentifier/ExternalIdentifier(@ownerID)

  • /CatalogEntry/ParentCatalogEntryIdentifier/ExternalIdentifier(@ownerID)/PartNumber

  • /CatalogEntry/CatalogEntryAttributes(@displaySequence @language @usage)

  • /CatalogEntry/CatalogEntryAttributes(@displaySequence @language @usage)/Name

  • /CatalogEntry/CatalogEntryAttributes(@displaySequence @language @usage)/Description

  • /CatalogEntry/CatalogEntryAttributes(@displaySequence @language @usage)/StringValue/Value

  • /CatalogEntry/CatalogEntryAttributes(@displaySequence @language @usage)/IntegerValue/Value

  • /CatalogEntry/CatalogEntryAttributes(@displaySequence @language @usage)/FloatValue/Value

  • Required CatalogEntryAttributes:

    • UOM/Unit

    • UOM/Weight

    • UOM/WeightMeasure

    • UOM/MultipleOfAmt

    • UOM/ItemPerPackage

    • SalesTax/SelectedTaxes

    • SalesTax/AvailableTaxes

    • ShipTax/Selected

    • ShipTax/Available

This access profile is designed for the Catalogs tool. It returns all related information for a catalog entry. For example, the description, merchandising association and attribute information of the given catalog entry are returned using this access profile.  
IBM_Store_Summary

  • /CatalogEntry(@catalogEntryTypeCode)

  • /CatalogEntry/CatalogEntryIdentifier/UniqueID

  • /CatalogEntry/ CatalogEntryIdentifier/ExternalIdentifier(@ownerID)

  • /CatalogEntry/ CatalogEntryIdentifier/ExternalIdentifier(@ownerID)/PartNumber

  • /CatalogEntry/Description(@language)/Name

  • /CatalogEntry/Description(@language)/ThumbNail

  • /CatalogEntry/Description(@language)/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(@minimumQuantity) /Price/Price(@currency)

  • /CatalogEntry/Price/ContractPrice(@minimumQuantity) /Price/Quantity

  • /CatalogEntry/Price/ContractPrice(@minimumQuantity)ContractIdentifier/UniqueID

  • /CatalogEntry/Price/ContractPrice(@minimumQuantity)ContractIdentifier/UniqueID

  • /CatalogEntry/Price/ContractPrice(@minimumQuantity)ContractIdentifier/ExternalIdentifier(@majorVersionNumber @minorVersionNumber @origin @ownerID)

  • /CatalogEntry/Price/ContractPrice(@minimumQuantity)ContractIdentifier/ExternalIdentifier(@majorVersionNumber @minorVersionNumber @origin @ownerID)/Name

This access profile is designed for the Catalogs tool. It returns the summary information of a category.  
IBM_Store_Details IBM_Store_Summary
+

  • /CatalogEntry/Description(@language)/FullImage

  • /CatalogEntry/Description(@language)/LongDescription

  • /CatalogEntry/CatalogEntryAttributes(@displaySequence @language @usage)

  • /CatalogEntry/CatalogEntryAttributes(@displaySequence @language @usage)/Name

  • /CatalogEntry/CatalogEntryAttributes(@displaySequence @language @usage)/Description

  • /CatalogEntry/CatalogEntryAttributes(@displaySequence @language @usage)/StringValue/Value

  • /CatalogEntry/CatalogEntryAttributes(@displaySequence @language @usage)/IntegerValue/Value

  • /CatalogEntry/CatalogEntryAttributes(@displaySequence @language @usage)/FloatValue/Value

This access profile is designed for the Catalogs tool. It returns the detailed information of a category.  
IBM_Store_CatalogEntryMerchandisingAssociations IBM_Store_Details
+

  • /CatalogEntry/Association(@quantity @displaySequence)

  • /CatalogEntry/Association(@quantity @displaySequence)/Name

  • /CatalogEntry/Association(@quantity @displaySequence)/ AssociationCodeType

  • /CatalogEntry/Association(@quantity @displaySequence)/CatalogEntryReference(@catalogEntryTypeCode)/displayName

  • /CatalogEntry/Association(@quantity @displaySequence)/CatalogEntryReference(@catalogEntryTypeCode)/CatalogEntryIdentifier/UniqueID

  • /CatalogEntry/Association(@quantity @displaySequence)/CatalogEntryReference(@catalogEntryTypeCode)/CatalogEntryIdentifier/ExternalIdentifier(@ownerID)

  • /CatalogEntry/Association(@quantity @displaySequence)/CatalogEntryReference(@catalogEntryTypeCode)/CatalogEntryIdentifier/ExternalIdentifier(@ownerID)/PartNumber

This access profile is designed for the Catalogs tool. It returns the merchandising association information of a catalog entry.  
IBM_Store_CatalogEntryComponents IBM_Store_Details
+

  • /CatalogEntry/Association(@quantity @displaySequence)

  • /CatalogEntry/Association(@quantity @displaySequence)/Name

  • /CatalogEntry/Association(@quantity @displaySequence)/ AssociationCodeType

  • /CatalogEntry/Association(@quantity @displaySequence)/CatalogEntryReference(@catalogEntryTypeCode)/displayName

  • /CatalogEntry/Association(@quantity @displaySequence)/CatalogEntryReference(@catalogEntryTypeCode)/CatalogEntryIdentifier/UniqueID

  • /CatalogEntry/Association(@quantity @displaySequence)/CatalogEntryReference(@catalogEntryTypeCode)/CatalogEntryIdentifier/ExternalIdentifier(@ownerID)

  • /CatalogEntry/Association(@quantity @displaySequence)/CatalogEntryReference(@catalogEntryTypeCode)/CatalogEntryIdentifier/ExternalIdentifier(@ownerID)/PartNumber

This access profile is designed for the Catalogs tool. It returns the child catalog entries of the given catalog entry.  



XSD files


Topic URL: _vcc_freeselect_bottom_


+

Search Tips   |   Advanced Search