Update Order Status

Log in to see full request history

Add a status to the associated Order.

App Scope
ChannelPosRiderLoyalty
✔️(¹)✔️(²)✔️(³)✖️

(1) Scope Channel
If you are a Channel, you should indicate the status change of an order if it is cancelled. Below we indicate the state and its meaning:

  • CANCELLED: this status must be sent when the Order collection or delivery process cannot be completed

(2) Scope Pos
If you are a Pos, you should indicate the status change of an order. Below we indicate the meaning of each state:

  • IN_KITCHEN: the Order has entered and has been processed correctly by the Pos
  • SERVED: the Order has been served to the table. This state can be applied only when the previous Order status was IN_KITCHEN and the Order fulfillment type is order-at-table
  • PICKED_UP: the order has been picked up by the customer. This state can be applied only when the previous Order status was IN_KITCHEN and the Order fulfillment type is takeaway
  • READY_TO_PICK_UP: the Order is ready to be picked up by a rider. This state can be applied only when the previous Order status was IN_KITCHEN and the Order fulfillment type is delivery-by-channel, delivery-by-location or delivery-by-delivery-partner

(3) Scope Rider
If you are a Rider, you have the obligation to communicate that you have taken charge of the delivery by sending the CREATED status. If you do not send any statuses, you will not have access to the order. Below we indicate the meaning of each state:

  • CREATED: the Order has been successfully received by the Rider
  • PICKING: a rider has begun his journey towards the collection point of the Order
  • DELIVERING: the rider has successfully collected the Order from the collection point and started his journey towards the delivery point
  • COMPLETED: the rider has successfully delivered the Order
  • CANCELLED: this status must be sent when the Order collection or delivery process cannot be completed
  • ERROR: this status must be sent when an error occurs
Path Params
string
required

The id of the Store whose Order you want to update the status

string
required

The id of the Order you want to update the status

Body Params
string
required

The new Order status. Read the documentation above to better understand the meaning of each state

data
object

Optionally you can add an object with extra information regarding the rider's geolocation

Responses

Language
Credentials
OAuth2
Click Try It! to start a request and see the response here! Or choose an example:
application/json