Create Sync Status for an Order

Use this endpoint to tell us if the order has been successfully sent to the site's in-store system. If the status is failed, use the reason and notes values to tell us why.

If we don't receive your sync status after 3 minutes, or we receive a failed status, we'll send a message to the Deliveroo tablet prompting staff to check their in-store system for the order, and enter manually into the till if needed.

Once we've received a sync status (or the timeout occurs), any attempts to update it will give you an HTTP 409.

We don't require sync status calls for sites marked as tabletless. If such a site is using Deliveroo tablet and some orders will fail to be synchronized, the tablet will not show notifications about the failures.

This endpoint is rate limited at 1 request per 10s per order.

Path Params
string
required

Related order id in format {market}:{order_uuid}.

Body Params

SyncStatus body.

string
enum

Status of the sync status. Can be succeeded or failed.

Allowed:
string | null
enum

Required if the status is failed. This explains why the order could not be sent to the in-store system in the site.

string | null

Free text field to provide more information as to why the order failed to reach the in-store system. e.g. which items or prices were wrong.

string

Time the sync status was received in the ISO-8601 format.

Responses

409 Conflict status code if sync status was already sent to us or the timeout occurred.

Language
Credentials
OAuth2
URL
Response
Choose an example:
application/json