Just Eat

Just Eat UK

Just Eat API Just Eat offers services for our various business partners and our consumer applications. How you interact with the API depends on the services…

E-commerce#openapi#ecommerce

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Just Eat API

Just Eat offers services for our various business partners and our consumer applications.
How you interact with the API depends on the services you wish to interact with.

Security

HTTPS

All api calls and callbacks require HTTPS. Your service will need a valid SSL certificate and be accessible via the standard SSL port (port 443).

Making an API request

Some API calls require an API key, to authenticate the partner calling the API.

PUT https://uk-partnerapi.just-eat.io/orders/abcd1234 HTTP/1.1
Authorization: JE-API-KEY abcd123456789

Other calls require a user token in the form of a JWT.

GET https://uk.api.just-eat.io/consumer/me/orders/uk HTTP/1.1
Authorization: Bearer abcd123456789

Date Formats

Date and time formats

All dates and times should use the ISO 8601 standard for representation of dates and times.

For instance:

  • DueDateWithUtcOffset: "2015-05-26T14:52:35.5444292+01:00"
  • Local time: 14:52
  • UTC time: 13:52
  • UTC offset: +1hr (due to daylight time saving)
  • DueDateWithUtcOffset: "2015-02-03T11:10:00.0000000+00:00"
  • Local time: 11:10
  • UTC time: 11:10
  • UTC offset: 0 (no daylight time saving, local time is equivalent to UTC)

Note that the offset may be for a timezone different to your own, so you should alway convert to your own local time for display purposes (e.g. on receipts and terminals).

Callback timestamps

Timestamps sent to Just Eat should be recorded as the current local time (including any changes needed to account for daylight saving) with an accompanying offset that shows the difference between the recorded local time and the current UTC time.

If it is not possible to record timestamps in local time, timestamps may be recorded in UTC time with a 00:00 offset.

Async Webhooks

Some of the webhooks on the platform are configured as being 'async' webhooks. These are for long-running operations, and work as follows:

  1. Your webhook is invoked with a ?callback={returnUrl} query string parameter. The returnUrl is a unique URL that you will need to send the async response to.
  2. Return an immediate 202 Accepted response from the webhook endpoint, to indicate that you have received the request.
  3. Perform the long-running operation. This can be deemed either a _success_; or a _failure_.
  4. If the result is a _success_, return the following:
  POST {returnUrl} HTTP/1.1

  {
        "status": "Success",
        "message": "{successMessage}",
        "data": {}   // webhook-specific response object
  }
  1. Otherwise, if the result is a _failure_, return the following:
  POST {returnUrl} HTTP/1.1

  {
        "status": "Failure",
        "message": "{failureMessage}",
        "data": {}   // webhook-specific response object
  }

Endpoints 98

Order Acceptance Webhooks

  • POSTAcceptance requested/acceptance-requestedThis webhook will be invoked whenever acceptance has been requested for the order.
  • POSTOrder accepted/order-acceptedThis webhook will be invoked whenever the order was accepted.
  • POSTOrder cancelled/order-cancelledThis webhook will be invoked whenever the order was cancelled.
  • POSTOrder rejected/order-rejectedThis webhook will be invoked whenever the order was rejected.
  • PUTCustomer Requested Redelivery/redelivery-requestedThis webhook will be invoked whenever the customer responds to the attempted delivery notification.

Attempted Delivery Webhooks

  • PUTAttempted delivery query resolved/attempted-delivery-query-resolvedThis webhook will be invoked whenever an attempted delivery query has been resolved.
  • PUTDelivery Attempt Failed/delivery-failedThis webhook will be invoked whenever an attempted delivery event is created from the device.

Checkout

  • GETGet Checkout/checkout/:tenant/:checkoutIdGet 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…
  • PATCHUpdate Checkout/checkout/:tenant/:checkoutIdUpdate 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…
  • GETGet Available Fulfilment Times/checkout/:tenant/:checkoutId/fulfilment/availabletimesGets a collection of times for when an order can be fulfilled.

