Skip to main content
POST
Create Order From Ai

Headers

X-Sync-Secret
string
required
X-Site-ID
string
required

Body

application/json

Schema for creating order from AI widget.

line_items
SyncOrderLineItem · object[]
required
shipping_address
AddressSchema · object
required

Schema for address. Fields are optional to support simpler address formats from AI widget.

payment_method
string
required
email
string<email> | null
phone
string | null
billing_address
AddressSchema · object | null

Schema for address. Fields are optional to support simpler address formats from AI widget.

payment_intent_id
string | null
note
string | null
subtotal
number | null
total
number | null
currency
string | null
source
string
default:web
external_id
string | null
first_name
string | null
last_name
string | null
ig_username
string | null

Response

Successful Response

Response for order created from AI.

id
string<uuid>
required
order_number
string
required
total
string
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
currency
string
required
status
string
required
payment_status
string
required
created_at
string<date-time>
required
email
string | null