🔗 Unified Commerce Integration Patterns
Canonical integration patterns between applications in the UC-BoK reference stack.
21 patterns across 9 source applications.
Legend
| Icon |
Style |
Description |
| 🔄 |
Synchronous API |
Direct REST request-response |
| 📨 |
Event-Driven |
Async via domain events / message broker |
| 📦 |
Batch Sync |
Scheduled bulk data synchronisation |
| 🔔 |
Webhook |
Push notification from target to source |
All Integration Patterns
| Source |
|
Target |
Style |
Trigger |
| OMS |
→ |
SIM |
🔄 Synchronous API |
order-confirmed |
| OMS |
→ |
FMS |
📨 Event-Driven |
order-confirmed |
| OMS |
→ |
Payment Hub |
🔄 Synchronous API |
order-confirmed |
| OMS |
→ |
Loyalty Platform |
📨 Event-Driven |
order-completed |
| OMS |
→ |
Promotion Engine |
🔄 Synchronous API |
order-created |
| eCommerce Platform |
→ |
OMS |
🔄 Synchronous API |
checkout-completed |
| eCommerce Platform |
→ |
SIM |
🔄 Synchronous API |
product-page-view |
| eCommerce Platform |
→ |
Loyalty Platform |
🔄 Synchronous API |
checkout-started |
| eCommerce Platform |
→ |
Promotion Engine |
🔄 Synchronous API |
basket-updated |
| POS |
→ |
OMS |
🔄 Synchronous API |
transaction-completed |
| POS |
→ |
Payment Hub |
🔄 Synchronous API |
payment-step |
| POS |
→ |
SIM |
🔄 Synchronous API |
product-scan |
| POS |
→ |
Loyalty Platform |
🔄 Synchronous API |
transaction-completed |
| FMS |
→ |
WMS |
📨 Event-Driven |
fulfillment-order-created |
| FMS |
→ |
Carrier Platform |
🔄 Synchronous API |
fulfillment-order-dispatched |
| Carrier Platform |
→ |
FMS |
🔔 Webhook |
carrier-status-update |
| SIM |
→ |
Inventory Service |
🔄 Synchronous API |
availability-query |
| WMS |
→ |
SIM |
📨 Event-Driven |
picking-task-completed |
| CRM |
→ |
eCommerce Platform |
📦 Batch Sync |
scheduled-nightly |
| Clienteling App |
→ |
CRM |
🔄 Synchronous API |
associate-lookup |
| OMS |
→ |
CRM |
📨 Event-Driven |
order-completed |
By Source Application
| Target |
Style |
Summary |
| FMS |
🔔 Webhook |
The Carrier Platform pushes delivery status updates (in-transit, out-for-delivery, delivered, except… |
| ### Clienteling App |
|
|
| Target |
Style |
Summary |
| CRM |
🔄 Synchronous API |
Associates use the Clienteling App to retrieve a unified customer 360 view from the CRM — purchase h… |
| ### CRM |
|
|
| Target |
Style |
Summary |
| eCommerce Platform |
📦 Batch Sync |
The CRM exports a nightly delta of customer profile updates to the eCommerce Platform to keep prefer… |
| ### eCommerce Platform |
|
|
| Target |
Style |
Summary |
| OMS |
🔄 Synchronous API |
When a customer completes digital checkout, the eCommerce Platform submits the validated basket to t… |
| SIM |
🔄 Synchronous API |
The eCommerce Platform queries the SIM for real-time ATP before displaying stock availability on pro… |
| Loyalty Platform |
🔄 Synchronous API |
At checkout start, the eCommerce Platform retrieves the customer's current points balance so the cus… |
| Promotion Engine |
🔄 Synchronous API |
On every basket update, the eCommerce Platform calls the Promotion Engine to evaluate applicable pro… |
| ### FMS |
|
|
| Target |
Style |
Summary |
| WMS |
📨 Event-Driven |
When a Fulfillment Order is routed to a warehouse node, the FMS instructs the WMS to generate a pick… |
| Carrier Platform |
🔄 Synchronous API |
At dispatch, the FMS calls the Carrier Platform to generate a shipping label and obtain a tracking n… |
| ### OMS |
|
|
| Target |
Style |
Summary |
| SIM |
🔄 Synchronous API |
When an order is confirmed, the OMS calls the SIM to soft-reserve inventory for each order line. Ens… |
| FMS |
📨 Event-Driven |
On order confirmation, the OMS publishes an order-confirmed event that the FMS consumes to create a … |
| Payment Hub |
🔄 Synchronous API |
After order confirmation, the OMS instructs the Payment Hub to capture a previously authorised payme… |
| Loyalty Platform |
📨 Event-Driven |
When an order reaches completed state, the OMS publishes an order-completed event. The Loyalty Platf… |
| Promotion Engine |
🔄 Synchronous API |
At order creation, the OMS validates applied promotions and vouchers with the Promotion Engine to pr… |
| CRM |
📨 Event-Driven |
Completed orders are published as events and consumed by the CRM to update the customer's purchase h… |
| ### POS |
|
|
| Target |
Style |
Summary |
| OMS |
🔄 Synchronous API |
When a POS transaction is completed, the POS creates an order in the OMS for stock reconciliation, r… |
| Payment Hub |
🔄 Synchronous API |
The POS calls the Payment Hub for every payment tender during checkout — card authorisation, gift ca… |
| SIM |
🔄 Synchronous API |
Associates can look up real-time stock levels for a product at the POS, including availability at ot… |
| Loyalty Platform |
🔄 Synchronous API |
At transaction close, the POS triggers loyalty point accrual and handles redemption requests. Both o… |
| ### SIM |
|
|
| Target |
Style |
Summary |
| Inventory Service |
🔄 Synchronous API |
The SIM delegates ATP calculation and allocation logic to the Inventory Service, which applies netwo… |
| ### WMS |
|
|
| Target |
Style |
Summary |
| SIM |
📨 Event-Driven |
When a picking task is completed, the WMS publishes a stock-movement event that the SIM consumes to … |