← Back to catalog

E-commerce

Just Eat UK

auto-generated
swirls add just_eat …
actionPUTv1.0.0

Accept order

Call when an order has been accepted. An order can only be accepted if it hasn't previously been accepted, rejected, cancelled or ignored

Source
actionPOSTv1.0.0

Acceptance requested

This webhook will be invoked whenever acceptance has been requested for the order.

Source
actionPUTv1.0.0

Attempted delivery query resolved

This webhook will be invoked whenever an attempted delivery query has been resolved.

Source
actionPUTv1.0.0

Cancel order

Call when an order has been cancelled by Ops. Cancelling an order overrides any previous accept/reject calls. This should not be used for restaurant rejection but only from Ops involvement

Source
actionPOSTv1.0.0

Complete order

Call when an order is complete. An order can only be marked as complete if it hasn't already been marked as cancelled or complete.

Source
actionPOSTv1.0.0

Create a new delivery pool

A delivery pool is a named group of drivers which deliver food for a set of restaurants.

Source
actionPOSTv1.0.0

Create Compensation requests

When an order is cancelled the restaurant might be eligible for compensation, this endpoint allows a request for compensation to be created.

Source
actionPOSTv1.0.0

Create consumer

Creates a consumer for the given tenant.

Source
actionPOSTv1.0.0

Create Offline Event

Creates an event for the specified restaurants that indicates a reason for those restaurants to be offline.

Source
actionPUTv1.0.0

Create or update a menu

This will begin an asynchronous process that will lead to that menu becoming live on the Just Eat platform

Source
actionPUTv1.0.0

Create or update service times

Creates or updates the service times (the weekly times at which a restaurant is in service for delivery or collection) for a restaurant

Source
actionPUTv1.0.0

Customer Requested Redelivery

This webhook will be invoked whenever the customer responds to the attempted delivery notification.

Source
actionDELETEv1.0.0

Delete a delivery pool

The restaurants will no longer be associated with the pool.

Source
actionDELETEv1.0.0

Delete Offline Event

Removes specified restaurant from offline events. If role header is `System` or `Operations` only events created by the specified role will be affected. If role header is `Restaurant` then all events that have `allowRestaurantOverride=true` will be affected.

Source
actionPOSTv1.0.0

Delivery Attempt Failed

If the customer hasn't answered the door to collect the order, then an attempted delivery event can be created using this endpoint.

Source
actionPUTv1.0.0

Delivery Attempt Failed

This webhook will be invoked whenever an attempted delivery event is created from the device.

Source
actionGETv1.0.0

Get all availabilities

Get all availabilities on the restaurant's menu

Source
actionGETv1.0.0

Get all categories

Get all categories on the restaurant's menu

Source
actionGETv1.0.0

Get all category item IDs

Get all item IDs which are assigned to the specified category

Source
actionGETv1.0.0

Get all menu item deal groups

Get all deal groups for the menu item with the provided ID

Source
actionGETv1.0.0

Get all menu item modifier groups

Get all modifier groups for the menu item with the provided ID

Source
actionGETv1.0.0

Get all menu item variations

Get all variations for the menu item with the provided ID

Source
actionGETv1.0.0

Get all menu items

Get all menu items on the restaurant's menu

Source
actionGETv1.0.0

Get an individual delivery pool

A delivery pool is a named group of drivers which deliver food for a set of restaurants.

Source
actionGETv1.0.0

Get auto-completed search terms

Provides auto-completed search terms for restaurants, cuisines and products available in a given location.

Source
actionGETv1.0.0

Get availability for pickup

Get the current amount of time it will take a driver to collect a new order from a restaurant in the pool.

Source
actionGETv1.0.0

Get Available Fulfilment Times

Gets a collection of times for when an order can be fulfilled.

Source
actionGETv1.0.0

Get Checkout

Get the details required to fulfil an order, which includes: - The restaurant selling the items to be purchased - The customer making the purchase - How, where and when the items will be received by the customer - Instructions about the order

Source
actionGETv1.0.0

Get claims

Provides claims for a given restaurant with optional filtering

Source
actionGETv1.0.0

Get consumers details

Currently this operation only supports retrieving a count of consumer accounts given an email address.

Source
actionGETv1.0.0

Get order claim

Get information about a order claim

Source
actionGETv1.0.0

Get product catalogue

Get details of the restaurant's product catalogue

Source
actionGETv1.0.0

Get restaurant delivery fees

Retrieve delivery fees for many restaurants. Returns fees and minimum order values required for delivery orders.

Source
actionGETv1.0.0

Get Restaurant Fees

Get the fees currently applied to a restaurant in a particular tenant

Source
actionGETv1.0.0

Get service times

Gets the service times (the weekly times at which a restaurant is in service for delivery or collection) for a restaurant

