Scheduled Orders
Deliveroo sends order events upon user acceptance, meaning that scheduled orders will be sent to the tablet and system immediately, regardless of the order creation time.
Scheduled orders do not benefit from an automatic preparation and release time.
The integrator's responsibility is to define when the order should be sent to the till and prepared. You are free to queue "asap": false
order events on your end to release the orders accordingly.
However, you need to confirm scheduled orders before their preparation start. We enclosed the confirm_at
timecode in the order.new
event payload to guide you at what time it should be confirmed.
Suppose you want to create a dedicated scheduled order queue in your system. In that case, the
start_preparing_at
timecode is helpful if you need to design behaviour that will release anticipated orders to the till. e.g. 10 minutes before the preparation starting time.
Example Webhook Payloads
Note that, for scheduled orders, the asap
field is false
and there is a confirm_at
field in the order.new
& order.status_update
event payloads.
{
"event": "order.new",
"body": {
"order": {
"id": "gb:f2eb207a-2111-45f7-9008-cb561da4f45a",
"order_number": "29016206",
"location_id": "4163",
"display_id": "6206",
"status": "placed",
"status_log": [
{
"at": "2022-05-30T14:27:05Z",
"status": "pending"
},
{
"at": "2022-05-30T14:27:06Z",
"status": "placed"
}
],
"fulfillment_type": "deliveroo",
"order_notes": "No pickles please.",
"cutlery_notes": "NO CUTLERY",
"asap": false,
"prepare_for": "2022-05-30T15:42:00Z",
"total_price": {
"fractional": 885,
"currency_code": "GBP"
},
"partner_order_total": {
"fractional": 885,
"currency_code": "GBP"
},
"offer_discount": {
"fractional": 0,
"currency_code": "GBP"
},
"cash_due": {
"fractional": 0,
"currency_code": "GBP"
},
"bag_fee": {
"fractional": 10,
"currency_code": "GBP"
},
"items": [
{
"pos_item_id": "4534.0",
"quantity": 1,
"name": "The Chicken Burger",
"operational_name": "The Chicken Burger (Wraps and Burgers)",
"unit_price": {
"fractional": 630,
"currency_code": "GBP"
},
"menu_unit_price": {
"fractional": 630,
"currency_code": "GBP"
},
"total_price": {
"fractional": 885,
"currency_code": "GBP"
},
"discount_amount": {
"fractional": 0,
"currency_code": "GBP"
},
"modifiers": [
{
"pos_item_id": "99.0",
"quantity": 1,
"name": "Fries - Salted",
"operational_name": "Fries - Salted",
"unit_price": {
"fractional": 255,
"currency_code": "GBP"
},
"total_price": {
"fractional": 255,
"currency_code": "GBP"
},
"discount_amount": {
"fractional": 0,
"currency_code": "GBP"
}
}
]
}
],
"start_preparing_at": "2022-05-30T15:26:00Z",
"confirm_at": "2022-05-30T14:56:43Z",
"is_tabletless": false
}
}
}
{
"event": "order.status_update",
"body": {
"order": {
"id": "gb:f2eb207a-2111-45f7-9008-cb561da4f45a",
"order_number": "29016206",
"location_id": "4163",
"display_id": "6206",
"status": "accepted",
"status_log": [
{
"at": "2022-05-30T14:27:05Z",
"status": "pending"
},
{
"at": "2022-05-30T14:27:06Z",
"status": "placed"
},
{
"at": "2022-05-30T14:35:35.357663Z",
"status": "accepted"
}
],
"fulfillment_type": "deliveroo",
"order_notes": "No pickles please.",
"cutlery_notes": "NO CUTLERY",
"asap": false,
"prepare_for": "2022-05-30T15:42:00Z",
"total_price": {
"fractional": 885,
"currency_code": "GBP"
},
"partner_order_total": {
"fractional": 885,
"currency_code": "GBP"
},
"offer_discount": {
"fractional": 0,
"currency_code": "GBP"
},
"cash_due": {
"fractional": 0,
"currency_code": "GBP"
},
"bag_fee": {
"fractional": 10,
"currency_code": "GBP"
},
"items": [
{
"pos_item_id": "4534.0",
"quantity": 1,
"name": "The Chicken Burger",
"operational_name": "The Chicken Burger (Wraps and Burgers)",
"unit_price": {
"fractional": 630,
"currency_code": "GBP"
},
"menu_unit_price": {
"fractional": 630,
"currency_code": "GBP"
},
"total_price": {
"fractional": 885,
"currency_code": "GBP"
},
"discount_amount": {
"fractional": 0,
"currency_code": "GBP"
},
"modifiers": [
{
"pos_item_id": "99.0",
"quantity": 1,
"name": "Fries - Salted",
"operational_name": "Fries - Salted",
"unit_price": {
"fractional": 255,
"currency_code": "GBP"
},
"total_price": {
"fractional": 255,
"currency_code": "GBP"
},
"discount_amount": {
"fractional": 0,
"currency_code": "GBP"
}
}
]
}
],
"start_preparing_at": "2022-05-30T15:26:00Z",
"confirm_at": "2022-05-30T14:56:43Z",
"is_tabletless": false
}
}
}
{
"event": "order.status_update",
"body": {
"order": {
"id": "gb:f2eb207a-2111-45f7-9008-cb561da4f45a",
"order_number": "29016206",
"location_id": "4163",
"display_id": "6206",
"status": "confirmed",
"status_log": [
{
"at": "2022-05-30T14:27:05Z",
"status": "pending"
},
{
"at": "2022-05-30T14:27:06Z",
"status": "placed"
},
{
"at": "2022-05-30T14:35:35.357663Z",
"status": "accepted"
},
{
"at": "2022-05-30T14:35:41.164652Z",
"status": "confirmed"
}
],
"fulfillment_type": "deliveroo",
"order_notes": "No pickles please.",
"cutlery_notes": "NO CUTLERY",
"asap": false,
"prepare_for": "2022-05-30T15:42:00Z",
"total_price": {
"fractional": 885,
"currency_code": "GBP"
},
"partner_order_total": {
"fractional": 885,
"currency_code": "GBP"
},
"offer_discount": {
"fractional": 0,
"currency_code": "GBP"
},
"cash_due": {
"fractional": 0,
"currency_code": "GBP"
},
"bag_fee": {
"fractional": 10,
"currency_code": "GBP"
},
"items": [
{
"pos_item_id": "4534.0",
"quantity": 1,
"name": "The Chicken Burger",
"operational_name": "The Chicken Burger (Wraps and Burgers)",
"unit_price": {
"fractional": 630,
"currency_code": "GBP"
},
"menu_unit_price": {
"fractional": 630,
"currency_code": "GBP"
},
"total_price": {
"fractional": 885,
"currency_code": "GBP"
},
"discount_amount": {
"fractional": 0,
"currency_code": "GBP"
},
"modifiers": [
{
"pos_item_id": "99.0",
"quantity": 1,
"name": "Fries - Salted",
"operational_name": "Fries - Salted",
"unit_price": {
"fractional": 255,
"currency_code": "GBP"
},
"total_price": {
"fractional": 255,
"currency_code": "GBP"
},
"discount_amount": {
"fractional": 0,
"currency_code": "GBP"
}
}
]
}
],
"start_preparing_at": "2022-05-30T15:26:00Z",
"confirm_at": "2022-05-30T14:56:43Z",
"is_tabletless": false
}
}
}
{
"event": "new_order",
"location_id": "5023",
"order": {
"id": "sg:0b6e5d74-54fc-4c20-84e4-ac42021c3986",
"display_id": "5905",
"total_price": {
"fractional": 3705,
"currency_code": "SGD"
},
"partner_order_total": {
"fractional": 3705,
"currency_code": "SGD"
},
"items": [
{
"pos_item_id": "3834-6161",
"unit_price": {
"fractional": 400,
"currency_code": "SGD"
},
"menu_unit_price": {
"fractional": 400,
"currency_code": "SGD"
},
"quantity": 1,
"modifiers": []
},
{
"pos_item_id": "16684-26341",
"unit_price": {
"fractional": 1605,
"currency_code": "SGD"
},
"menu_unit_price": {
"fractional": 1605,
"currency_code": "SGD"
},
"quantity": 1,
"modifiers": []
},
{
"pos_item_id": "2944-4903",
"unit_price": {
"fractional": 1700,
"currency_code": "SGD"
},
"menu_unit_price": {
"fractional": 1700,
"currency_code": "SGD"
},
"quantity": 1,
"modifiers": []
}
],
"asap": false,
"notes": "NO CUTLERY",
"start_preparing_at": "2021-08-06T08:01:21Z",
"fulfillment_type": "deliveroo",
"offer_discount": {
"amount": {
"fractional": 0,
"currency_code": "SGD"
}
},
"pickup_at": "2021-08-06T08:12:00Z"
},
"restaurant_acknowledged_at": "2021-08-06T05:22:13Z"
}
Updated almost 2 years ago