Get Orders

get https://api.developers.deliveroo.com/order/v2/brand/{brand_id}/restaurant/{restaurant_id}/orders

Return a list of up to 100 orders for a given restaurant within a given timeframe.

Deliveroo would not return order data older than 30 days.

There are several ways to make the GET request by timeframe.

Example GET requests:

GET api/v2/brand/{brand_id}/restaurant/{restaurant_id}/orders?start_date=2018-12-11T00:00:00Z

See all orders on and after a certain date. This example would show all orders on and after 11 December 2018.

GET api/v2/brand/{brand_id}/restaurant/{restaurant_id}/orders?start_date=2018-12-11T00:00:00Z&end_date=2018-12-13T23:59:00Z

See all orders between start date and end date. This example would show all orders from the beginning of 11 December 2018 to the end of 13 December 2018.

GET api/v2/brand/{brand_id}/restaurant/{restaurant_id}/orders?cursor=eyJzdGFydF9kYXRlIjoiMjAxOC0xMi0xMVQwMDowMDowMCIsImVuZF9kYXRlIjoiMjAxOC0xMi0xMlQwMDowMDowMCIsIm1pbl9vcmRlcl9pZCI6IjA3ZmJiODJhLWNlYjUtNDNlYy0xMjNmLTE4YWY4OWUzMzgwYSJ9

See all order after the previous call, cursor will be returned as next in response if there are more than 100 orders in a window.

This endpoint is rate limited at 5 request per minute per restaurant.

Responses

Response body

object

orders

array of objects

orders

object

string

Unique ID of the order.

order_number

string

Deliveroo's complete order ID. This field will be deprecated in future. It is a String field and shouldn't be parsed as numeric. It contains string values of unsigned int64.

location_id

string

The in-store system location ID.

brand_id

string

The unique identifier for the brand.

display_id

string

The ID we give to the site/rider/customer to easily identify the order.

status

string

Current status of the order. Can be placed, accepted, confirmed (for scheduled orders), rejected or canceled.

pending placed accepted confirmed rejected canceled

status_log

array of objects

List of all statuses of the order with status type and time of occurrence.

Status Log

object

string

Date and time in the ISO-8601 format when the order event changed.

status

string

Status of the order. Can be pending, placed, accepted, confirmed (for scheduled orders), rejected or canceled.

pending placed accepted confirmed rejected canceled

fulfillment_type

string

Who will be collecting the order. Can be deliveroo, restaurant, customer, table_service.

deliveroo restaurant customer table_service

order_notes

string

Order notes from the customer.

cutlery_notes

string

Cutlery notes from the customer.

asap

boolean

False if the order is scheduled for a later time or the next day.

prepare_for

string

Date and time in the ISO-8601 format when the site should have the order prepared for rider to pickup.

table_number

string

Number of customer's table. Only applies to Table Service orders.

subtotal

object

Subtotal of items, excluding fees and discounts.

delivery

object

Details of the delivery.

total_price

object

Total price for the order (including fees and discounts deducted). For Deliveroo fulfilled orders, fees = restaurant tip + item fees. For Restaurant fulfilled orders, fees = delivery fee + restaurant tip + item fees and surcharge.

partner_order_subtotal

object

The subtotal of the order after substitutions, excluding fees and discounts. I.e. the total price of menu_unit_price items and their modifiers.

partner_order_total

object

The total of the order after substitutions, including fees and discounts. I.e. the total price of menu_unit_price items and their modifiers. For Deliveroo fulfilled orders, fees = restaurant tip + item fees. For Restaurant fulfilled orders, fees = delivery fee + restaurant tip + item fees and surcharge.

offer_discount

object

Discount to be applied to the total price of the order (value).

cash_due

object

The amount the customer needs to pay in cash when the delivery arrives.

bag_fee

object

The amount for the bag fee that customer needs to pay.

surcharge

object

The fee that makes up the difference if the total price is below the minimum order value.

fee_breakdown

array of objects

This contains a list of individual fee descriptions.

Provides the values of individual types of fee.

object

type

string

The value of the item fee type represent type of fees applied (e.g. DEPOSIT_FEE).

DEPOSIT_FEE

amount

object

items

array of objects