Consumers

  • GETGet consumers details/consumers/:tenant?emailAddress=string&accountType=registered&count=stringCurrently this operation only supports retrieving a count of consumer accounts given an email address.
  • POSTCreate consumer/consumers/:tenantCreates a consumer for the given tenant.
  • GETGet communication preferences/consumers/:tenant/me/communication-preferencesGet all communication preferences for a given consumer.
  • GETGet channel subscriptions for a given consumer's communication preference type/consumers/:tenant/me/communication-preferences/:typeGet channel subscriptions for a given consumer's communication preference type
  • PUTSet only the channel subscriptions for a given consumer's communication preference type/consumers/:tenant/me/communication-preferences/:typeSet only the channel subscriptions for a given consumer's communication preference type. E.g., An empty list of subscribed Channels implies unsubscribe from…
  • POSTSubscribe to a specific communication preference channel/consumers/:tenant/me/communication-preferences/:type/subscribedChannels/:channelSubscribe to a specific communication preference channel.
  • DELETERemove subscription of a specific communication preference channel/consumers/:tenant/me/communication-preferences/:type/subscribedChannels/:channelRemove subscription of a specific communication preference channel.

DeliveryFee

  • GETGet restaurant delivery fees/delivery-fees/:tenant?restaurantIds=1,2,3,4&deliveryTime=2019-09-05T12:43:48.431Z&zone=BS1&latlong=51.3851513,-2.0841275Retrieve delivery fees for many restaurants. Returns fees and minimum order values required for delivery orders.

Order Delivery API

  • GETGet delivery estimate/delivery/estimate?restaurantReference=string&toLat=string&toLon=string&toPostcode=stringDeprecated. Get delivery estimate
  • PUTUpdate current driver locations (bulk upload)/orders/deliverystate/driverlocationCurrent driver location (bulk upload)
  • PUTUpdate order with driver at delivery address details/orders/:orderId/deliverystate/atdeliveryaddress<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…
  • PUTUpdate order with driver at restaurant details/orders/:orderId/deliverystate/atrestaurantThe _at restaurant_ callback should be sent when the driver arrives at the restaurant and is ready to collect the order.
  • PUTUpdate the driver's estimated time to arrive at the Restaurant/orders/:orderId/deliverystate/atrestauranteta<p>In the UK, this endpoint updates the estimated arrival time at the restaurant. This value can be overridden from other endpoints like <a…
  • PUTUpdate order with delivered details/orders/:orderId/deliverystate/deliveredThe _delivered_ callback should be sent when the driver has handed the food to the customer and completed the order.
  • PUTUpdate order with driver assigned details/orders/:orderId/deliverystate/driverassignedThe _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…
  • PUTUpdate the driver's current location/orders/:orderId/deliverystate/driverlocation<p>Just Eat requires all delivery partners to send regular driver location callbacks, that record the GPS location of the drivers assigned to each…
  • PUTUpdate order with driver unassigned details/orders/:orderId/deliverystate/driverunassignedThe _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…
  • PUTUpdate order with driver on its way details/orders/:orderId/deliverystate/onitswayThe _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…

Delivery Pools API

  • GETGet your delivery pools/delivery/poolsA delivery pool is a named group of drivers which deliver food for a set of restaurants.
  • POSTCreate a new delivery pool/delivery/poolsA delivery pool is a named group of drivers which deliver food for a set of restaurants.
  • GETGet an individual delivery pool/delivery/pools/:deliveryPoolIdA delivery pool is a named group of drivers which deliver food for a set of restaurants.
  • PUTReplace an existing delivery pool/delivery/pools/:deliveryPoolIdReplace an existing delivery pool changing all of its properties
  • DELETEDelete a delivery pool/delivery/pools/:deliveryPoolIdThe restaurants will no longer be associated with the pool.
  • PATCHModify a delivery pool/delivery/pools/:deliveryPoolIdModify a delivery pool, changing its name, restaurants or both
  • GETGet availability for pickup/delivery/pools/:deliveryPoolId/availability/relativeGet the current amount of time it will take a driver to collect a new order from a restaurant in the pool.
  • PUTSet availability for pickup/delivery/pools/:deliveryPoolId/availability/relativeSet the average amount of time it will take a driver to collect a new order from a restaurant in the pool.
  • PUTSet the delivery pools daily start and end times/delivery/pools/:deliveryPoolId/hoursSet 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.…
  • PUTAdd restaurants to an existing delivery pool/delivery/pools/:deliveryPoolId/restaurantsAdd additional restaurants to a delivery pool
  • DELETERemove restaurants from a delivery pool/delivery/pools/:deliveryPoolId/restaurantsRemove restaurants from a delivery pool

