v2

latestOpenAPI 3.1.02026-08-07750280.6 KB

Orders

Update order

Update an order's status or notes.

Available status transitions:
- `confirmed` - Approve a pending order
- `completed` - Mark a confirmed order as fulfilled
- `refused` - Refuse a pending order (requires status_reason)

Note: Orders cannot be cancelled via this endpoint.
Cancellation is only available to customers via the public order link.

Authentication:
- API key with READ_WRITE permission

patch/orders/{order_id}

Path parameters

order_idstring uuid required

Request body

statusstring nullable

Order status (confirmed, completed, refused)

notesstring nullable

Additional notes

status_reasonstring nullable

Reason for refusing the order (required when status is 'refused')

Example request

{
  "notes": "Customer requested extra napkins",
  "status": "confirmed"
}

Response

Successfully updated order

okboolean

dataobject