Partially update an order

Request

Update an existing order status. Order items cannot be changed - if they need to be updated, cancel the order and place a new one.

Security

OAuth2(Required scopes: orders:write)

Path

orderIdstring^ord_[0-9abcdefghjkmnpqrstvwxyz]{26}$required

ID of the order to retrieve.

Example:ord_01h1s5z6vf2mm1mz3hevnn9va7

Bodyapplication/json

statusstring(OrderStatus)required

Order status.

Enum:"placed""preparing""completed""canceled"

curl -i -X PATCH \
  https://cafe.redocly.com/_mock/openapi/cafe/orders/ord_01h1s5z6vf2mm1mz3hevnn9va7 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "status": "placed"
  }'

Responses

Order updated successfully.

Bodyapplication/json

idstring, (ulid)^ord_[0-9abcdefghjkmnpqrstvwxyz]{26}$read-only

Order ID. Unique identifier prefixed with ord_.

Example:"ord_01h1s5z6vf2mm1mz3hevnn9va7"

objectstringread-only

Entity name.

Value:"order"

customerNamestring, [ 1 .. 100 ] characters^[A-Za-z]+(?:[\s'-][A-Za-z]+)*$required

Name of the customer who placed the order. Must start and end with a letter, and can contain letters, spaces, hyphens, and apostrophes (e.g., "John Doe", "Mary-Jane", "O'Brien").

statusstring(OrderStatus)read-only

Order status.

Enum:"placed""preparing""completed""canceled"

totalPriceinteger, >= 0read-only

Total order price in cents.

createdAtstring, (date-time)read-only

Created date.

updatedAtstring, (date-time)read-only

Updated date.

orderItemsArray of objects, non-emptyrequired

List of items to include in the order.

Response

{
  "id": "ord_01h1s5z6vf2mm1mz3hevnn9va7",
  "customerName": "Mary Ann",
  "orderItems": [
    { … }
  ],
  "object": "order",
  "status": "completed",
  "totalPrice": 200,
  "createdAt": "2026-08-24T14:15:22Z",
  "updatedAt": "2026-08-24T14:15:22Z"
}