Order Delivery Webhooks

  • PUTDriver Assigned to Delivery/driver-assigned-to-deliveryDriver Assigned to Delivery
  • PUTDriver at delivery address/driver-at-delivery-addressDriver at delivery address
  • PUTDriver at restaurant/driver-at-restaurantDriver at restaurant
  • PUTDriver has delivered order/driver-has-delivered-orderDriver has delivered order
  • PUTDriver Location/driver-locationDriver Location
  • PUTDriver on their way to delivery address/driver-on-their-way-to-delivery-addressDriver on their way to delivery address
  • PUTOrder ready for pickup/order-is-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…
  • PUTOrder requires delivery acceptance/order-requires-delivery-acceptanceThis webhook will be invoked when we have determined that an order is required acceptance for delivery. Upon receiving the request, the order should be…

Consumer Queries Webhooks

  • POSTlate order compensation query, restaurant response required/late-order-compensation-queryThis webhook will be invoked when a late order compensation query has been raised and a restaurant response is required.
  • POSTlate order query, restaurant response required/late-order-queryThis webhook will be invoked when a late order query has been raised and a restaurant response is required.

Restaurant Webhooks

  • POSTMenu ingestion complete/menu-ingestion-completeCallback to confirm that an attempt to ingest a menu has completed either successfully or unsuccessfully
  • POSTOrder time updated/order-time-updatedCallback to notify recipients that there has been a change to the restaurant order times for a given day and service type

RestaurantQueries Webhooks

  • POSTOrder Eligible For Restaurant Compensation/order-eligible-for-restaurant-compensationThis webhook will be invoked for every cancelled order and it will inform if the order is eligible for compensation.

Order Webhooks

  • POSTOrder ready for preparation (async)/order-ready-for-preparation-asyncThis webhook will be invoked when we have determined that an order is ready for preparation. Upon receiving the request, you should perform any…
  • POSTOrder ready for preparation (sync)/order-ready-for-preparation-syncThis webhook will be invoked when we have determined that an order is ready for preparation. Upon receiving the request, you should perform any…
  • POSTSend to POS failed/send-to-pos-failedThis 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,…

Order API

  • POSTCreate order/ordersCreate order

Order Acceptance API

  • PUTAccept order/orders/:orderId/acceptCall when an order has been accepted. An order can only be accepted if it hasn't previously been accepted, rejected, cancelled or ignored
  • PUTCancel order/orders/:orderId/cancelCall 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…
  • POSTComplete order/orders/:orderId/completeCall when an order is complete. An order can only be marked as complete if it hasn't already been marked as cancelled or complete.
  • PUTUpdate order ETA/orders/:orderId/duedateUse 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…
  • PUTIgnore order/orders/:orderId/ignoreCall 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
  • POSTMark order as ready for collection/orders/:orderId/readyforcollectionCall 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…
  • PUTReject order/orders/:orderId/rejectCall when an order has been rejected. An order can only be rejected if it hasn't previously been accepted, rejected, cancelled or ignored

ConsumerQueries

  • POSTResponse to Late Order Update Request/orders/:tenant/:orderId/consumerqueries/lateorder/restaurantresponseIf a customer has requested an update on the status of a late order, a response can be given by calling this endpoint.
  • POSTUpdate late order compensation request with Restaurant response/orders/:tenant/:orderId/consumerqueries/lateordercompensation/restaurantresponseIf a customer has requested compensation for a late order, a restaurant response is given by calling this endpoint.

