v9

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

Update an order status (synchronous)

Transitions the order to a new status, validated by the order state machine snapshot embedded at creation. On success it appends an immutable timeline event (OrderTrackingEvent). Operator / internal-integration path: accountCode and the actor (user or service account) come from the JWT.

patch/api/v1/orders/{id}/status

Path parameters

idstring uuid required
Example:01920000-0000-7000-8000-000000000000

Order identifier (UUID).

Request body

metadataobject nullable
statusstring required

Response

Order status updated.

idstring required
statusstring required
previous_statusstring required
updated_atstring required
event_idstring required