foodticket/deliveroo

A PHP client to integrate with the Deliveroo API

v0.0.12 2025-01-06 15:39 UTC

Requires

• php: ^8.3
• illuminate/http: ^11.0
• illuminate/support: ^11.0

Requires (Dev)

• orchestra/testbench: ^6.0

MIT

• Foodticket
• Rik

• php
• delivery
• api client
• deliveroo
• foodticket

README

This package allows you to easily make requests to the new Deliveroo API. The full documentation of the Deliveroo API can be found here: https://api-docs.deliveroo.com/v2.0/reference/credentials.

Requirements

• PHP >= 8.3
• Laravel >= 11.0

Installation

You can install the package via composer:

composer require foodticket/deliveroo

The package will automatically register itself.

Configuration

To start using the Deliveroo API you will need a client ID and client secret. You can get these by creating an app on the Deliveroo Developer Portal. Add the Client ID and client secret to your .env file:

DELIVEROO_BASE_URL=
DELIVEROO_AUTH_URL=
DELIVEROO_CLIENT_ID=
DELIVEROO_CLIENT_SECRET=
DELIVEROO_WEBHOOK_SECRET=

Making requests

Getting orders

To get all orders from a restaurant, you can use the following code:

$deliverooApi = new DeliverooApi();
$deliverooApi->getOrders($brandId, $restaurantId);

Create your own request

If you need to create your own request, you can use the following code:

$deliverooApi = new DeliverooApi();
$deliverooApi->request()->get('https://api.developers.deliveroo.com/order/v1/integrator/brands/{$brand_id}/sites-config');

Webhooks

To start receiving webhooks from Deliveroo, you need to add the following route the App\Providers\RouteServiceProvider file:

$this->routes(function () {
    // ...
    Route::deliverooWebhooks();
});

Security Vulnerabilities

If you discover a security vulnerability within this project, please email me via [e-mail].