RestaurantQueries

  • POSTCreate Compensation requests/orders/:tenant/:orderId/restaurantqueries/compensationWhen an order is cancelled the restaurant might be eligible for compensation, this endpoint allows a request for compensation to be created.

Restaurant Events Webhooks

  • PUTRestaurant Offline Status/restaurant-offline-statusCallback 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…
  • PUTRestaurant Online Status/restaurant-online-statusCallback to notify that a restaurant is now able to come back online as there are no longer any active offline Restaurant Events

Restaurants

  • GETGet restaurants by location/restaurants/bylatlong?latitude=0.0&longitude=0.0&cuisine=string&restaurantName=string&brandName=stringProvides details of all restaurants that deliver to the specified location
  • GETGet restaurants by postcode/restaurants/bypostcode/:postcode?cuisine=string&restaurantName=string&brandName=stringProvides details of restaurants that deliver to the specified postcode
  • PUTSet ETA for pickup/restaurants/driver/etaSet the average amount of time it will take a driver to collect a new order from a restaurant.
  • GETGet product catalogue/restaurants/:tenant/:restaurantId/catalogueGet details of the restaurant's product catalogue
  • GETGet all availabilities/restaurants/:tenant/:restaurantId/catalogue/availabilities?limit=0&after=stringGet all availabilities on the restaurant's menu
  • GETGet all categories/restaurants/:tenant/:restaurantId/catalogue/categories?limit=0&after=stringGet all categories on the restaurant's menu
  • GETGet all category item IDs/restaurants/:tenant/:restaurantId/catalogue/categories/:categoryId/items?limit=0&after=stringGet all item IDs which are assigned to the specified category
  • GETGet all menu items/restaurants/:tenant/:restaurantId/catalogue/items?limit=0&after=stringGet all menu items on the restaurant's menu
  • GETGet all menu item deal groups/restaurants/:tenant/:restaurantId/catalogue/items/:itemId/dealgroups?limit=0&after=stringGet all deal groups for the menu item with the provided ID
  • GETGet all deal item variations for a deal group/restaurants/:tenant/:restaurantId/catalogue/items/:itemId/dealgroups/:dealGroupId/dealitemvariations?limit=0&after=stringGet all deal item variations for the deal group with the specified ID, in the menu item with the specified ID
  • GETGet all menu item modifier groups/restaurants/:tenant/:restaurantId/catalogue/items/:itemId/modifiergroups?limit=0&after=stringGet all modifier groups for the menu item with the provided ID
  • GETGet all menu item variations/restaurants/:tenant/:restaurantId/catalogue/items/:itemId/variations?limit=0&after=stringGet all variations for the menu item with the provided ID
  • GETGet Restaurant Fees/restaurants/:tenant/:restaurantId/feesGet the fees currently applied to a restaurant in a particular tenant
  • PUTCreate or Update Restaurant Fees/restaurants/:tenant/:restaurantId/feesCreates or Updates the fees for a restaurant in a particular tenant
  • GETGet the latest version of the restaurant's full menu/restaurants/:tenant/:restaurantId/menuThe endpoint will return a 301 redirect containing a URL that will grant access to the Menu file. The URL will only be available for a short period of time.…
  • PUTCreate or update a menu/restaurants/:tenant/:restaurantId/menuThis will begin an asynchronous process that will lead to that menu becoming live on the Just Eat platform
  • GETGet service times/restaurants/:tenant/:restaurantId/servicetimesGets the service times (the weekly times at which a restaurant is in service for delivery or collection) for a restaurant
  • PUTCreate or update service times/restaurants/:tenant/:restaurantId/servicetimesCreates or updates the service times (the weekly times at which a restaurant is in service for delivery or collection) for a restaurant

Restaurant Claims

  • GETGet claims/restaurants/:tenant/:restaurantId/customerclaims?fromDate=2024-01-01T00:00:00Z&toDate=2024-01-01T00:00:00Z&limit=20&offset=0Provides claims for a given restaurant with optional filtering
  • GETGet order claim/restaurants/:tenant/:restaurantId/customerclaims/:idGet information about a order claim
  • POSTSubmit a restaurant response for the claim/restaurants/:tenant/:restaurantId/customerclaims/:id/restaurantresponseSubmit a restaurant response for the claim, where the restaurant can tell us if they accept or reject the claim
  • PUTAdd reason and comments to the response/restaurants/:tenant/:restaurantId/customerclaims/:id/restaurantresponse/justificationAdd reason and optional comments in case of rejection of order claim

