Skip to main content
PUT
Update Order Status

Headers

authorization
string | null
X-API-Key
string | null
X-Stella-Merchant-Id
string | null

Path Parameters

order_id
string<uuid>
required

Body

application/json

Schema for updating order status.

status
string
required
Pattern: ^(pending|confirmed|processing|shipped|delivered|cancelled)$

Response

Successful Response

Schema for an order in responses.

Most Optional fields are sourced from the ORM where SQLAlchemy auto-resolves null columns to None, so the missing-default footgun wouldn't actually fire today. Defaults are still set explicitly here for symmetry with LineItemResponse and to guard against future callers that might validate from dicts.

id
string<uuid>
required
merchant_id
string<uuid>
required
order_number
string
required
line_items
LineItemResponse · object[]
required
subtotal
string
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
tax
string
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
shipping_cost
string
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
discount
string
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
total
string
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
currency
string
required
status
string
required
payment_status
string
required
fulfillment_status
string
required
source
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
customer_id
string<uuid> | null
email
string | null
phone
string | null
payment_method
string | null
billing_address
AddressSchema · object | null

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

shipping_address
AddressSchema · object | null

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

shipping_method
string | null
tracking_number
string | null
tracking_url
string | null
note
string | null
staff_note
string | null
shipped_at
string<date-time> | null
delivered_at
string<date-time> | null
cancelled_at
string<date-time> | null