Home
Reference
WebSphere Commerce API reference
WebSphere Commerce exposes two main programming APIs. The first and newest API is a REST interface, and most new classes are exposed here. The legacy Java API also contains new classes not suitable for REST, and can be browsed in Javadoc format.
WebSphere Commerce Storefront REST API
WebSphere Commerce REST API documentation contains a list of resources that are provided by the WebSphere Commerce REST API. Each REST resource contains information such as URLs, descriptions, and sample input and output data.
WebSphere Commerce Storefront REST API
WebSphere Commerce REST API documentation contains a list of resources that are provided by the WebSphere Commerce REST API. Each REST resource contains information such as URLs, descriptions, and sample input and output data.
Mapping of REST services to BOD services
The following sections detail how the REST resource method names relate to specific BOD services.

Reference
- WebSphere Commerce API reference
  WebSphere Commerce exposes two main programming APIs. The first and newest API is a REST interface, and most new classes are exposed here. The legacy Java API also contains new classes not suitable for REST, and can be browsed in Javadoc format.
  - WebSphere Commerce Storefront REST API
    WebSphere Commerce REST API documentation contains a list of resources that are provided by the WebSphere Commerce REST API. Each REST resource contains information such as URLs, descriptions, and sample input and output data.
    - WebSphere Commerce Storefront REST API
      WebSphere Commerce REST API documentation contains a list of resources that are provided by the WebSphere Commerce REST API. Each REST resource contains information such as URLs, descriptions, and sample input and output data.
      - Authentication, Authorization and Session Management
        These services provide classes related to authentication and session management in a B2B or B2C store. Use these classes to: Generate a preview token; Get the user context of a shopper (for example, PersonalizationId); Log on or log off a registered shopper using their username and password; Create or log off a guest user.
      - Cart
        These services provide classes related to the shopping cart in a B2B or B2C store. Use these classes to: Get, add, update, or delete payment instructions; Get, add, update, or delete items in the shopping cart; Get the billing address; Calculate order prices; Lock or unlock the cart; Checkout; Get or update shipping information.
      - Catalog
        These services provide classes related to browsing either a B2B or B2C store. Use these classes to: Get category data for administrative purposes; Get catalogs by search term or by store ID; Get catalog entries by parent part number or by search term.
      - Commerce Composer
        These services put the power to create new store pages and design page layouts in the hands of business users. By using a library of prebuilt layout templates and widgets, business users can quickly create and assemble pages directly in Management Center. Use these classes to find information about pages, widgets, and the page design.
      - Contract and Price
        These services provide APIs related to contracts and pricing in either a B2B or B2C store. Use these classes to: Get information about currency formatting; Get contract details; Get terms and conditions, entitled prices, range prices, and display prices for catalog entries; Switch contracts.
      - Coupons and Promotions
        These services provide classes related to promotional activities in either a B2B or B2C store. Use these classes to: Get, add, update, or delete assigned coupons; Get, add, update, or delete assigned promotion codes; Get associated promotions.
      - Location Based Services
        These services provide classes related to locational data, including the store locator feature. In a B2C store, shoppers use the store locator feature to locate a nearby store, where a list of nearby stores is given based on the the location entered by the shopper. In a B2B store, the store locator displays countries that stores are located in.
      - Marketing
        These services provide classes related to marketing in either a B2B or B2C store. Use these classes to: Get e-Marketing Spot data; Get customer segment data; Trigger marketing based on certain types of events.
      - Miscellaneous
        These services provide APIs related to features, aggregate features, and file upload jobs in a B2B or B2C store.
      - Order Capture
        These services provide classes related to orders in a B2B or B2C store. Use these classes to: Find information about order history and order details; Find inventory details for products; Get and manage a shopper's wishlists, or items in the wish list.
      - Search Services
        These services provide APIs related to searching either a B2B or B2C store. Use these classes to: Get top-level categories, child categories, category details by category ID, products, products by part number, products details by ID Provide brand, product, content and custom suggestions Search unstructured content by search term
      - Search Services (BOD-based)
        These services, located on the WebSphere Commerce server, provide APIs related to searching either a B2B or B2C store. Use these classes to: get category data for search-based catalog navigation get product data for search-based catalog navigation get product view details get information about search term associations (for example, landing pages) get resource details for site content such as the search results page
      - Store Configurations
        These services provide APIs related to the store configuration in a B2B or B2C store. Use these classes to:Get configuration details; Get flow information by flow ID; Get configuration details for system integrations; Get available resource URLs for a store; Get SEO-related information.
      - Subscription
        These services provide APIs related to subscriptions. Use these classes to: Submit a recurring or subscription order Cancel a recurring or subscription order; Get subscriptions by user and subscription type; Get subscription information by subscription ID.
      - User and Organization Management
        These services provide APIs related to user and organization management in a B2B or B2C store. Use these classes to: Get member groups; Get person details Add or update a member; Get order and buyer approval status records and approve or reject them; Register a person as a member; Update a member; Get or update organization information; Get or update a checkout profile; Switch organizations.
      - Workspace Support
        These services provide APIs related to workspaces in a B2B or B2C store. Use these classes to: get task group details; task details; to get workspace details.
      - Mapping of REST services to BOD services
        The following sections detail how the REST resource method names relate to specific BOD services.
      - Mapping of REST services to storefront checkout actions
        The Aurora starter store uses REST services throughout the checkout process. The actions for each page map to a REST service.
      - REST service annotations
        WebSphere Commerce REST services and Search REST services are annotated so you view and test the APIs with Swagger, an interactive REST service interface. The REST Discovery API generates a list of REST resources and APIs by parsing annotations on a resource handler. By documenting your custom REST resource handlers with the same annotation standards as WebSphere Commerce REST services, your custom REST services can be viewed and tested with Swagger.
  - API changes between WebSphere Commerce Version 7.0.0.9 and WebSphere Commerce Version 8.0.0.0
    If you are migrating version 7.0 of WebSphere Commerce, review the API changes between releases.
  - Java API classes
    You can browse the HCL Commerce Java APIs in Javadoc format.
