Skip to main content
POST
Confirm your deployment before running this request. This page describes an API contract; a published reference does not establish hosted availability. Check the dated host report and obtain your deployment URL and credentials. Replace the example host if your provisioned service uses a different URL.

Headers

string,null
Optional client-generated key. Replaying the same key with an identical body returns the original response without creating a duplicate; reusing it with a different body returns 422. Scoped per tenant.

Request body

CreateOrderRequest
AddressDto,null
Address DTO shared by orders and customers.
string,null
ISO currency code (default: USD).
string (uuid)
required
The customer placing the order.
CreateOrderItemRequest[]
required
Line items for the order.
string,null
Optional notes.
string,null
Payment method identifier.
AddressDto,null
Address DTO shared by orders and customers.
string,null
Shipping method identifier.
StockPolicyDto,null
Stock policy accepted by POST /api/v1/orders (stock_policy). Allowed values: 'allow_backorder', 'reject_if_insufficient'.

Response

OrderResponse
string (date-time)
required
string
required
string (uuid)
required
string
required
string (uuid)
required
OrderItemResponse[]
required
string
required
string
required
string
required
string
required
string (date-time)
required

Status codes

Using this contract

Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.
Last modified on September 21, 2026