Skip to content

Create Order

POST /orders command bearer

Creates a new Order from a validated Basket, transitioning the basket to checked-out state.

Overview
ID create-order-api
Method POST
Path /orders
Classification command
Domain order
Capability order-management
Service create-order
Application oms — OMS
Auth bearer

Request Body
Business Object basket
Description Commerce container holding intended purchases before order creation.
Classification aggregate-root
Lifecycle open → locked → converted → abandoned → merged

Response
Business Object order
Description Confirmed commercial commitment created from checkout or assisted selling.
Lifecycle draft → confirmed → in-fulfilment → partially-fulfilled → completed → return-in-progress → cancelled

Events Emitted

Event Classification Object Description
order-created created order A new order was created from a converted basket or direct entry.

Integration Patterns

Pattern Flow Style Description
eCommerce Platform → OMS Order Submission ecommerce-platform → oms synchronous-api When a customer completes digital checkout, the eCommerce Platform submits the validated basket to the OMS to create a confirmed order.
POS → OMS In-Store Order pos → oms synchronous-api When a POS transaction is completed, the POS creates an order in the OMS for stock reconciliation, receipt generation, and loyalty accrual.

Scenarios using order-management

Scenario Description
Buy Online, Pick Up In Store Customer browses and purchases online, then collects the order from a physical store. The canonical
Buy Online, Return In Store Customer purchased online (any channel) and returns the item at a physical store. The store processe
Unified Omnichannel Checkout Customer completes a standard commerce checkout journey from basket through pricing, promotions, pay
Clienteling Sale A store associate uses a clienteling application to identify a known customer, review their purchase
Decision Review and Execution A material automated recommendation is recorded with its purpose, evidence, policy, confidence, and
Endless Aisle Store associate helps a customer order an item that is not physically stocked in the current store b
Exchange Anywhere Customer exchanges an item purchased in any channel at any supported touchpoint. The original item i
Reserve and Collect Customer reserves stock online for in-store collection without paying at the time of reservation. Th
Retail Media Attribution A sponsored offer is activated for an eligible, consent-aware audience and its approved exposure and
Scan and Go Customer scans items using a mobile app while shopping, receives promotions and loyalty benefits in
Self-Checkout Customer scans and bags items at a self-checkout kiosk, receives applicable promotions, settles paym
Service and Repair Management A customer or associate creates a repair, installation, or maintenance commitment linked to the orig
Ship From Store An online order is fulfilled by shipping the goods directly from a physical store rather than a cent
Ship To Store Customer places an online order for collection at a chosen store while stock is sourced from a wareh
Subscription Renewal A recurring subscription is renewed either automatically or after a customer reminder and confirmati
Unified Return Customer returns an item regardless of the original purchase channel. The return may be initiated on
Voucher Redemption Customer redeems a voucher or gift card during checkout in store or online. The flow covers voucher
API Method Path Type
Get Order GET /orders/{id} query
Cancel Order POST /orders/{id}/cancel action
Confirm Order POST /orders/{id}/confirm action
Route Order POST /orders/{id}/route action