- Cross-reference of data beans, EJB beans, and tables
  Data beans are grouped into several component groups.
- Cross-reference of commands, tasks, and tables
  URL commands, controller commands, task commands, view commands and tables are related to each other.
- Cross reference: Commands to beans to database tables
  Use this information when you are customizing a command and you want to know which tables are affected. You should also use this topic if you are modifying a table and want to know which commands and beans are affected.
- API changes between WebSphere Commerce Version 7.0.0.9 and WebSphere Commerce Version 8.0.0.0
  If you are migrating version 7.0 of WebSphere Commerce, review the API changes between releases.
- WebSphere Commerce database schema
  The WebSphere Commerce database model was designed for data integrity and optimal performance. WebSphere Commerce provides several hundred tables that store WebSphere Commerce instance data. To maintain data integrity, and to ease maintenance referential integrity, constraints are widely used in the database model. Indexes are used carefully on tables to avoid over-indexing and to provide a good balance between data retrieval and data manipulation activities (insert and update). The business rules are implemented at the application level rather than by using database trigger. Triggers, however, are used to facilitate data staging and optimistic locking. A limited number of SQL-based database stored procedures are used for data intensive activities.
- Payments subsystem
  In WebSphere Commerce, payment processing uses the Payments subsystem.
- Dynamic caching
  In general, caching improves response time and reduces system load. Caching techniques are used to improve the performance of World Wide Web Internet applications. Most techniques cache static content (content that rarely changes) such as graphic and text files. However, many websites serve dynamic content, containing personalized information or data that changes more frequently. Caching dynamic content requires more sophisticated caching techniques, such as those provided by the WebSphere Application Server dynamic cache, a built-in service for caching and serving dynamic content.
- Data Load utility configuration file schema
  The Data Load utility contains several configuration files. You can use the configuration file schema to understand and customize the data load configuration files.
- WebSphere Commerce web services
  WebSphere Commerce provides many web services.
- Utilities
  Utilities help you to accomplish administrative or configuration tasks, for example, loading data, publishing a store.
- Shopping flow URLs
  WebSphere Commerce shopping flow URLs are organized by subsystem.
- Ant targets
  A WebSphere Commerce instance can be created from the command line. The command-line utility uses Apache Ant to create the objects required. The targets are divided into several high-level groups that correspond to the environment that is to be configured.
- Glossary

Mapping of REST services to BOD services

The following sections detail how the REST resource method names relate to specific BOD services.

AssignedCouponHandler

REST API: assigned_coupon
BOD noun: Order


