API Catalog¶
Canonical Unified Commerce APIs — machine-readable, vendor-neutral, cross-referenced.
43 APIs across 8 domains.
| Method | Legend |
|---|---|
| 🔵 POST | Command — mutates state, emits events |
| 🟢 GET | Query — read-only, no side effects |
| 🔴 POST/action | Action — imperative state machine trigger |
commerce¶
| API | Method | Path | Type | Application |
|---|---|---|---|---|
| 🟢 Get Product | GET |
/products/{id} |
query |
eCommerce Platform |
| 🔵 Create Transaction | POST |
/transactions |
command |
POS |
| 🔴 Void Transaction | POST |
/transactions/{id}/void |
action |
POS |
| 🔵 Create Basket | POST |
/baskets |
command |
eCommerce Platform |
| 🔵 Add Line to Basket | POST |
/baskets/{id}/lines |
command |
eCommerce Platform |
| 🔴 Checkout Basket | POST |
/baskets/{id}/checkout |
action |
eCommerce Platform |
customer¶
| API | Method | Path | Type | Application |
|---|---|---|---|---|
| 🟢 Search Customer | GET |
/customers |
query |
CRM |
| 🟢 Get Customer | GET |
/customers/{id} |
query |
CRM |
| 🟢 Get Customer 360 | GET |
/customers/{id}/360 |
query |
Clienteling App |
| 🔵 Create Customer | POST |
/customers |
command |
CRM |
| 🔵 Log Customer Interaction | POST |
/interactions |
command |
Clienteling App |
fulfillment¶
| API | Method | Path | Type | Application |
|---|---|---|---|---|
| 🟢 Get Fulfillment Order | GET |
/fulfillment/orders/{id} |
query |
FMS |
| 🟢 Track Shipment | GET |
/shipments/{id}/tracking |
query |
Carrier Platform |
| 🔴 Dispatch Fulfillment Order | POST |
/fulfillment/orders/{id}/dispatch |
action |
FMS |
| 🔵 Create Return | POST |
/returns |
command |
FMS |
| 🔵 Create Picking Order | POST |
/picking-orders |
command |
WMS |
| 🔵 Generate Shipping Label | POST |
/shipments/{id}/label |
command |
Carrier Platform |
| 🔴 Update Picking Status | PUT |
/picking-orders/{id}/status |
action |
WMS |
inventory¶
| API | Method | Path | Type | Application |
|---|---|---|---|---|
| 🔴 Release Reservation | DELETE |
/inventory/reservations/{id} |
action |
SIM |
| 🟢 Get Inventory | GET |
/inventory/items/{sku} |
query |
SIM |
| 🟢 Get Stock Locations | GET |
/stock/{sku}/locations |
query |
WMS |
| 🟢 Check Availability | GET |
/inventory/{sku}/availability |
query |
Inventory Service |
| 🔵 Reserve Inventory | POST |
/inventory/reservations |
command |
SIM |
| 🔴 Confirm Reservation | POST |
/inventory/reservations/{id}/confirm |
action |
SIM |
| 🔵 Allocate Inventory | POST |
/inventory/allocate |
command |
Inventory Service |
loyalty¶
| API | Method | Path | Type | Application |
|---|---|---|---|---|
| 🟢 Get Member Balance | GET |
/members/{id}/balance |
query |
Loyalty Platform |
| 🔵 Enroll Loyalty Member | POST |
/loyalty/members |
command |
CRM |
| 🔵 Issue Loyalty Points | POST |
/loyalty/accounts/{id}/points |
command |
CRM |
| 🔵 Redeem Loyalty Points | POST |
/loyalty/accounts/{id}/redemptions |
command |
CRM |
| 🔵 Earn Points | POST |
/members/{id}/earn |
command |
Loyalty Platform |
| 🔵 Redeem Points | POST |
/members/{id}/redeem |
command |
Loyalty Platform |
order¶
| API | Method | Path | Type | Application |
|---|---|---|---|---|
| 🟢 Get Order | GET |
/orders/{id} |
query |
OMS |
| 🔵 Create Order | POST |
/orders |
command |
OMS |
| 🔴 Cancel Order | POST |
/orders/{id}/cancel |
action |
OMS |
| 🔴 Confirm Order | POST |
/orders/{id}/confirm |
action |
OMS |
| 🔴 Route Order | POST |
/orders/{id}/route |
action |
OMS |
payment¶
| API | Method | Path | Type | Application |
|---|---|---|---|---|
| 🔵 Authorize Payment | POST |
/payments/authorizations |
command |
Payment Hub |
| 🔴 Capture Payment | POST |
/payments/authorizations/{id}/capture |
action |
Payment Hub |
| 🔴 Void Payment | POST |
/payments/authorizations/{id}/void |
action |
Payment Hub |
| 🔵 Refund Payment | POST |
/payments/{id}/refunds |
command |
Payment Hub |
| 🔵 Add Payment | POST |
/transactions/{id}/payment |
command |
POS |
promotion¶
| API | Method | Path | Type | Application |
|---|---|---|---|---|
| 🔵 Evaluate Promotions | POST |
/promotions/evaluate |
command |
Promotion Engine |
| 🔵 Validate Voucher | POST |
/vouchers/{code}/validate |
query |
Promotion Engine |