Mappage des services REST aux services BOD
Les sections suivantes détaillent comment les noms des méthodes de ressource REST se rapportent à des services BOD spécifiques.
AssignedCouponHandler
- API REST : assigned_coupon
- Nom BOD : Commande
| Nom de la méthode de ressource | Mappage des services BOD |
|---|---|
| getAssignedCouponInfo | BOD GetOrderProfil d'accès : IBM_DetailsExpression d'action : {ibmord.isCurrentShoppingCart='true'}/Order/OrderItem |
| applyCoupon | BOD ProcessOrderCode d'action : ApplyCouponExpression d'action : /Order BOD:ProcessOrderCode d'action : CalculateInternallyExpression d'action : /Order |
| removeCoupon | BOD ProcessOrderCode d'action : RemoveCouponExpression d'action : /Order BOD ProcessOrderCode d'action : CalculateInternallyExpression d'action : /Order |
AssignedPromotionCodeHandler
- API REST : assigned_promotion_code
- Nom BOD : Commande
| Nom de la méthode de ressource | Mappage des services BOD |
|---|---|
| getAssignedPromotioncodeInfo | BOD GetOrderProfil d'accès : IBM_DetailsExpression d'action : {ibmord.isCurrentShoppingCart='true'}/Order/OrderItem |
| applyPromotioncode | BOD ProcessOrderCode d'action : ApplyPromotionCodeExpression d'action : /Order BOD ProcessOrderCode d'action : CalculateInternallyExpression d'action : /Order |
| removePromotionCode | BOD ProcessOrderCode d'action : RemovePromotionCodeExpression d'action : /Order BOD ProcessOrderCode d'action : CalculateInternallyExpression d'action : /Order |
AssociatedPromotionHandler
- API REST : associated_promotion
- Bean de données : CalculationCodeListDataBean
| Nom de la méthode de ressource | Mappage des services BOD |
|---|---|
| findPromotionList | Non applicable. Appelle le bean de données CalculationCodeListDataBean. |
CartHandler
| Nom de la méthode de ressource | Mappage des services BOD |
|---|---|
| getCart | BOD GetOrderProfil d'accès : IBM_DetailsExpression d'action : {ibmord.isCurrentShoppingCart='true'}/Order/OrderItem |
| getUsableShippingInfo | BOD GetOrderProfil d'accès : IBM_DetailsExpression d'action : {ibmord.isCurrentShoppingCart='true'}/Order/OrderItem BOD GetOrderProfil d'accès : IBM_UsableShippingInfo /Order[OrderIdentifier[(UniqueID='$OrderID$')]] |
| getUsablePaymentInfo | BOD GetOrderProfil d'accès : IBM_DetailsExpression d'action : {ibmord.isCurrentShoppingCart='true'}/Order/OrderItem BOD GetOrderProfil d'accès : IBM_UsablePaymentInfoExpression d'action : /Order[OrderIdentifier[(UniqueID='$OrderID$')]] |
| applyCheckoutProfile | BOD GetOrderProfil d'accès : IBM_SummaryExpression d'action : /Order[OrderStatus[(Status='Q')]] BOD GetOrderProfil d'accès : IBM_DetailsExpression d'action : {ibmord.isCurrentShoppingCart='true'}/Order/OrderItem BOD ProcessOrderCode d'action : PaiementExpression d'action : {_ord.usingProfile='true'}/Order |
| addOrderItem | BOD ChangeOrderCode d'action : CreateExpression d'action : /Order/OrderItem |
| udpateOrderItem | BOD ChangeOrderCode d'action : UpdateExpression d'action : /Order/OrderItem |
| cancelOrderInCart | BOD ProcessOrderCode d'action : CancelExpression d'action : /Order |
| preCheckout | BOD ProcessOrder Code d'action : PrepareExpression d'action : /Order |
| checkOut | BOD ProcessOrder Code d'action : SubmitExpression d'action : /Order |
| lockCart | BOD ProcessOrder Code d'action : LockExpression d'action : /Order |
| unlockCart | BOD ProcessOrder Code d'action : UnlockExpression d'action : /Order |
| getAllowableShippingModes | Non applicable Appelle un AccessBean pour obtenir les modes d'expédition autorisés. |
CategoryViewHandler
- API REST : category
- Nom BOD : CatalogNavigationView
| Nom de la méthode de ressource | Mappage des services BOD |
|---|---|
| findCategoryByUniqueId | BOD GetCatalogNavigationViewProfil d'accès : IBM_Store_Details, IBM_findCatalogGroupDetailsAction Expression : /CatalogNavigationView[CatalogGroupView[(UniqueID=$uniqueId$)]] |
| findCategoryByIdentifier | BOD GetCatalogNavigationViewProfil d'accès : IBM_Store_Details, IBM_findCatalogGroupDetailsAction Expression : /CatalogNavigationView[CatalogGroupView[(Identifier=$identifier$)]] |
| findTopCategories | BOD GetCatalogNavigationViewProfil d'accès : IBM_Store_Summary, IBM_findCatalogGroupSummaryAction Expression : /CatalogNavigationView/CatalogGroupView |
| findSubCategories | BOD GetCatalogNavigationViewProfil d'accès : IBM_Store_Summary, IBM_findCatalogGroupSummaryAction Expression : /CatalogNavigationView[CatalogGroupView[(ParentCatalogGroupID=$parentCatalogGroupId$)]] |
CategoryViewHandler (recherche)
- API REST : search_category
- Effectuer une recherche dans les profils : HCL Commerce Search profiles
| Nom de la méthode de ressource | Mappage de serveur de recherche (profil de recherche par défaut) |
|---|---|
| findCategoryByUniqueId | IBM_findCategoryByUniqueIds |
| findCategoryByUniqueIds | IBM_findCategoryByUniqueIds |
| findCategoryByIdentifier | IBM_findCategoryByIdentifier |
| findTopCategories | IBM_findSubCategories |
| findSubCategories | IBM_findSubCategories |
CouponHandler
- API REST : bon de réduction
- Nom BOD : WalletItem
| Nom de la méthode de ressource | Mappage des services BOD |
|---|---|
| getCoupon | BOD GetWalletItemProfil d'accès : IBM_Store_DetailsExpression d'action : /WalletItem[Data[Status='0'] et Type='Coupon' et WalletItemIdentifier/ExternalIdentifier/WalletIdentifier[UniqueID='$uniqueId$']] |
| deleteCouponById | BOD ProcessWalletItemCode d'action : DeleteExpression d'action :/WalletItem |
ESpotDataHandler
- API REST : espot
- Nom BOD : MarketingSpotData
| Nom de la méthode de ressource | Mappage des services BOD |
|---|---|
| findByName | BOD GetMarketingSpotDataProfil d'accès : IBM_Store_AllExpression d'action : {_wcf.ap=$accessProfile$ |
| findByNameWithCategory | BOD GetMarketingSpotDataProfil d'accès : IBM_Store_All Expression Expression d'action : {_wcf.ap=$accessProfile$ |
| findByNameWithProduct | BOD GetMarketingSpotDataProfil d'accès : IBM_Store_All Expression Expression d'action : {_wcf.ap=$accessProfile$ |
EventHandler
- API REST : événement
- Nom BOD : MarketingTrigger
| Nom de la méthode de ressource | Mappage des services BOD |
|---|---|
| triggerMarketing | BOD ProcessMarketingTriggerCode d'action : EvaluateExpression d'action : {_mkt.triggerParameters='DM_ReqCmd=$commandName$&nvp1=value1&nvp1=value2_mkt.endTriggerParameters'}/MarketingTrigger |
GeoNodeHandler
| Nom de la méthode de ressource | Mappage des services BOD |
|---|---|
| findTopGeoNodes (recherche de niveau site) | BOD GetGeoNodeProfil d'accès : IBM_Store_All Expression Expression d'action : /GeoNode[@topGeoNode='true'] |
| findTopGeoNodes (recherche de niveau magasin) | BOD GetGeoNode Profil d'accès : IBM_Store_All Expression Expression d'action : /GeoNode[@topGeoNode='true' et StoreIdentifier[UniqueID=$storeId$]] |
| findGeoByParentGeoId | BOD GetGeoNode Profil d'accès : IBM_Store_All Expression Expression d'action : /GeoNode[ParentGeoNodeIdentifier[UniqueID=$parentUniqueId$]] |
GuestIdentityHandler
- API REST :
guest_identity - Nom BOD : Person
| Nom de la méthode de ressource | Mappage des services BOD |
|---|---|
| connexion | BOD Code d'action ProcessPerson : CreateGuest Interface de commande : |
| déconnexion | BOD Code d'action ProcessPerson : Déconnexion |
InventoryHandler
- API REST :
inventoryavailability - Nom BOD : InventoryAvailability
| Nom de la méthode de ressource | Mappage des services BOD |
|---|---|
| getInventoryAvailabilityByProductId | BOD GetInventoryAvailabilityProfil d'accès : IBM_Store_DetailsExpression d'action : 1. /InventoryAvailability[InventoryAvailabilityIdentifier/ExternalIdentifier[CatalogEntryIdentifier[(UniqueID=$uniqueId$)] et OnlineStoreIdentifier[(UniqueID=$uniqueId$)]]] |
LoginIdentityHandler
- API REST :
login_identity - Nom BOD : Person
| Nom de la méthode de ressource | Mappage des services BOD |
|---|---|
| connexion | BOD Code d'action ProcessPerson : AuthenticatePassword |
| logout | BOD Code d'action ProcessPerson : Déconnexion |
LTPAIdentityHandler
- API REST :
ltpa_identity - Nom BOD : Person
| Nom de la méthode de ressource | Mappage des services BOD |
|---|---|
| authenticate | BOD Code d'action ProcessPerson : AuthenticateLTPA |
| déconnexion | BOD Code d'action ProcessPerson : Déconnexion |
OrderHandler
| Nom de la méthode de ressource | Mappage des services BOD |
|---|---|
| findOrderHistory | BOD GetOrderProfil d'accès : IBM_SummaryExpression d'action : /Order[OrderStatus[(status='$OrderStatus$')]] |
| findByOrderId | BOD GetOrderProfil d'accès : IBM_DetailsExpression d'action : /Order[OrderIdentifier[(UniqueID='$orderID$')]] |
| findByStatus | BOD GetOrderProfil d'accès : IBM_SummaryExpression d'action : /Order[OrderStatus[(status='$OrderStatus$')]] |
PaymentInstructionHandler
- API REST : payment_instruction
- Nom BOD : Commande
| Nom de la méthode de ressource | Mappage des services BOD |
|---|---|
| getPaymentInfo | BOD GetOrderProfil d'accès : IBM_DetailsExpression d'action : {ibmord.isCurrentShoppingCart='true'}/Order/OrderItem |
| addPaymentInstruction | BOD ChangeOrderCode d'action : CreateExpression d'action : /Order/OrderPaymentInfo/PaymentInstruction |
| updatePaymentInstruction | BOD ChangeOrderCode d'action : UpdateExpression d'action : /Order/OrderPaymentInfo/PaymentInstruction |
| deletePaymentInstruction | BOD ChangeOrderCode d'action : DeleteExpression d'action : /Order/OrderPaymentInfo/PaymentInstruction |
| deleteAllPaymentInstructions | BOD ChangeOrderCode d'action : DeleteExpression d'action : /Order/OrderPaymentInfo/PaymentInstruction |
PersonHandler
| Nom de la méthode de ressource | Mappage des services BOD |
|---|---|
| findPersonBySelf | BOD GetPersonProfil d'accès : IBM_AllExpression d'action : {self=true}/Person |
| registerPerson | BOD Code d'action ProcessPerson : RegisterExpression d'action : /Person BOD Code d'action ProcessPerson : AuthenticatePassword |
| updatePerson | BOD ChangePersonCode d'action : UpdateExpression d'action : /Person |
| deleteContextAttributeForPerson | BOD ChangePersonCode d'action : DeleteExpression d'action : /Person/ContextAttribute |
PersonCheckoutProfileHandler
- API REST :
checkout_profile - Nom BOD : Person
| Nom de la méthode de ressource | Mappage des services BOD |
|---|---|
| getCheckoutProfile | BOD GetPersonProfil d'accès : IBM_CheckoutProfileExpression d'action : {self=true}/Person |
| updateCheckoutProfile | BOD ChangePersonCode d'action : UpdateExpression d'action : /Person/CheckoutProfile |
PersonContactHandler
- API REST :
person_contact - Nom BOD : Person
| Nom de la méthode de ressource | Mappage des services BOD |
|---|---|
| getAllPersonContact | BOD GetPersonProfil d'accès : IBM_ALLExpression d'action : {self=true}/Person |
| findPersonContactById | BOD GetPersonProfil d'accès : IBM_ALLExpression d'action : {self=true}/Person |
| findPersonContactByNickName | BOD GetPersonProfil d'accès : IBM_ALLExpression d'action : {self=true}/Person |
| addPersonContact | BOD ChangePersonCode d'action : CreateExpression d'action : /Person/AddressBook/Contact |
| updatePersonContact | BOD ChangePersonCode d'action : UpdateExpression d'action : /Person/AddressBook/Contact |
| deletePersonContact | BOD ChangePersonCode d'action : DeleteExpression d'action : /Person/AddressBook/Contact |
PreviewTokenHandler
- API REST : previewToken
- Nom BOD : Person
| Nom de la méthode de ressource | Mappage des services BOD |
|---|---|
| genPreviewToken | BOD ProcessPersonCode d'action :CreatePreviewTokenExpression d'action : /Person |
PriceHandler
- API REST : prix
- Nom BOD : EntitledPrice
| Nom de la méthode de ressource | Mappage des services BOD |
|---|---|
| findPricesByQuery | BOD GetEntitledPriceProfil d'accès : IBM_Store_EntitledPrice_All, IBM_Store_EntitledPrice_RangePrice_AllExpression d'action : /EntitledPrice |
ProductViewHandler
- API REST : product
- Nom BOD : CatalogNavigationView
| Nom de la méthode de ressource | Mappage des services BOD |
|---|---|
| findProductsBySearchTerm | BOD GetCatalogNavigationViewProfil d'accès : IBM_Store_CatalogEntrySearch, IBM_findCatalogEntryByNameAndShortDescriptionExpression d'action : /CatalogNavigationView |
| findProductById | BOD GetCatalogNavigationViewProfil d'accès : IBM_Store_CatalogEntrySearch, IBM_findCatalogEntryAllExpression d'action : /CatalogNavigationView[CatalogEntryView[(UniqueID=$uniqueId$)]] |
| findProductsByIds | BOD GetCatalogNavigationViewProfil d'accès : IBM_Store_CatalogEntrySearch, IBM_findCatalogEntryAllExpression d'action : /CatalogNavigationView[CatalogEntryView[(UniqueID=$uniqueId1$ ou UniqueID=$uniqueId2$)]] |
| findProductByPartNumber | BOD GetCatalogNavigationViewProfil d'accès : IBM_Store_CatalogEntrySearch, IBM_findCatalogEntryAllExpression d'action : /CatalogNavigationView[CatalogEntryView[(PartNumber=$partNumber$)]] |
| findProductsByCategory | BOD GetCatalogNavigationViewProfil d'accès : IBM_Store_Details, IBM_findCatalogEntryByNameAndShortDescriptionExpression d'action : /CatalogNavigationView[CatalogEntryView[ParentCatalogGroupID=$parentCatalogGroupId$ et (catalogEntryTypeCode='ProductBean' ou catalogEntryTypeCode='BundleBean' ou catalogEntryTypeCode='PackageBean')]] |
ProductViewHandler (recherche)
- API REST : search_product
- Effectuer une recherche dans les profils : HCL Commerce Search profiles
| Nom de la méthode de ressource | Mappage de serveur de recherche (profil de recherche par défaut) |
|---|---|
| findProductsBySearchTerm | IBM_findProductsBySearchTerm |
| findProductById | IBM_findProductByIds_Details |
| findProductsByIds | IBM_findProductByIds_Details |
| findProductByPartNumber | IBM_findProductByPartNumber_Details |
| findProductsByCategory | IBM_findProductsByCategory |
PromotionHandler
| Nom de la méthode de ressource | Mappage des services BOD |
|---|---|
| getPromotionsByQuery | BOD GetPromotionProfil d'accès : IBM_Admin_DetailsExpression d'action : /Promotion |
| getPromotionsByQuery?q=byName | BOD GetPromotionProfil d'accès : IBM_Admin_DetailsExpression d'action : /Promotion[search(contains(AdministrativeName, $qName$))] |
| getPromotionByID | BOD GetPromotionProfil d'accès : IBM_Admin_DetailsExpression d'action : /Promotion[PromotionIdentifier[(UniqueID='$promotionId$')]] |
SegmentHandler
- API REST : segment
- Nom BOD : MemberGroup
| Nom de la méthode de ressource | Mappage des services BOD |
|---|---|
| checkIsInSegmentByUserId | BOD GetMemberGroupProfil d'accès : IBM_Admin_DetailsExpression d'action : /MemberGroup[MemberGroupIdentifier[UniqueID='$memberGroupID$'] et IncludedPerson[UniqueID='$personID$']] |
| getCustomerSegment | BOD GetMemberGroupProfil d'accès : IBM_Admin_DetailsExpression d'action :ByName: /MemberGroup[search(contains(MemberGroupIdentifier[ExternalIdentifier[Name="$name$" et Usage="GeneralPurpose"]]ByUserId: /MemberGroup[IncludedPerson[UniqueID="$UserID$"] et Usage="-1"]ByPersonalizationId: /MemberGroup[IncludedPerson[UniqueID="$personID$"] et Usage="-1"]ByStore: /MemberGroup[Usage='GeneralPurpose'] |
| getCustomerSegmentById | BOD GetMemberGroupProfil d'accès : IBM_Admin_DetailsExpression d'action : /MemberGroup[MemberGroupIdentifier[(UniqueID='$memberGroupID$')]] |
ShippingInfoHandler
- API REST :
shipping_info - Nom BOD : Commande
| Nom de la méthode de ressource | Mappage des services BOD |
|---|---|
| getShippingInfo | BOD GetOrderProfil d'accès : IBM_Details Action Expression:{ibmord.isCurrentShoppingCart='true'}/Order/OrderItem |
| updateOrderShippingInfo | BOD ChangeOrderCode d'action : UpdateExpression d'action : /Order/OrderItem/OrderItemShippingInfo |
SiteContentHandler (recherche)
- API REST : search_site_content
- Effectuer une recherche dans les profils : HCL Commerce Search profiles
| Nom de la méthode de ressource | Mappage de serveur de recherche (profil de recherche par défaut) |
|---|---|
| findWebContentsBySearchTerm | IBM_findWebContentsBySearchTerm |
| findKeywordSuggestionsByTerm | Non applicable |
| findAllCategorySuggestions | IBM_findNavigationSuggestion_Categories |
| findAllBrandSuggestions | IBM_findNavigationSuggestion_Brands |
| findAllWebContentSuggestions | Non applicable |
SpotHandler
- API REST : spot
- Nom BOD : MarketingSpot
| Nom de la méthode de ressource | Mappage des services BOD |
|---|---|
| findSpotsByQuery?q=byType | BOD GetMarketingSpotProfil d'accès : IBM_Admin_DetailsExpression d'action : /MarketingSpot[Usage='$qType$'] |
| findSpotsByQuery?q=byTypeAndName | BOD GetMarketingSpotProfil d'accès : IBM_Admin_DetailsExpression d'action : /MarketingSpot[Usage='$qType$' et search(contains(MarketingSpotIdentifier/ExternalIdentifier/Name, '$qName$') ou contains(Description, '$qName$'))] |
| findSpotByID | BOD GetMarketingSpotProfil d'accès : IBM_Admin_DetailsExpression d'action : /MarketingSpot[MarketingSpotIdentifier[(UniqueID='$spotId$')]] |
StoreLocatorHandler
- API REST :
storelocator - Noms BOD : GeoNode, PhysicalStore
| Nom de la méthode de ressource | Mappage des services BOD |
|---|---|
| findGeoNodeByGeoLocation (recherche de niveau site) | BOD GetGeoNodeProfil d'accès : IBM_Store_All Expression Expression d'action : /GeoNode[@type=$type$ et search(contains(Description/Name,$Name$))] BOD GetPhysicalStoreProfil d'accès : IBM_Store_DetailsExpression d'action : /PhysicalStore[LocationInfo[GeoNodeIdentifier[UniqueID=$uniqueId$]]] |
| findGeoNodeByGeoLocation (recherche de niveau magasin) | BOD GetGeoNodeProfil d'accès : IBM_Store_All Expression Expression d'action : /GeoNode[@type=$type$ et StoreIdentifier[UniqueID=$storeId$] et search(contains(Description/Name,$Name$))] BOD GetPhysicalStoreProfil d'accès : IBM_Store_DetailsExpression d'action : /PhysicalStore[LocationInfo[GeoNodeIdentifier[UniqueID=$uniqueId$]]] |
| findGeoNodeByGeoId | BOD GetPhysicalStoreProfil d'accès : IBM_Store_DetailsExpression d'action : /PhysicalStore[LocationInfo[GeoNodeIdentifier[UniqueID=$uniqueId$]]] |
| findByStoreUniqueId | BOD GetPhysicalStoreProfil d'accès : IBM_Store_DetailsExpression d'action : /PhysicalStore[PhysicalStoreIdentifier[(UniqueID=$uniqueId$)]] |
| findStores | BOD GetPhysicalStoreProfil d'accès : IBM_Store_DetailsExpression d'action : {_sto.radiusValue=$value$;_sto.radiusUom=$uom$;_sto.maxStores=$maxStores$}/PhysicalStore[LocationInfo[GeoCode[Latitude=$latitude$ and Longitude=$longitude$]] and StoreIdentifier[UniqueID=$storeId$]] |
WishlistHandler
| Nom de la méthode de ressource | Mappage des services BOD |
|---|---|
| findWishlist | BOD GetPerson Profil d'accès : IBM_AllExpression d'action : {self=true}/Person BOD GetGiftListProfil d'accès : IBM_Store_GiftListSummaryAndItemsExpression d'action : /GiftList[Registrant[PersonIdentifier[UniqueID=]] et Registry=] |
| findWishlistByUserId_default | BOD GetPersonProfil d'accès : IBM_AllExpression d'action : {self=true}/Person BOD GetGiftListProfil d'accès : IBM_Store_GiftListSummaryAndItemsExpression d'action : /GiftList[Registrant[PersonIdentifier[UniqueID=]] et Registry= et (State=)] |
| findWishlistByExternalId | BOD GetGiftListProfil d'accès : IBM_Store_GiftListSummaryAndItemsExpression d'action : GiftList[GiftListIdentifier[GiftListExternalIdentifier[(ExternalIdentifier=)]]] BOD GetGiftListProfil d'accès : IBM_Store_GiftListSummaryAndItemsExpression d'action : /GiftList[AccessSpecifier[GuestAccessKey= ou RegistryAccessKey=] et GiftListIdentifier[GiftListExternalIdentifier[ExternalIdentifier=]]] |
| createWishlist | BOD ProcessGiftListCode d'action : CreateExpression d'action : /GiftList[1] |
| updateWishlist (lorsque addItem=true) | BOD ChangeGiftListCode d'action : AddExpression d'action : /GiftList[] /GiftList[]/Item[] |
| updateWishlist | BOD ChangeGiftListCode d'action : ChangeExpression d'action : /GiftList[] /GiftList[]/Item[] /GiftList[]/Description |
| deleteWishlist | BOD ProcessGiftListCode d'action : DeleteExpression d'action : /GiftList[1] |