publicly-accessible

  • GETGet the restaurant's delivery and collection lead times/restaurants/:tenant/:restaurantId/ordertimesGet list of the delivery and collection lead times supplied by the restaurant
  • PUTUpdate the restaurant's delivery and collection lead times/restaurants/:tenant/:restaurantId/ordertimes/:dayOfWeek/:serviceTypeUpdate the restaurant's delivery and collection lead times

Search

  • GETGet auto-completed search terms/search/autocomplete/:tenant?searchTerm=string&latlong=51.501285,-0.1424422&limit=0.0Provides auto-completed search terms for restaurants, cuisines and products available in a given location.
  • GETSearch restaurants/search/restaurants/:tenant?searchTerm=string&latlong=51.501285,-0.1424422&limit=0.0Get restaurants available in a given lat-long which match a search term. Matches can be found against the name, a cuisine or a product.

Restaurant Events

  • POSTCreate Offline Event/v1/:tenant/restaurants/event/offlineCreates an event for the specified restaurants that indicates a reason for those restaurants to be offline.
  • DELETEDelete Offline Event/v1/:tenant/restaurants/:id/event/offlineRemoves specified restaurant from offline events. If role header is System or Operations only events created by the specified role will be affected. If role…

Attempted Delivery API

  • POSTDelivery Attempt Failed/:tenant/orders/:orderId/queries/attempteddeliveryIf the customer hasn't answered the door to collect the order, then an attempted delivery event can be created using this endpoint.
  • POSTRequest Redelivery of the Order/:tenant/orders/:orderId/queries/attempteddelivery/resolution/redeliverorderIf the customer responds, then you can trigger the redelivery of an order through this endpoint

API details

Base URL
https://uk.api.just-eat.io
https://i18n.api.just-eat.io
https://aus.api.just-eat.io
Authentication
A bearer token in the Authorization header
An API key in the Authorization header
HTTP Basic authentication (username and password)
OpenID Connect
A bearer token in the Authorization header
Operations
98 operations on 85 pathsPUT 38GET 29POST 25DELETE 4PATCH 2
1 marked deprecated
Main resources
publicly-accessible 98Restaurants 18Delivery Pools API 11Order Delivery API 10Order Delivery Webhooks 8Consumers 7Order Acceptance API 7Order Acceptance Webhooks 5Restaurant Claims 4Checkout 3
Response formats
application/json text/plain
Description format
OpenAPI 3.0.0, API version 1.0.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Just Eat UK in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Just Eat UK collection, without the publisher's secrets.
  3. Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Acceptance requested” (POST /acceptance-requested), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Just Eat UK?

Just Eat API Just Eat offers services for our various business partners and our consumer applications. How you interact with the API depends on the services… It is listed under E-commerce and has 98 endpoints.

Who publishes the Just Eat UK?

It is listed from Just Eat's public API description (an OpenAPI document), not published by Just Eat on Swastik Codes. Anyone who controls just-eat.co.uk can claim the profile by adding a DNS TXT record.

What is the base URL of the Just Eat UK?

Its description lists 3 base URLs: https://uk.api.just-eat.io, https://i18n.api.just-eat.io, https://aus.api.just-eat.io. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the Just Eat UK?

It accepts 5 methods: A bearer token in the Authorization header; an API key in the Authorization header; HTTP Basic authentication (username and password); OpenID Connect; A bearer token in the Authorization header.

How many endpoints does the Just Eat UK have?

98 operations on 85 paths (38 PUT, 29 GET, 25 POST, 4 DELETE, 2 PATCH). The largest groups are publicly-accessible, Restaurants, Delivery Pools API, Order Delivery API.

Is forking the Just Eat UK free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.