Resource Method Name	BOD Service Mapping
getAssignedCouponInfo	BOD: GetOrderAccess Profile: IBM_DetailsAction Expression: {ibmord.isCurrentShoppingCart='true'}/Order/OrderItem
applyCoupon	BOD: ProcessOrderAction Code: ApplyCouponAction Expression: /Order BOD:ProcessOrderAction Code: CalculateInternallyAction Expression: /Order
removeCoupon	BOD: ProcessOrderAction Code: RemoveCouponAction Expression: /Order BOD: ProcessOrderAction Code: CalculateInternallyAction Expression: /Order

AssignedPromotionCodeHandler

REST API: assigned_promotion_code
BOD noun: Order


Resource Method Name	BOD Service Mapping
getAssignedPromotioncodeInfo	BOD: GetOrderAccess Profile: IBM_DetailsAction Expression: {ibmord.isCurrentShoppingCart='true'}/Order/OrderItem
applyPromotioncode	BOD: ProcessOrderAction Code: ApplyPromotionCodeAction Expression: /Order BOD: ProcessOrderAction Code: CalculateInternallyAction Expression: /Order
removePromotionCode	BOD: ProcessOrderAction Code: RemovePromotionCodeAction Expression: /Order BOD: ProcessOrderAction Code: CalculateInternallyAction Expression: /Order

AssociatedPromotionHandler

REST API: associated_promotion
Data bean: CalculationCodeListDataBean


Resource Method Name	BOD Service Mapping
findPromotionList	Not applicable. Calls the CalculationCodeListDataBean data bean.

CartHandler

REST API: cart
BOD noun: Order


Resource Method Name	BOD Service Mapping
getCart	BOD: GetOrderAccess Profile: IBM_DetailsAction Expression: {ibmord.isCurrentShoppingCart='true'}/Order/OrderItem
getUsableShippingInfo	BOD: GetOrderAccess Profile: IBM_DetailsAction Expression: {ibmord.isCurrentShoppingCart='true'}/Order/OrderItem BOD: GetOrderAccess Profile: IBM_UsableShippingInfo /Order[OrderIdentifier[(UniqueID='$OrderID$')]]
getUsablePaymentInfo	BOD: GetOrderAccess Profile: IBM_DetailsAction Expression: {ibmord.isCurrentShoppingCart='true'}/Order/OrderItem BOD: GetOrderAccess Profile: IBM_UsablePaymentInfoAction Expression: /Order[OrderIdentifier[(UniqueID='$OrderID$')]]
applyCheckoutProfile	BOD: GetOrderAccess Profile: IBM_SummaryAction Expression: /Order[OrderStatus[(Status='Q')]] BOD: GetOrderAccess Profile: IBM_DetailsAction Expression: {ibmord.isCurrentShoppingCart='true'}/Order/OrderItem BOD: ProcessOrderAction Code: CheckoutAction Expression: {_ord.usingProfile='true'}/Order
addOrderItem	BOD: ChangeOrder Action Code: CreateAction Expression: /Order/OrderItem
udpateOrderItem	BOD: ChangeOrder Action Code: UpdateAction Expression: /Order/OrderItem
cancelOrderInCart	BOD: ProcessOrder Action Code: CancelAction Expression: /Order
preCheckout	BOD: ProcessOrder Action Code: PrepareAction Expression: /Order
checkOut	BOD: ProcessOrder Action Code: SubmitAction Expression: /Order
lockCart	BOD: ProcessOrder Action Code: LockAction Expression: /Order
unlockCart	BOD: ProcessOrder Action Code: UnlockAction Expression: /Order
getAllowableShippingModes	Not applicable. Calls an AccessBean to get the allowable shipping modes.

CategoryViewHandler

REST API: category
BOD noun: CatalogNavigationView


Resource Method Name	BOD Service Mapping
findCategoryByUniqueId	BOD: GetCatalogNavigationViewAccess Profile: IBM_Store_Details, IBM_findCatalogGroupDetailsAction Expression: /CatalogNavigationView[CatalogGroupView[(UniqueID=$uniqueId$)]]
findCategoryByIdentifier	BOD: GetCatalogNavigationViewAccess Profile: IBM_Store_Details, IBM_findCatalogGroupDetailsAction Expression: /CatalogNavigationView[CatalogGroupView[(Identifier=$identifier$)]]
findTopCategories	BOD: GetCatalogNavigationViewAccess Profile: IBM_Store_Summary, IBM_findCatalogGroupSummaryAction Expression: /CatalogNavigationView/CatalogGroupView
findSubCategories	BOD: GetCatalogNavigationViewAccess Profile: IBM_Store_Summary, IBM_findCatalogGroupSummaryAction Expression: /CatalogNavigationView[CatalogGroupView[(ParentCatalogGroupID=$parentCatalogGroupId$)]]

