<aside> 💡 This API has been superseded by Menus Version 2 and will be decommissioned by December 2022. You should only be using this API if you have already integrated your POS or 3PA with the Flyt Platform. If you are developing a new integration, please use Menus Version 2 instead.

</aside>

How it works

The Flyt Platform API allows anyone with a Just Eat, Skip The Dishes, Menulog or Takeaway account to automatically publish menus from their POS to the respective delivery partner. For this to work, client applications need to:

Extract menu data from their POS
Use this data to create an HTTP request in JSON format (see format details below)
Send the request to the menu API endpoint: https://api.flypaythis.com/ingest/menu/{BRAND_ID}/locations/{LOCATION_ID} (replacing BRAND_ID and LOCATION_ID with your own values)

The API endpoint will validate the incoming request and, if checks are successful, publish the new menu to the delivery partner. We recommend checking the delivery partner page to see if the new menu has been updated as intended.

Request format

Endpoint to call

POST <https://api.flypaythis.com/ingest/menu/{BRAND_ID}/locations/{LOCATION_ID}>

Headers

X-Flyt-API-Key: the API key you received from Flyt. This API key is unique for menus and cannot be used for item availability. You should not share this API key with anyone outside your organisation.

Content-Type: specified the content type of your request. Should always be set to application/json.

Path parameters

BRAND_ID: a unique identifier for the brand for which this integration is being built. This name is used internally by the Flyt Platform to determine which business is making a request.

LOCATION_ID: a unique identifier for the restaurant the menu belongs to. Send us the internal ID you have for your restaurants. This location ID will be mapped directly to the corresponding delivery partner restaurant.

Body

<aside> 💡 Except if otherwise noted, body attributes are mandatory.