Catalog: CatalogFilter Noun

The CatalogFilter noun defines types related to a catalog filter. A catalog filter contains the information to filter the categories and products within a catalog based on static inclusions or exclusions and dynamic conditions that are based the properties or attributes of products.

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
ProcessCatalogFilter	Create	/CatalogFilter[]	Create a catalog filter on a catalog for a store. The catalog and the store are the ones in current business context.	Request Response	CatalogFilterFacadeClient.createCatalogFilter(java.util.List)
	Delete	/CatalogFilter[]	Delete a catalog filter.	Request Response	CatalogFilterFacadeClient.deleteCatalogFilter(CatalogFilterIdentifierType[])
ChangeCatalogFilter	Update	/CatalogFilter[]	Update the base information of a catalog filter, such as identifier.	Request Response	CatalogFilterFacadeClient.changeCatalogFilter(String[] action, CatalogFilterType catFilters[], String[] expression)
	Update	/CatalogFilter[]/Description[]	Add or update a description to a catalog filter for certain language.	Request Response	CatalogFilterFacadeClient.changeCatalogFilter(String[] action, CatalogFilterType catFilters[], String[] expression)
	Add	/CatalogFilter[]/ProductSetSelection[]	Add catalog entries for inclusion or exclusion into a catalog filter. The entries for inclusion(or exclusion) will be contained in a product set, which will created when adding the 1st entry.	Request Response	CatalogFilterFacadeClient.changeCatalogFilter(String[] action, CatalogFilterType catFilters[], String[] expression)
	Delete	/CatalogFilter[]/ProductSetSelection[]	Remove catalog entries from inclusion or exclusion relationship with a catalog filter.	Request Response	CatalogFilterFacadeClient.changeCatalogFilter(String[] action, CatalogFilterType catFilters[], String[] expression)
	Add	/CatalogFilter[]/CatalogGroupSelection[]	Add catalog groups into a catalog filter for inclusion or exclusion.	Request Response	CatalogFilterFacadeClient.changeCatalogFilter(String[] action, CatalogFilterType catFilters[], String[] expression)
	Update	/CatalogFilter[]/CatalogGroupSelection[]	Update the base information of the inclusions or exclusions of catalog groups in a catalog filter, for example, change inclusion to exclusion.	Request Response	CatalogFilterFacadeClient.changeCatalogFilter(String[] action, CatalogFilterType catFilters[], String[] expression)
	Delete	/CatalogFilter[]/CatalogGroupSelection[]	Remove catalog groups from inclusion or exclusion relationship with a catalog filter.	Request Response	CatalogFilterFacadeClient.changeCatalogFilter(String[] action, CatalogFilterType catFilters[], String[] expression)
	Add	/CatalogFilter[]/CatalogGroupSelection[]/ConditionGroup[]	Add condition groups under an included or excluded catalog groups in a catalog filter.	Request Response	CatalogFilterFacadeClient.changeCatalogFilter(String[] action, CatalogFilterType catFilters[], String[] expression)
	Update	/CatalogFilter[]/CatalogGroupSelection[]/ConditionGroup[]	Update the base information of condition groups in a catalog filter, for example, change the identifier.	Request Response	CatalogFilterFacadeClient.changeCatalogFilter(String[] action, CatalogFilterType catFilters[], String[] expression)
	Delete	/CatalogFilter[]/CatalogGroupSelection[]/ConditionGroup[]	Delete condition groups in a catalog filter.	Request Response	CatalogFilterFacadeClient.changeCatalogFilter(String[] action, CatalogFilterType catFilters[], String[] expression)
	Add	/CatalogFilter[]/CatalogGroupSelection[]/ConditionGroup[]/Condition[]	Add conditions to the condition groups in a catalog filter.	Request Response	CatalogFilterFacadeClient.changeCatalogFilter(String[] action, CatalogFilterType catFilters[], String[] expression)
	Update	/CatalogFilter[]/CatalogGroupSelection[]/ConditionGroup[]/Condition[]	Update the base information of a condition in a catalog filter, for example, the property or the operator.	Request Response	CatalogFilterFacadeClient.changeCatalogFilter(String[] action, CatalogFilterType catFilters[], String[] expression)
	Delete	/CatalogFilter[]/CatalogGroupSelection[]/ConditionGroup[]/Condition[]	Delete conditions in a catalog filter.	Request Response	CatalogFilterFacadeClient.changeCatalogFilter(String[] action, CatalogFilterType catFilters[], String[] expression)
	Add	/CatalogFilter[]/CatalogGroupSelection[]/ConditionGroup[]/Condition[]/ConditionAttributeValue[]	Add a value to a condition in a catalog filter.	Request Response	CatalogFilterFacadeClient.changeCatalogFilter(String[] action, CatalogFilterType catFilters[], String[] expression)
	Update	/CatalogFilter[]/CatalogGroupSelection[]/ConditionGroup[]/Condition[]/ConditionAttributeValue[]	Update the value of an existing condition value of a condition in a catalog filter.	Request Response	CatalogFilterFacadeClient.changeCatalogFilter(String[] action, CatalogFilterType catFilters[], String[] expression)
	Delete	/CatalogFilter[]/CatalogGroupSelection[]/ConditionGroup[]/Condition[]/ConditionAttributeValue[]	Delete value of conditions in a catalog filter.	Request Response	CatalogFilterFacadeClient.changeCatalogFilter(String[] action, CatalogFilterType catFilters[], String[] expression)