An array of the Items in the order.

Items

object

pos_item_id

string

The ID of the item in the in-store system. Value can also be null. If null, this will generate an unknown_pos_item_id_error field in the order payload as well.

unit_price

object

Price per unit.

menu_unit_price

object

Price per unit according to the menu (can be different from Unit Price in case of more expensive substitutions, for example)

quantity

integer

The quantity ordered.

item_fees

array of objects

item_fees

object

type

string

The value of the item fee type represent type of fees applied (e.g. DEPOSIT_FEE).

DEPOSIT_FEE

cost_per_unit

object

modifiers

array of objects

Predefined preparation instructions that must be communicated to kitchen as well as food or drink items that might accompany a menu item, e.g. No tomato. You can have recursively modifiers of modifiers.

Modifiers

object

pos_item_id

string

The ID of the item in the in-store system. Value can also be null. If null, this will generate an unknown_pos_item_id_error field in the order payload as well.

quantity

integer

The item's quantity.

name

string

Name of the item.

operational_name

string

Operational name the site uses in-house for the item.

unit_price

object

Price per unit.

menu_unit_price

object

Price per unit according to the menu (can be different from Unit Price in case of more expensive substitutions, for example)

total_price

object

Total price for the item & modifiers (without discounts).

discount_amount

object

The discounted amount applied.

item_fees

array of objects

item_fees

object

type

string

The value of the item fee type represent type of fees applied (e.g. DEPOSIT_FEE).

DEPOSIT_FEE

cost_per_unit

object

discount_amount

object

The discounted amount applied.

start_preparing_at

string

Date and time in the ISO-8601 format when the site should start preparing the order.

confirm_at

string

Date and time in the ISO-8601 format for when the site should confirm scheduled orders by. May still be NULL for scheduled orders, if the order is placed close to the scheduled delivery time (and the site must start preparing immediately). Only applies to scheduled order type.

promotions

array of objects

Contains the promotions associated with the order. If the order does not have a promotion applied then this section is not in payload.

Promotions

object

string

Unique ID of the promotion.

type

string

The type of promotion applied to the offer. It can be percentage_off_on_items or percentage_off_on_basket.

percentage_off_on_items percentage_off_on_basket

value

integer

A integer representing the percentage of discount applied to the order.

amount

object

bundle_amount

object

Myltibuy offer amount value

quantity

integer

Number of items in the bundle

pos_item_ids

array of objects

A list of items in the order affected by the promotion.

In-Store System Item IDs

object

string

The ID of the item in the in-store system.

remake_details

object

Details related to parent order.

is_tabletless

boolean

Flags if site is using tablet or not.

prep_stages

array of objects

prep_stages

object

stage

string

One of the possible preparation stage:

in_kitchen (Cooking has started)
ready_for_collection_soon (Food is a maximum of 60s from being ready to collect)
ready_for_collection (Food is cooked and packaged)
collected (The order has been collected)

in_kitchen ready_for_collection ready_for_collection_soon collected

occurred_at

string

The date/time (ISO-8601) the event occurred in UTC. Value must be

within 1 hour in past from current UTC date/time
within 5 minutes in future from current UTC date/time
e.g. if current date/time is 15:00 occurred_at must be between 14:00 and 15:05

delay

uint64

Optional requested delay to prep time. Value must be either 0, 2, 4, 6, 8 or 10.
Any requested delay should be used with the in_kitchen prep stage.

uint64

meal_cards

array of objects

meal_cards

object

provider

string

Meal card provider used in order. Please mind that the list is not conclusive.

EDENRED SODEXO APETIZ SWILE UP

amount

int64

Amount for order paid via meal card. Represented in the fractional or subunit of the currency (e.g. pence, cents).

customer

object

string

Cursor for the next page if there are more than 100 orders

Language

Credentials

OAuth2

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.developers.deliveroo.com/order/v2/brand/brand_id/restaurant/restaurant_id/orders \
3
     --header 'accept: application/json'

Choose an example:

application/json

200Successfully returning orders.

400The request didn't work, often because a required parameter is missing or the content-type hasn't been set e.g. an incorrect JSON request

500Something went wrong on our end. You'll have to try again later once we've fixed it.