Jump to Content
deliveroo
GuidesAPI DocumentationRelease Notes
Log Indeliveroo
API Documentation
Log In
GuidesAPI DocumentationRelease Notes

Authentication

  • Exchange credentials
    • Credential Types
    • Get access token.post

Orders API

  • Webhooks
    • Order Events Webhook Callbackpost
    • Rider Events Webhook Callbackpost
    • POS Webhook - New Orderpost
    • POS Webhook - Cancel Orderpost
  • Endpoints V1
    • Create Sync Status for an Orderpost
    • Create Preparation Stage for an Orderpost
    • Update Order Statuspatch
    • Get Single Order Detailsget
    • Get Ordersget
    • Get Integrator's Order Events Webhook Configurationget
    • Change Integrator's Order Events Webhook Configurationput
    • Get Integrator's Rider Events Webhook configurationget
    • Change Integrator's Rider Events Webhook configurationput
    • Get Integrator's Sites Webhooks Configurationget
    • Change Integrator's Sites Webhooks Configurationput
  • Endpoints V2
    • Get Single Order Detailsget
    • Get Ordersget

Menu API

  • v1 (recommended)
    • Get menuget
    • Upload menuput
    • Update PLU (Price Look-Up) to Menu Item mappingpost
    • Replace All Menu Item Unavailabilitiesput
    • Update Individual Menu Item unavailabilitiespost
    • Get Menu Item unavailabilitiesget
  • v2 (for menus created by Menu Manager)
    • Get menuget
    • Replace All Menu Item Unavailabilitiesput
    • Update individual Menu Item unavailabilitiespost
    • Get Menu Item unavailabilitiesget
  • 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
    • Get a site days off periodget
    • Update a site days off periodput
    • Cancel a site days off perioddelete
    • Add a new site days offpost
    • Get site days offget
  • 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
    • Start picking process for orderput
    • Accept orderput
    • Reject orderput
    • Allows the partner to make amendments to order items.post
    • Get allowed item substitutions.get
    • Fetch active ordersget
  • Webhook URL Configuration
    • Retrieve Picking API webhook configuration for a brandget
    • Configure Picking API webhook for a brandput
    • Retrieve Picking API webhook configuration (Integrator)get
    • Configure Picking API webhook (Integrator)put
    • Picking API webhook receiver examplepost
  • Endpoints V2
    • Update order items quantityput

Developer Portal API

  • Introduction
  • Scenarios
    • Get all scenariosget
    • Get a scenario by IDget
    • Trigger a scenario run by scenario IDpost
    • Get runs of a scenarioget
    • Get a scenario run by IDget

Signature API

  • Introduction
  • Webhooks
    • Order Status Callbackpost
    • Order Refund Callbackpost
    • Order Credit Callbackpost
    • Order Redelivery Callbackpost
    • Rider Status Callbackpost
  • v1
    • Create a new orderpost
    • Get information about an orderget
    • Get order locationget
    • Create quotepost
    • Get restaurants for locationget
    • List registered webhooksget
    • Register webhookspost
    • Submit a refund notification for an orderpost
  • v2
    • Create a new orderpost
    • Get order locationget

Deliveroo Express API

  • v1
    • Create quotepost
    • Get quoteget
    • Update quotepatch
    • Get deliveries by latitude and longitudeget
    • Schedule deliverypost
    • Get deliveryget
    • Cancel deliverydelete
    • Get Availabilityget

OpenAPI specification

  • OpenAPI specification

OpenAPI specification

You can find the full specification here: https://api-docs.deliveroo.com/openapi.