GetCatalogFilter	IBM_Admin_Summary IBM_CatalogFilter_details	/CatalogFilter	Find the catalog filters visible to current store.	Request Response	CatalogFilterFacadeClient.getCatalogFilter(String expressionLanguage, String expression)
	IBM_Admin_Summary IBM_CatalogFilter_details	/CatalogFilter[search()]	Search for catalog filters by identifier.	Request Response	CatalogFilterFacadeClient.getCatalogFilter(String expressionLanguage, String expression)
	IBM_Admin_Summary IBM_CatalogFilter_details	/CatalogFilter[CatalogFilterIdentifier[(UniqueID=)]]	Find catalog filter by unique ID.	Request Response	CatalogFilterFacadeClient.getCatalogFilter(String expressionLanguage, String expression)

Access Profile

Some sample XML request and response web service messages are provided for each noun. These sample messages might not include all properties or attributes. To view a sample message that includes other properties or attributes, enable logging and tracing for the appropriate component and then call the web service to set or change the properties or attributes. Review the corresponding log file to see the request or response information.

Access Profile	Data Returned
IBM_Admin_Summary	/CatalogFilter/CatalogFilterIdentifier/UniqueID /CatalogFilter/CatalogFilterIdentifier/ExternalIdentifier/Identifier /CatalogFilter/CatalogFilterIdentifier/ExternalIdentifier/StoreIdentifier/UniqueID /CatalogFilter/CatalogFilterIdentifier/ExternalIdentifier/CatalogIdentifier/UniqueID /CatalogFilter/Description
IBM_CatalogFilter_details	IBM_Admin_Summary information /CatalogFilter/CatalogGroupSelection/@conditionGroupRelation /CatalogFilter/CatalogGroupSelection/@selection /CatalogFilter/ProductSetSelection/@selection /CatalogFilter/ProductSetSelection/ProductSet/ProductSetIdentifier/UniqueID /CatalogFilter/ProductSetSelection/ProductSet/CatalogEntryIdentifier/UniqueID /CatalogFilter/CatalogGroupSelection/CatalogGroupSelectionIdentifier/UniqueID /CatalogFilter/CatalogGroupSelection/CatalogGroupSelectionIdentifier/ExternalIdentifier/CatalogFilterIdentifier/UniqueID /CatalogFilter/CatalogGroupSelection/CatalogGroupSelectionIdentifier/ExternalIdentifier/CatalogGroupIdentifier/UniqueID /CatalogFilter/CatalogGroupSelection/ConditionGroup/@conditionRelation /CatalogFilter/CatalogGroupSelection/ConditionGroup/ConditionGroupIdentifier/UniqueID /CatalogFilter/CatalogGroupSelection/ConditionGroup/ConditionGroupIdentifier/ExternalIdentifier/CatalogGroupSelectionIdentifier/UniqueID /CatalogFilter/CatalogGroupSelection/ConditionGroup/ConditionGroupIdentifier/ExternalIdentifier/Identifier /CatalogFilter/CatalogGroupSelection/ConditionGroup/Condition/@conditionType /CatalogFilter/CatalogGroupSelection/ConditionGroup/Condition/ConditionIdentifier/UniqueID /CatalogFilter/CatalogGroupSelection/ConditionGroup/Condition/ConditionIdentifier/ExternalIdentifier/CatalogFilterConditionGroupIdentifier/UniqueID /CatalogFilter/CatalogGroupSelection/ConditionGroup/Condition/ConditionOperator /CatalogFilter/CatalogGroupSelection/ConditionGroup/Condition/ConditionAttributeIdentifier/UniqueID /CatalogFilter/CatalogGroupSelection/ConditionGroup/Condition/ConditionAttributeIdentifier/ExternalIdentifier/Identifier /CatalogFilter/CatalogGroupSelection/ConditionGroup/Condition/ConditionAttributeValue/ConditionValueIdentifier/UniqueID /CatalogFilter/CatalogGroupSelection/ConditionGroup/Condition/ConditionAttributeValue/StringValue/Value /CatalogFilter/CatalogGroupSelection/ConditionGroup/Condition/ConditionAttributeValue/IntegerValue/Value /CatalogFilter/CatalogGroupSelection/ConditionGroup/Condition/ConditionAttributeValue/FloatValue/Value

XSD files

• CatalogFilter.xsd
• IdentifierTypes.xsd
• CommonTypes.xsd