Source
actionGETv1.0.0

Get your delivery pools

A delivery pool is a named group of drivers which deliver food for a set of restaurants.

Source
actionPUTv1.0.0

Ignore order

Call when an order has been ignored by restaurant. An order can only be ignored if it hasn't previously been accepted, rejected, cancelled or ignored

Source
actionPOSTv1.0.0

Mark order as ready for collection

Call when a collection order is ready to be collected by the customer. An order can only be marked as ready for collection if it is a collection order in the accepted state.

Source
actionPOSTv1.0.0

Menu ingestion complete

Callback to confirm that an attempt to ingest a menu has completed either successfully or unsuccessfully

Source
actionPATCHv1.0.0

Modify a delivery pool

Modify a delivery pool, changing its name, restaurants or both

Source
actionPOSTv1.0.0

Order accepted

This webhook will be invoked whenever the order was accepted.

Source
actionPOSTv1.0.0

Order cancelled

This webhook will be invoked whenever the order was cancelled.

Source
actionPOSTv1.0.0

Order Eligible For Restaurant Compensation

This webhook will be invoked for every cancelled order and it will inform if the order is eligible for compensation.

Source
actionPUTv1.0.0

Order ready for pickup

<p>The "Ready for pickup" event lets the delivery partner know that the food has been cooked and is now ready for collection up from the restaurant.</p><p>When this event is received, it is important that you let your driver know that the order should now be collected from inside the restaurant. For example, this driver notification could take the form of an in-app notification or an SMS message.</p><p>This communication is needed to support restaurants who are unable to accommodate drivers inside their premises, as it allows restaurants to notify drivers waiting outside that they should come inside to collect their order.</p><p>NB&semi; This event can be sent by the restaurant at any point after the order is accepted by the restaurant (for instance, this event may be sent before the driver has arrived at the restaurant).</p>

Source
actionPOSTv1.0.0

Order ready for preparation (async)

