Jump to Content

Guides API Documentation Release Notes

API Documentation

Guides API Documentation Release Notes

Authentication

Exchange credentials
- Credential Types
- Get access token.post

Orders API

Webhooks
Endpoints V1
Endpoints V2
- Get Single Order Detailsget
- Get Ordersget

Menu API

v1 (recommended)
v2 (for menus created by Menu Manager)
Webhooks
- Menu Webhook Callbackpost
Webhook Management
- Get Integrator's Menu Events Webhookget
- Change Integrator's Menu Events Webhookput

Catalogue API

Catalogue Upload
- Catalogue Uploadpost
Upload URL (from catalogue upload response)
- Upload URL (from catalogue upload response)put
Get Catalogue
- Get Catalogueget
Update Listings
- Update Listingsput
Update Unavailabilities
- Update Unavailabilitiespatch
Get Unavailabilities
- Get Unavailabilitiesget
Webhooks
- Upload Catalogue Webhookpost
- Update Catalogue Listing Webhookpost

Site API

Introduction
Status
- Get site statusget
- Update site statusput
Days Off
Opening Hours
- Get site opening Hoursget
- Update site opening hourspost
Time Zone
- Get site time zoneget
Listing
- Get sites for a brandget
Workload Mode
- Get site workload modeget
- Set site workload modeput
Workload Times
- Get site workload timesget
- Set site workload timesput
Brand ID
- Get Site Brand IDget
Brands
- Get list of brandsget

Picking API

Endpoints V1
Webhook URL Configuration
Endpoints V2
- Update order items quantityput

Developer Portal API

Introduction
Scenarios

Signature API

Introduction
Webhooks
v1
v2
- Create a new orderpost
- Get order locationget

Deliveroo Express API

v1

OpenAPI specification

OpenAPI specification

Get a scenario run by ID

get https://api-sandbox.developers.deliveroo.com/dev-portal/scenarios/{id}/runs/{run_id}

Language

Credentials

OAuth2

Bearer