Skip to main content
PUT
Update a specific order

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

The unique order identifier, generated when the order was created.

Body

application/json

The request body to update an order requires only the properties to be updated.

Order properties that can be updated: dish_ids, priority, and status.

dish_ids
string[]

The list of unique dish ids included in an order.

Example:
priority
integer
default:3

The priority of an order. Defaults to 3 but can be changed as needed. Highest priority is 0, lowest is 5.

Orders will often be sorted by priority to ensure highest priority orders are prepared first.

Required range: 0 <= x <= 5
status
enum<string> | null

Indicates the status of the order preparation.

The expeditor will use this field to sort incoming orders and determine what dishes are ready to be prepared and assembled by station.

Available options:
Draft,
Received,
In Progress,
Ready for Assembly,
On the Way,
Ready for Pickup
Example:

"Received"

Response

Order updated successfully

results
object[]
total_results
integer
Example:

1