Introduction

The Deliveroo Site API provides developers the ability to manage sites' information.

This API consists in the following components:

Opening hours: A developer can use this feature to view or define a site opening hours. Multiple opening hours can be applied for each weekday.

Status: A developer can set the online status of a site to be open or closed.

Days off: A developer can add, retrieve, update or cancel days off periods for a given site. Days off are exceptions to the normal opening hours of a site that are applied each day.

Workload A developer can change workload mode as well as set the preparation time for each mode.

API path

All site API endpoints that controls site details are located under the following path
/api/v1/brands/{brandId}/sites/{siteId}

Path parameters

A list of all brands can be retrieved at GET /api/v1/brands

Get site opening hours response body example:

{
    "brands": [
        {
            "id": "brandunique-id",
            "name": "name",
            "market": "GB"
        }
    ]
}

Errors

The site API uses the following HTTP status codes for errors.

Errors return JSON structured like this, where message may contain more
specific information:

{
  "error": {
    "code": "bad_request",
    "message": "invalid date format"
  }
}

Additionally, the returned JSON error will contain additional details for
developers in the message, as well as a specific error code.