v9

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-071292691.1 MB

orders

Create a channel order (synchronous)

Validates and synchronously materializes a channel order: checks the channel is active; optionally links an existing customer by customer_id (the order is left unidentified when omitted); validates every item SKU against an active product and every payment method against an active payment method; cross-checks the subtotal against the sum of item totals; then persists the order, its items, addresses, mirrored payments and bootstrap timeline event in a single transaction. A duplicate (same external_order_id + channel) is rejected with 409. Authenticated as a channel service account.

post/api/v1/orders

Request body

requested_strategy_codestring nullable

source_storestring nullable

shipping_methodstring nullable

currency'BRL' | 'USD'

customer_idstring uuid nullable

metadataobject nullable

external_order_idstring required

channel_codestring required

Response

Order created.

idstring required

external_order_idstring required

channel_idstring required

customer_idstring nullable required

requested_strategy_codestring nullable required

source_storestring nullable required

shipping_methodstring nullable required

statusstring required

state_machine_version_idstring required

state_machine_idstring required

currency'BRL' | 'USD' required

subtotalnumber required

shippingnumber required

discountnumber required

totalnumber required

item_countnumber required

created_atstring required

updated_atstring required