Skip to main content
POST
Change order status
Change the status of an existing order. Valid transitions move an order through the workflow: pendingpreparingreadyserved. Served or cancelled orders can only be reverted to pending.

Request

Path Parameters

string
required
The order number to update.

Body

string
required
The new order status: pending, preparing, ready, served, or cancelled.

Response

Status Codes

  • 200: Order status updated successfully
  • 400: Invalid status value, or invalid state transition
  • 401: API key is required or invalid
  • 403: F&B module is disabled or workspace access is denied
  • 404: Order not found

Authorizations

apikey
string
header
required

Pass your API key in the apikey header. Alternatively, the x-api-key header is also accepted.

Path Parameters

orderNumber
string
required

The order number to update

Body

application/json
Status
enum<string>
required

The new order status

Available options:
pending,
preparing,
ready,
served,
cancelled

Response

Order status updated