This webhook will be invoked when we have determined that an order is ready for preparation. Upon receiving the request, you should perform any preparation-related activities, such as sending the order to the POS system / kitchen screen. **NOTE:** This version of the webhook is asynchronous, and we expect a response in two parts: 1. We expect an immediate `202` response from this webhook to denote that you have received the request; 2. Following that, we expect an [async callback](#section/Async-Webhooks) - indicating either success or failure of the operation. The body for the async callbacks are as below: **Success callback** ``` { "status": "Success", "message": "Order successfully sent to POS", "data": {} } ``` **Failure callback** ``` { "status": "Failure", "message": "{errorMessage}", // e.g. "The POS is currently in use" "data": {} } ```

Source
actionPOSTv1.0.0

Order ready for preparation (sync)

This webhook will be invoked when we have determined that an order is ready for preparation. Upon receiving the request, you should perform any preparation-related activities, such as sending the order to the POS system / kitchen screen.

Source
actionPOSTv1.0.0

Order rejected

This webhook will be invoked whenever the order was rejected.

Source
actionPUTv1.0.0

Order requires delivery acceptance

This webhook will be invoked when we have determined that an order is required acceptance for delivery. Upon receiving the request, the order should be scheduled for pickup by a courier/driver. We expect an immediate `201` response from this webhook to denote that you have received the request.

Source
actionPOSTv1.0.0

Order time updated

Callback to notify recipients that there has been a change to the restaurant order times for a given day and service type

Source
actionPUTv1.0.0

Reject order

Call when an order has been rejected. An order can only be rejected if it hasn't previously been accepted, rejected, cancelled or ignored

Source
actionPOSTv1.0.0

Request Redelivery of the Order

If the customer responds, then you can trigger the redelivery of an order through this endpoint

Source
actionPOSTv1.0.0

Response to Late Order Update Request

If a customer has requested an update on the status of a late order, a response can be given by calling this endpoint.

Source
actionPUTv1.0.0

Restaurant Offline Status

Callback to notify that a restaurant has been taken offline through an active Restaurant Event or there's been a change in whether the restaurant can override a previous offline status.

Source
actionPUTv1.0.0

Restaurant Online Status

Callback to notify that a restaurant is now able to come back online as there are no longer any active offline Restaurant Events

Source
actionGETv1.0.0

Search restaurants

Get restaurants available in a given lat-long which match a search term. Matches can be found against the name, a cuisine or a product.

Source
actionPOSTv1.0.0

Send to POS failed

This webhook will be invoked if we experience an error or timeout in sending an order to the underlying POS / kitchen screen. When notified via this webhook, typically you will perform some form of alerting or backup flow (e.g. ask the operator to enter the order manually into the POS). NOTE: This message contains the `OrderId`, but not the full order. It is assumed that you have stored/cached the full order details earlier in the flow - e.g. via the [/order-ready-for-preparation](#/paths/~1order-ready-for-preparation-sync/post) webhook.

Source
actionPUTv1.0.0

Set availability for pickup

Set the average amount of time it will take a driver to collect a new order from a restaurant in the pool.

Source
actionPUTv1.0.0

Set ETA for pickup

Set the average amount of time it will take a driver to collect a new order from a restaurant.

Source
actionPUTv1.0.0

Set the delivery pools daily start and end times

Set the daily start and end times for a pool or set closed flag if the pool does not operate on that day. Start and end times for all days must be provided. Though the API accepts array of start and end times for each day, multiple start and end time for a day are not accepted. If the end time for a day is equal to or before start time, end time will be considered as time for the next day.

Source
actionPOSTv1.0.0

Submit a restaurant response for the claim

Submit a restaurant response for the claim, where the restaurant can tell us if they accept or reject the claim

Source
actionPATCHv1.0.0

Update Checkout

Update the details required to fulfil an order, which includes: - The customer making the purchase - Where and when the items will be received by the customer - Instructions about the order

Source
actionPUTv1.0.0

Update order ETA

Use this to update the estimated time of arrival for an order (i.e. when you expect the customer to receive the food). NOTE: An initial estimate is given [upon acceptance](#/paths/~1orders~1{orderId}~1accept/put). This endpoint can be used to update that estimate.

Source
actionPUTv1.0.0

Update order with delivered details

The _delivered_ callback should be sent when the driver has handed the food to the customer and completed the order.

Source
actionPUTv1.0.0

Update order with driver assigned details

The _driver assigned_ callback should be sent when a driver is assigned to the order. It should communicate important details about the driver - and also an estimated time for the driver to arrive at the restaurant and delivery address.

Source
actionPUTv1.0.0

Update order with driver at delivery address details

<p>The _at delivery address_ callback should be sent when the driver thinks that they have arrived at the specified delivery address.</p><p>NB&semi; This callback should be distinct from the delivered callback, as Just Eat use this callback to understand how much time is spent locating the customer's address.</p>

Source
actionPUTv1.0.0

Update order with driver on its way details

The _on its way_ callback should be sent when the driver departs the restaurant with the customer's order. It should contain an ETA that records when the driver expects to arrive at the customer's address.

Source
actionPUTv1.0.0

Update order with driver unassigned details

The _driver unassigned_ callback should be sent when a driver is unassigned from the order. It may details about the reason for cancelling the assignment, the driver details, and any newer at restaurant and customer estimations.

Source
actionPUTv1.0.0

Update the driver's current location

<p>Just Eat requires all delivery partners to send regular driver location callbacks, that record the GPS location of the drivers assigned to each order</p><p>Partners should aim to supply this callback approximately every 10 seconds.</p><p>Please provide an up-to-date ETA for when the driver will reach the restaurant in this request - this value is significant since it informs when a restaurant is instructed to start preparing food - when the time remaining between current time and the estimated time of arrival becomes less than the restaurant's configured preparation time, food preparation is initiated</p><p>Note that at restaurant Eta provided in this request will NOT override any ETA set in the Driver At Restaurant Eta request</p>

Source
actionPUTv1.0.0

Update the driver's estimated time to arrive at the Restaurant

<p>In the UK, this endpoint updates the estimated arrival time at the restaurant. This value can be overridden from other endpoints like <a href="https://uk.api.just-eat.io/docs#tag/Order-Delivery-API/paths/~1orders~1{orderId}~1deliverystate~1driverlocation/put">Driver Locations</a> </p> <p> This endpoint should be used to set initial at restaurant ETAs prior to driver assignment where available. The earlier a delivery partner is able to provide an estimate of when the driver will arrive at the restaurant the more likely it is that driver arrival and order preparation will be aligned. </p> <p> In other tenants (Not UK):Note that if set for a given order, this Eta will NOT be overridden by any other at restaurant ETAs provided in `DriverAssigned` or `DriverLocation` requests</p> <p>This value is significant since it informs when a restaurant is instructed to start preparing food. When the time remaining between current time and the estimated time of arrival becomes less than the restaurant's configured preparation time, food preparation is initiated</p>

Source
Beyond the catalog

Any provider, on request.

01

Request it

Tell us which provider you need, and we will ship it in the registry.

02

Generate it

Point swirls add at an OpenAPI or GraphQL spec. Typed actions for any API you hold credentials for, today.

Request a providerRead the actions docs
acme · integrations
terminal
~/acme $swirls add linear
✓ 12 typed actions · scopes and schemas included
 
~/acme $swirls add https://api.acme.dev/openapi.json
◆ Fetched spec · 38 operations
✓ 6 typed actions · generated from spec