CategoryViewHandler (Search)

REST API: search_category
Search profiles: WebSphere Commerce Search profiles


Resource Method Name	Search Server Mapping (default search profile)
findCategoryByUniqueId	IBM_findCategoryByUniqueIds
findCategoryByUniqueIds	IBM_findCategoryByUniqueIds
findCategoryByIdentifier	IBM_findCategoryByIdentifier
findTopCategories	IBM_findSubCategories
findSubCategories	IBM_findSubCategories

CouponHandler

REST API: coupon
BOD noun: WalletItem


Resource Method Name	BOD Service Mapping
getCoupon	BOD: GetWalletItemAccess Profile: IBM_Store_DetailsAction Expression: /WalletItem[Data[Status='0'] and Type='Coupon' and WalletItemIdentifier/ExternalIdentifier/WalletIdentifier[UniqueID='$uniqueId$']]
deleteCouponById	BOD: ProcessWalletItemAction Code: DeleteAction Expression:/WalletItem

ESpotDataHandler

REST API: espot
BOD noun: MarketingSpotData


Resource Method Name	BOD Service Mapping
findByName	BOD: GetMarketingSpotDataAccess Profile: IBM_Store_AllAction Expression: {_wcf.ap=$accessProfile$
findByNameWithCategory	BOD: GetMarketingSpotDataAccess Profile: IBM_Store_AllAction Expression: {_wcf.ap=$accessProfile$
findByNameWithProduct	BOD: GetMarketingSpotDataAccess Profile: IBM_Store_AllAction Expression: {_wcf.ap=$accessProfile$

EventHandler

REST API: event
BOD noun: MarketingTrigger


Resource Method Name	BOD Service Mapping
triggerMarketing	BOD: ProcessMarketingTriggerAction Code: EvaluateAction Expression: {_mkt.triggerParameters='DM_ReqCmd=$commandName$&nvp1=value1&nvp1=value2_mkt.endTriggerParameters'}/MarketingTrigger

GeoNodeHandler

REST API: geonode
BOD noun: GeoNode


Resource Method Name	BOD Service Mapping
findTopGeoNodes (site level search)	BOD: GetGeoNodeAccess Profile: IBM_Store_AllAction Expression: /GeoNode[@topGeoNode='true']
findTopGeoNodes (store level search)	BOD: GetGeoNode Access Profile: IBM_Store_AllAction Expression: /GeoNode[@topGeoNode='true' and StoreIdentifier[UniqueID=$storeId$]]
findGeoByParentGeoId	BOD: GetGeoNode Access Profile: IBM_Store_AllAction Expression: /GeoNode[ParentGeoNodeIdentifier[UniqueID=$parentUniqueId$]]

GuestIdentityHandler

REST API: guest_identity
BOD noun: Person


Resource Method Name	BOD Service Mapping
login	BOD: ProcessPersonAction Code: CreateGuest Command Interface: `com.ibm.commerce.member.server.commands.LoginServiceCmd`
logout	BOD: ProcessPersonAction Code: Logout

InventoryHandler

REST API: inventoryavailability
BOD noun: InventoryAvailability


Resource Method Name	BOD Service Mapping
getInventoryAvailabilityByProductId	BOD: GetInventoryAvailabilityAccess Profile: IBM_Store_DetailsAction expression: 1. /InventoryAvailability[InventoryAvailabilityIdentifier/ExternalIdentifier[CatalogEntryIdentifier[(UniqueID=$uniqueId$)] and OnlineStoreIdentifier[(UniqueID=$uniqueId$)]]]

LoginIdentityHandler

REST API: login_identity
BOD noun: Person


Resource Method Name	BOD Service Mapping
login	BOD: ProcessPersonAction Code: AuthenticatePassword
logout	BOD: ProcessPersonAction Code: Logout

LTPAIdentityHandler

REST API: ltpa_identity
BOD noun: Person


Resource Method Name	BOD Service Mapping
authenticate	BOD: ProcessPersonAction Code: AuthenticateLTPA
logout	BOD: ProcessPersonAction Code: Logout

OrderHandler

REST API: order
BOD noun: Order


Resource Method Name	BOD Service Mapping
findOrderHistory	BOD: GetOrderAccess Profile: IBM_SummaryAction Expression: /Order[OrderStatus[(status='$OrderStatus$')]]
findByOrderId	BOD: GetOrderAccess Profile: IBM_DetailsAction Expression: /Order[OrderIdentifier[(UniqueID='$orderID$')]]
findByStatus	BOD: GetOrderAccess Profile: IBM_SummaryAction Expression: /Order[OrderStatus[(status='$OrderStatus$')]]

PaymentInstructionHandler

REST API: payment_instruction
BOD noun: Order


Resource Method Name	BOD Service Mapping
getPaymentInfo	BOD: GetOrderAccess Profile: IBM_DetailsAction Expression: {ibmord.isCurrentShoppingCart='true'}/Order/OrderItem
addPaymentInstruction	BOD: ChangeOrderAction Code: CreateActionExpression: /Order/OrderPaymentInfo/PaymentInstruction
updatePaymentInstruction	BOD: ChangeOrderAction Code: UpdateActionExpression: /Order/OrderPaymentInfo/PaymentInstruction
deletePaymentInstruction	BOD: ChangeOrderAction Code: DeleteActionExpression: /Order/OrderPaymentInfo/PaymentInstruction
deleteAllPaymentInstructions	BOD: ChangeOrderAction Code: DeleteActionExpression: /Order/OrderPaymentInfo/PaymentInstruction

PersonHandler

REST API: person
BOD noun: Person


Resource Method Name	BOD Service Mapping
findPersonBySelf	BOD: GetPersonAccess Profile: IBM_AllActionExpression: {self=true}/Person
registerPerson	BOD: ProcessPersonAction Code: RegisterActionExpression: /Person BOD: ProcessPersonAction Code: AuthenticatePassword
updatePerson	BOD: ChangePersonAction Code: UpdateActionExpression: /Person
deleteContextAttributeForPerson	BOD: ChangePersonAction Code: DeleteActionExpression: /Person/ContextAttribute

PersonCheckoutProfileHandler

REST API: checkout_profile
BOD noun: Person


Resource Method Name	BOD Service Mapping
getCheckoutProfile	BOD: GetPersonAccess Profile: IBM_CheckoutProfileAction Expression: {self=true}/Person
updateCheckoutProfile	BOD: ChangePersonAction Code: UpdateAction Expression: /Person/CheckoutProfile

PersonContactHandler

REST API: person_contact
BOD noun: Person


Resource Method Name	BOD Service Mapping
getAllPersonContact	BOD: GetPersonAccess Profile: IBM_ALLAction Expression: {self=true}/Person
findPersonContactById	BOD: GetPersonAccess Profile: IBM_ALLAction Expression: {self=true}/Person
findPersonContactByNickName	BOD: GetPersonAccess Profile: IBM_ALLAction Expression: {self=true}/Person
addPersonContact	BOD: ChangePersonAction Code: CreateAction Expression: /Person/AddressBook/Contact
updatePersonContact	BOD: ChangePersonAction Code: UpdateAction Expression: /Person/AddressBook/Contact
deletePersonContact	BOD: ChangePersonAction Code: DeleteAction Expression: /Person/AddressBook/Contact

PreviewTokenHandler

REST API: previewToken
BOD noun: Person


Resource Method Name	BOD Service Mapping
genPreviewToken	BOD: ProcessPersonAction Code:CreatePreviewTokenAction Expression: /Person

PriceHandler

REST API: price
BOD noun: EntitledPrice


Resource Method Name	BOD Service Mapping
findPricesByQuery	BOD: GetEntitledPriceAccess Profile: IBM_Store_EntitledPrice_All, IBM_Store_EntitledPrice_RangePrice_AllAction Expression: /EntitledPrice

ProductViewHandler

REST API: product
BOD noun: CatalogNavigationView


Resource Method Name	BOD Service Mapping
findProductsBySearchTerm	BOD: GetCatalogNavigationViewAccess Profile: IBM_Store_CatalogEntrySearch, IBM_findCatalogEntryByNameAndShortDescriptionAction Expression: /CatalogNavigationView
findProductById	BOD: GetCatalogNavigationViewAccess Profile: IBM_Store_CatalogEntrySearch, IBM_findCatalogEntryAllAction Expression: /CatalogNavigationView[CatalogEntryView[(UniqueID=$uniqueId$)]]
findProductsByIds	BOD: GetCatalogNavigationViewAccess Profile: IBM_Store_CatalogEntrySearch, IBM_findCatalogEntryAllAction Expression: /CatalogNavigationView[CatalogEntryView[(UniqueID=$uniqueId1$ or UniqueID=$uniqueId2$)]]
findProductByPartNumber	BOD: GetCatalogNavigationViewAccess Profile: IBM_Store_CatalogEntrySearch, IBM_findCatalogEntryAllAction Expression: /CatalogNavigationView[CatalogEntryView[(PartNumber=$partNumber$)]]
findProductsByCategory	BOD: GetCatalogNavigationViewAccess Profile: IBM_Store_Details, IBM_findCatalogEntryByNameAndShortDescriptionAction Expression: /CatalogNavigationView[CatalogEntryView[ParentCatalogGroupID=$parentCatalogGroupId$ and (catalogEntryTypeCode='ProductBean' or catalogEntryTypeCode='BundleBean' or catalogEntryTypeCode='PackageBean')]]

ProductViewHandler (Search)

REST API: search_product
Search profiles: WebSphere Commerce Search profiles


Resource Method Name	Search Server Mapping (default search profile)
findProductsBySearchTerm	IBM_findProductsBySearchTerm
findProductById	IBM_findProductByIds_Details
findProductsByIds	IBM_findProductByIds_Details
findProductByPartNumber	IBM_findProductByPartNumber_Details
findProductsByCategory	IBM_findProductsByCategory

PromotionHandler

REST API: promotion
BOD noun: Promotion


Resource Method Name	BOD Service Mapping
getPromotionsByQuery	BOD: GetPromotionAccess Profile: IBM_Admin_DetailsAction Expression: /Promotion
getPromotionsByQuery?q=byName	BOD: GetPromotionAccess Profile: IBM_Admin_DetailsAction Expression: /Promotion[search(contains(AdministrativeName, $qName$))]
getPromotionByID	BOD: GetPromotionAccess Profile: IBM_Admin_DetailsAction Expression: /Promotion[PromotionIdentifier[(UniqueID='$promotionId$')]]

SegmentHandler

REST API: segment
BOD noun: MemberGroup


Resource Method Name	BOD Service Mapping
checkIsInSegmentByUserId	BOD: GetMemberGroupAccess Profile: IBM_Admin_DetailsAction Expression: /MemberGroup[MemberGroupIdentifier[UniqueID='$memberGroupID$'] and IncludedPerson[UniqueID='$personID$']]
getCustomerSegment	BOD: GetMemberGroupAccess Profile: IBM_Admin_DetailsAction Expression:ByName: /MemberGroup[search(contains(MemberGroupIdentifier[ExternalIdentifier[Name="$name$" and Usage="GeneralPurpose"]]ByUserId: /MemberGroup[IncludedPerson[UniqueID="$UserID$"] and Usage="-1"]ByPersonalizationId: /MemberGroup[IncludedPerson[UniqueID="$personID$"] and Usage="-1"]ByStore: /MemberGroup[Usage='GeneralPurpose']
getCustomerSegmentById	BOD: GetMemberGroupAccess Profile: IBM_Admin_DetailsAction Expression: /MemberGroup[MemberGroupIdentifier[(UniqueID='$memberGroupID$')]]

ShippingInfoHandler

REST API: shipping_info
BOD noun: Order


Resource Method Name	BOD Service Mapping
getShippingInfo	BOD: GetOrderAccess Profile: IBM_DetailsAction Expression:{ibmord.isCurrentShoppingCart='true'}/Order/OrderItem
updateOrderShippingInfo	BOD: ChangeOrderAction Code: UpdateAction Expression: /Order/OrderItem/OrderItemShippingInfo

SiteContentHandler (Search)

REST API: search_site_content
Search profiles: WebSphere Commerce Search profiles


Resource Method Name	Search Server Mapping (default search profile)
findWebContentsBySearchTerm	IBM_findWebContentsBySearchTerm
findKeywordSuggestionsByTerm	Not applicable.
findAllCategorySuggestions	IBM_findNavigationSuggestion_Categories
findAllBrandSuggestions	IBM_findNavigationSuggestion_Brands
findAllWebContentSuggestions	Not applicable.

SpotHandler

REST API: spot
BOD noun: MarketingSpot


Resource Method Name	BOD Service Mapping
findSpotsByQuery?q=byType	BOD: GetMarketingSpotAccess Profile: IBM_Admin_DetailsAction Expression: /MarketingSpot[Usage='$qType$']
findSpotsByQuery?q=byTypeAndName	BOD: GetMarketingSpotAccess Profile: IBM_Admin_DetailsAction Expression: /MarketingSpot[Usage='$qType$' and search(contains(MarketingSpotIdentifier/ExternalIdentifier/Name, '$qName$') or contains(Description, '$qName$'))]
findSpotByID	BOD: GetMarketingSpotAccess Profile: IBM_Admin_DetailsAction Expression: /MarketingSpot[MarketingSpotIdentifier[(UniqueID='$spotId$')]]

StoreLocatorHandler

REST API: storelocator
BOD nouns: GeoNode, PhysicalStore


Resource Method Name	BOD Service Mapping
findGeoNodeByGeoLocation (site level search)	BOD: GetGeoNodeAccess Profile: IBM_Store_AllAction Expression: /GeoNode[@type=$type$ and search(contains(Description/Name,$Name$))] BOD: GetPhysicalStoreAccess Profile: IBM_Store_DetailsAction Expression: /PhysicalStore[LocationInfo[GeoNodeIdentifier[UniqueID=$uniqueId$]]]
findGeoNodeByGeoLocation (store level search)	BOD: GetGeoNodeAccess Profile: IBM_Store_AllAction Expression: /GeoNode[@type=$type$ and StoreIdentifier[UniqueID=$storeId$] and search(contains(Description/Name,$Name$))] BOD: GetPhysicalStoreAccess Profile: IBM_Store_DetailsAction Expression: /PhysicalStore[LocationInfo[GeoNodeIdentifier[UniqueID=$uniqueId$]]]
findGeoNodeByGeoId	BOD: GetPhysicalStoreAccess Profile: IBM_Store_DetailsAction Expression: /PhysicalStore[LocationInfo[GeoNodeIdentifier[UniqueID=$uniqueId$]]]
findByStoreUniqueId	BOD: GetPhysicalStoreAccess Profile: IBM_Store_DetailsAction Expression: /PhysicalStore[PhysicalStoreIdentifier[(UniqueID=$uniqueId$)]]
findStores	BOD: GetPhysicalStoreAccess Profile: IBM_Store_DetailsAction Expression: {_sto.radiusValue=$value$;_sto.radiusUom=$uom$;_sto.maxStores=$maxStores$}/PhysicalStore[LocationInfo[GeoCode[Latitude=$latitude$ and Longitude=$longitude$]] and StoreIdentifier[UniqueID=$storeId$]]

WishlistHandler

REST API: wishlist
BOD nouns: Person, GiftList


Resource Method Name	BOD Service Mapping
findWishlist	BOD: GetPerson Access Profile: IBM_AllAction Expression: {self=true}/Person BOD: GetGiftListAccess Profile: IBM_Store_GiftListSummaryAndItemsAction Expression: /GiftList[Registrant[PersonIdentifier[UniqueID=]] and Registry=]
findWishlistByUserId_default	BOD: GetPersonAccess Profile: IBM_AllAction Expression: {self=true}/Person BOD: GetGiftListAccess Profile: IBM_Store_GiftListSummaryAndItemsAction Expression: /GiftList[Registrant[PersonIdentifier[UniqueID=]] and Registry= and (State=)]
findWishlistByExternalId	BOD: GetGiftListAccess Profile: IBM_Store_GiftListSummaryAndItemsAction Expression: GiftList[GiftListIdentifier[GiftListExternalIdentifier[(ExternalIdentifier=)]]] BOD: GetGiftListAccess Profile: IBM_Store_GiftListSummaryAndItemsAction Expression: /GiftList[AccessSpecifier[GuestAccessKey= or RegistryAccessKey=] and GiftListIdentifier[GiftListExternalIdentifier[ExternalIdentifier=]]]
createWishlist	BOD: ProcessGiftListAction Code: CreateAction Expression: /GiftList[1]
updateWishlist (when addItem=true)	BOD: ChangeGiftListAction Code: AddAction Expression: /GiftList[] /GiftList[]/Item[]
updateWishlist	BOD: ChangeGiftListAction Code: ChangeAction Expression: /GiftList[] /GiftList[]/Item[] /GiftList[]/Description
deleteWishlist	BOD: ProcessGiftListAction Code: DeleteAction Expression: /GiftList[1]