---
title: "Update order status"
method: POST
path: "/v1/orders/{orderId}/status"
tags: ["orders_endpoints"]
---

# Update order status

`POST /v1/orders/{orderId}/status`

## Request

- Base URL: `https://partners.tryotter.com`
- URL: `https://partners.tryotter.com/v1/orders/{orderId}/status`
- Auth: OAuth 2
  - Authorization code: `/v1/auth/oauth2/authorize`
  - Client credentials
  - Token URL: `/v1/auth/token` scopes: `orders.update`
- TypeScript: <https://skmtc.dev/cloudkitchens/apis/otter-api/docs/v1/orders/:orderId/status/post.ts> (a function with typed inputs; its response is checked against the schema)

Transitions the order identified by `orderId` to a new status. Only `PREPARED`, `CANCELED`, and `FULFILLED` are accepted by this endpoint.
When transitioning to `CANCELED`, you may include the optional `X-Event-Id` header to acknowledge a cancellation that the platform requested via the intent-to-cancel webhook. The order lifecycle is asynchronous, so a successful call returns `202 Accepted`.
Rate limit: 32 requests per minute.

## Path parameters

- `orderId` string, required: The external order identifier supplied by your app in `externalIdentifiers.id` when the order was created.

## Headers

- `X-Store-Id` string, required: The unique identifier of the store in your app. This ID, along with the `Application ID`, will be used to match the correct store when performing operations. It cannot be longer than 255 characters and must only contain printable ASCII characters. During on-boarding, this ID will be similar to `onboarding:905bb725-b141-4a9b-832a-1f254f772c94` (where the UUID is the Internal Store ID). During off-boarding, this field will be filled with the last known Store ID, or with an empty string, in case none is found. In that case, please fall back to the provided `internalStoreId` (a.k.a. Sku-Sku ID).
- `X-Event-Id` string: Optional unique identifier of the event that this callback refers to.

## Request body

- OrderStatusUpdateRequest: The request to change an order status.
  - `orderStatus` 'PREPARED' | 'CANCELED' | 'FULFILLED', required: The requested status to transition the order to.

## Response `202`

The order status was successfully accepted.

## Other responses

- `400`: The request is malformed.
- `401`: Invalid authorization.
- `403`: Authorization not valid for the requested resource.
- `404`: Resource not found.
- `422`: The request body is not valid.

---

[API](https://skmtc.dev/cloudkitchens/apis/otter-api.md) - [All operations](https://skmtc.dev/cloudkitchens/apis/otter-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cloudkitchens/apis/otter-api/revisions/4c868194a467?raw)