Technical summary of integration features

Sterling Order Management user exits

YPMgGetOrderPriceUE

The user exit gets unit prices, promotion discounts, gifts, and shipping promotion discounts for a HCL Commerce order or cart.

YPMGetItemPriceUE

The user exit gets item prices from HCL Commerce for specific catalog entries for orders that originate from Sterling Order Management.

YPMGetPricingRuleDetailsUE

The user exit gets promotion details from HCL Commerce for a specific promotion.

YPMValidateCouponUE

The user exit validates manual promotions (coupons) against their definitions on HCL Commerce.

SCWC_SDF_changeOrderOnSuccess service, SCWC_SDF_changeOrderOnCancel, SCWC_SDF_confirmDraftOrderOnSuccess

Sterling Order Management updates HCL Commerce promotion statistics when an order is changed, canceled, or when there is a draft order confirmation using the service, and service respectively.

Customer Service Representatives can create an order for a HCL Commerce shopper from Sterling Call Center, Sterling Store, or other order management system channels.

HCL Commerce APIs

Checks online inventory

Checks online inventory availability in the local inventory cache during the product page and check-out phases, respecting local inventory cache. If the local inventory cache is not up to date, HCL Commerce calls the Sterling Order ManagementmonitorItemAvailability API for updated inventory information.

Submit order

When an order is submitted to be picked up in-store, the real-time inventory check ignores the local cache. It directly calls Sterling Order Management through the Service Definition Framework because the inventory is checked against a physical store. The findInventory API is called to get the inventory availability information and returns it back to HCL Commerce.

Sterling Order Management Real-Time Availability Monitor (RTAM) uses a time-triggered transaction to detect inventory changes beyond specified levels and trigger the REALTIME_AVAILABILITY_CHANGE_LIST event.

This event starts SCWC_SDF_syncInventoryMessages service that publishes inventory information to a JMS queue. SCWC_SDF_pushInventoryMessages service picks up the message from the queue and updates the inventory cache on the HCL Commerce side by invoking an inventory web service from the HCL Commerce.

Reserves inventory

Reserves inventory immediately before an order is submitted. Calls the Sterling Order Management reserveAvailableInventoryAPI.

Cancels the inventory reservation

If the shopper edits the cart after the inventory reservation was run, cancels the inventory reservation.

Submit order

After the shopper submits an order, the order is transferred to Sterling Order Management by calling the createOrder API.

• HCL Commerce then sends the order information to Sterling Order Management for fulfillment with the processOrder request, which is mapped to the SCWC_SDF_createOrder service. Sterling Order Management continually monitors this queue, picks up messages, and sends acknowledgment messages back to HCL Commerce by another JMS queue.
• The order is created in Sterling Order Management and raises an ON_SUCCESS event, which starts the SCWC_SDF_createOrderOnSuccess service to send the createOrder acknowledgment to a JMS queue.
• The SCWC_SDF_pushOrderMessages picks up the message from the queue and invokes order web service from HCL Commerce to transfer the acknowledgment. HCL Commerce processes the acknowledgment message and updates the status of the order to Successfully Transferred.

Order history

The Order history section of the My Account page HCL Commerce returns a consolidated order history list that merges orders that were created in Sterling Order Management with orders where the records are available locally in HCL Commerce. HCL Commerce uses the Sterling Order Management getOrderList API to retrieve an order history.

Order details

The Order Details page shows orders that exist in Sterling Order Management. The getCompleteOrderDetails API is called. If the shopper wants to reorder, HCL Commerce calls the same API.

Outage

HCL Commerce gracefully starts the inventory operations and accepts orders during a Sterling Order Management outage.

Create account

When a guest shopper creates an account, or places an order and then logs into the store and the order is transferred and successfully created in Sterling Order Management, HCL Commerce invokes an asynchronous event. HCL Commerce sends a changeOrder outbound message to change the BuyerUserId attribute of the order in Sterling Order Management. The SCWC_SDF_changeOrder integration server updates the BuyerUserId of the order in Sterling Order Management.

Transfer order

When an order that is transferred to Sterling Order Management is canceled from HCL Commerce, a synchronous call is made though SCWC_SDF_changeOrderRealTime to cancel the order in Sterling Order Management. The Order Details page displays a Cancel button, if the modification rules that are configured in Sterling Order Management allow for cancellation of the Sterling Order Management order in that status.