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:
|
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:
|
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:
|
Request
Response |
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType) |
Change | /CatalogEntry[i]/Description[i] |
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. You can use this action to change the thumbnail image and full image as well as the following fields:
Exceptions: An error results if one of the following conditions occurs:
|
Request
Response |
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType) | |
Change | /CatalogEntry[i]/Description[i]/Override[i] |
Updates the description override of a catalog entry. If a description override is not found in the database, a new one is created. The description override is locale-dependent data. You can use this action to change the thumbnail image and full image override as well as the following override fields:
Exceptions: An error results if one of the following conditions occurs:
|
Request
Response |
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType) | |
Change | /CatalogEntry[i]/SEOURL[i] |
Creates or updates the SEO URL of a catalog entry in a given language Exceptions: An error results if one of the following conditions occurs:
|
Request
Response |
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType) | |
Change | /CatalogEntry[i]/SEOProperties[i] |
Creates or updates the SEO properties of a catalog entry in a given language The following values can be changed:
|
Request
Response |
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType) | |
Add | /CatalogEntry[i]/SEOURL[i] |
Creates or updates the SEO URL of a catalog entry in a given language Exceptions: An error results if one of the following conditions occurs:
|
Request
Response |
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType) | |
Delete | /CatalogEntry[i]/SEOURL[i] |
Deletes the SEO URL of a catalog entry in a given language. |
Request
Response |
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType) | |
Delete | /CatalogEntry[i]/SEOProperties[i] | Deletes the SEO properties of a catalog entry in a given language. |
Request
Response |
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType) | |
Add | /CatalogEntry[i]/CatalogEntryAttributes/Attributes[i] | New attributes can be created for classic attributes. |
Request
Response |
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType) | |
Add | /CatalogEntry[i]/CatalogEntryAttributes/Attributes[i] | New defining attributes can be created for attribute dictionary attributes. |
Request
Response |
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType) | |
Add | /CatalogEntry[i]/CatalogEntryAttributes/Attributes[i] | New descriptive attributes can be created for attribute dictionary attributes. |
Request
Response |
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType) | |
Add | /CatalogEntry[i]/CatalogEntryAttributes/Attributes[i] | New descriptive attributes with free form fields can be created for attribute dictionary attributes. |
Request
Response |
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType) | |
Change | /CatalogEntry[i]/CatalogEntryAttributes/Attributes[i] | Updates the existing attributes for classical attributes. |
Request
Response |
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType) | |
Change | /CatalogEntry[i]/CatalogEntryAttributes/Attributes[i] | Updates the sequence and custom fields of an existing catalog entry attribute dictionary attribute. |
Request
Response |
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType) | |
Change | /CatalogEntry[i]/CatalogEntryAttributes/Attributes[i] | Updates the catalog entry attribute dictionary attribute by associating an allowed defining attribute value to the given defining attribute for a SKU. |
Request
Response |
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType) | |
Change | /CatalogEntry[i]/CatalogEntryAttributes/Attributes[i] | Updates the catalog entry attribute dictionary descriptive attribute by specifying a new value for the attribute assigned value. |
Request
Response |
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType) | |
Change | /CatalogEntry[i]/CatalogEntryAttributes/Attributes[i] | Updates the catalog entry attribute dictionary descriptive attribute by specifying a new value for the attribute assigned value of String data type. |
Request
Response |
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType) | |
Change | /CatalogEntry[i]/CatalogEntryAttributes/Attributes[i] | Updates the catalog entry attribute dictionary descriptive attribute by specifying a new value for the attribute assigned value of Integer data type. |
Request
Response |
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType) | |
Change | /CatalogEntry[i]/CatalogEntryAttributes/Attributes[i] | Updates the catalog entry attribute dictionary descriptive attribute by specifying a new value for the attribute assigned value of Float data type. |
Request
Response |
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType) | |
Change | /CatalogEntry[i]/CatalogEntryAttributes/Attributes[i] | Updates the catalog entry attribute dictionary attribute assigned value in a different language (language id is provided in the noun part). |
Request
Response |
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType) | |
Change | /CatalogEntry[i]/CatalogEntryAttributes/Attributes[i] | Updates the catalog entry attribute dictionary descriptive attribute by updating the attribute assigned value of String data type (custom fields and additional data for the value and value descriptions are provided). |
Request
Response |
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType) | |
Delete | /CatalogEntry[i]/CatalogEntryAttributes/Attributes[i] | Deletes an attribute dictionary attribute from a catalog entry. |
Request
Response |
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType) | |
Delete | /CatalogEntry[i]/CatalogEntryAttributes/Attributes[i] | Deletes the existing attributes. |
Request
Response |
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType) | |
Add | /CatalogEntry[i]/CatalogEntryAttributes/Attributes[i]/AllowedValue[i] | New allowed values can be created for the attribute belonging to a catalog entry. |
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:
|
Request
Response |
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType) | |
Add | /CatalogEntry[i]/AttachmentReference[i] |
Creates an attachment reference for a catalog entry.
Exceptions: An error results if one of the following conditions occurs:
|
Request
Response |
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType) | |
Change | /CatalogEntry[i]/AttachmentReference[i] |
Updates a catalog entry attachment property. The following properties can be updated using this service:
Exceptions: An error results if the following condition occurs:
|
Request
Response |
CatalogEntryFacadeClient.changeCatalogEntry(ChangeCatalogEntryType) | |
Delete | /CatalogEntry[i]/AttachmentReference[i] | Deletes an attachment reference for a catalog entry. |
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:
|
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:
|
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:
|
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:
|
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:
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:
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:
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:
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:
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:
|
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:
|
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). This web service does not return those dynamic kits configured by the Sterling Commerce Configurator. |
Request
Response |
getCatalogEntryKitReferencesById | |
All access profiles listed in the 'Access Profile' section can be applied to this expression. |
/CatalogEntry[(@catalogEntryTypeCode='DynamicKitBean') and KitComponent[CatalogEntryReference [CatalogEntryIdentifier[(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). This web service returns those dynamic kits configured by the Sterling Commerce Configurator. |
Request
Response |
getCatalogEntryAllKitReferencesById | |
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 | |
IBM_Admin_SEO |
/CatalogEntry[CatalogEntryIdentifier[ (UniqueID=$uniqueId$)]] |
Get the SEO URL and SEO properties of a catalog entry. |
Request
Response |
getCatalogEntry | |
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 profiles IBM_Admin_CatalogEntryAttributeNameValues can be applied to this expression. |
/CatalogEntry[CatalogEntryIdentifier[ (UniqueID=$uniqueId$)]] |
Get Attributes Name and Values of Product, it parents and children Returns information about the attributes of the catalog entry, its parents and children. |
Request Response |
getCatalogEntry |
Access Profile | Data Returned | Description | Sample XML Message |
---|---|---|---|
IBM_Store_CatalogEntryAttributes |
|
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 ResponseGet 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 |
|
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 ResponseGet SKU Attributes Request Get SKU Attributes ResponseGet Product Classic Attributes Request Get Product Classic Attributes Response |
IBM_Admin_CatalogEntryDescriptiveAttributes_Paging |
|
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 |
|
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 |
|
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 |
|
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 |
|
This access profile is designed for the Catalogs tool. It returns the price information of a catalog entry. | |
IBM_Admin_Summary |
IBM_Admin_CatalogEntryPrice +
|
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 +
|
This access profile is designed for the Catalogs tool. It returns the detailed information of a catalog entry. | |
IBM_Admin_CatalogEntryMerchandisingAssociations |
|
This access profile is designed for the Catalogs tool. It returns the merchandising association information of a catalog entry. | |
IBM_Admin_CatalogEntryMerchandisingAssociations_Paging |
|
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):
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 +
|
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_Admin_CatalogEntryDescription |
|
This access profile is designed for the Catalogs tool. It returns the base description and price information of a catalog entry. | |
IBM_Store_Summary |
|
This access profile is designed for the Catalogs tool. It returns the summary information of a category. | |
IBM_Store_Details |
IBM_Store_Summary +
|
This access profile is designed for the Catalogs tool. It returns the detailed information of a category. | |
IBM_Store_CatalogEntryMerchandisingAssociations |
IBM_Store_Details +
|
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 +
|
This access profile is designed for the Catalogs tool. It returns the child catalog entries of the given catalog entry. | |
IBM_Admin_CatalogEntryAttributeNameValues |
|
This access profile is designed for Promotion Validation. It returns the attribute name and values of the given Catalog entry, it's child Catalog entries and Parent Catalog Entries. |