Update order status

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.

post/v1/orders/{orderId}/status

Request

Base URL
https://partners.tryotter.com
Auth
OAuth 2
Authorization code/v1/auth/oauth2/authorize
Client credentials
Token URL/v1/auth/token
Scopesorders.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.

Path parameters

orderIdstring required

The external order identifier supplied by your app in externalIdentifiers.id when the order was created.

Example:295f76b4-5725-4bf5-a8ab-97943dbdc3b4

Headers

X-Store-Idstring 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).

Example:partner-store-unique-identifier

X-Event-Idstring

Optional unique identifier of the event that this callback refers to.

Example:cf0ce51b-d74e-40d3-b177-1925ab4edc0c

Request body

orderStatus'PREPARED' | 'CANCELED' | 'FULFILLED' required

The requested status to transition the order to.

Response

The order status was successfully accepted.

Changes

No recorded changes to this operation across all 1 revision of this API.