carriers5

channels5

clusters5

customer-addresses3

customers4

delivery-modalities5

delivery-types5

freight-types5

fulfillment-order-shipment-tracking-events1

fulfillment-order-shipments3

fulfillment-order-tracking-events1

fulfillment-orders4

inventory2

inventory-movements1

operators5

order-payments2

orders7

payment-methods3

permissions1

price-lists7

product-categories5

products3

promotions5

state-machines6

statuses5

strategies5

strategy-carriers5

strategy-channels5

strategy-operators5

strategy-price-lists5

webhook-subscriptions6

orders

Create a channel order (synchronous)

Changed on Jul 7, 2026

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

Base URL
https://oms-api.tenant.krzlabs.io
Auth
- HTTP basic
- or HTTP bearer
TypeScript
https://skmtc.dev/kruzer-corp/apis/oms-api/docs/api/v1/orders/post.ts
A function with typed inputs. Its response is checked against the schema.

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

Changes

Jul 7, 2026a3b4750a505f Revision changes
- breaking
  added the new required request property /////
- breaking
  added the new required request property /////
- breaking
  added the new required request property /////
- breaking
  added the new required request property /////
- breaking
  added the new required request property /////
- breaking
  added the new required request property /////
- breaking
  added the new required request property /////
- breaking
  added the new required request property
- breaking
  added the new required request property
- breaking
  added the new required request property //
- breaking
  added the new required request property //
- breaking
  added the new required request property //
- breaking
  added the new required request property //
- breaking
  added the new required request property //
- breaking
  added the new required request property //
- breaking
  added the new required request property //
- breaking
  added the new required request property //
- breaking
  added the new required request property /////
- breaking
  added the new required request property /////
- breaking
  added the new required request property /////
- breaking
  added the new required request property /////
- breaking
  added the new required request property /////
- breaking
  added the new required request property /////
- breaking
  added the new required request property /////
- breaking
  added the new required request property /
- breaking
  added the new required request property /
- breaking
  added the new required request property /
- breaking
  added the new required request property /
- breaking
  the request property's minItems was increased to 1
- breaking
  the request property's minItems was increased to 1
- breaking
  the request property type changed from object to string
- breaking
  the request property type changed from object to string
- breaking
  the request property type changed from object to string
- breaking
  the request property type changed from object to string
- info
  added the new optional request property /////
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  added the new optional request property /////
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
Jul 7, 202684194c31ab85 Revision changes
- info
  endpoint added

Operation history

Create a channel order (synchronous)

Request

Request body

Response 201Created

Changes

Response