Polygon POS Management Configuration
Summary
The integration pushes Menus to Uber Eats and when orders are placed these are recorded in Polygon Central to be sent to the POS.
This document will help you with your integration into Uber Eats utilising their API version 2.
Polygon POS Management Configuration
The Redcat Uber Eats integration pushes menu data to Uber Eats and validates orders received against this data.
Therefore, programming in the BOH must be completed as per Polygon Customer Ordering.
PLUs
All PLUs to be sold via Uber Eats should:
- Be tagged as a Customer Ordering PLU
- Have the relevant Ingredients programmed if further choices or modifications are available for the PLU.
Instructions and modifiers included for the PLU in the Uber Eats sale will be validated against this list. - Contain a link to the relevant customer ordering image
Note: there may be a delay for new images to be visible for customers as they need to pass through an approval process with Uber Eats.
Images
Uber Eats has provided the following specifications to ensure that images are successfully displayed on the menu.
- File type = jpg, png, gif
- Max 10 MB size
- Height: 440-10,000 pixels
- Width: 550-10,000 pixels
Keypads
Keypads should:
- Be created, one for each Category of menu items.
- Be tagged as a Customer Ordering Keypad
A ‘Main’ keypad will need to be created which contains a Keypad Change button to each of the keypads above. This keypad is the one that will be assigned as the integration menu for Uber Eats in Polygon Central. The integration menu assignment is not generally exposed to Admin users and will need to be set by your Redcat contact. The setting is located:
Configuration | Ordering | Integration Menus | Uber Eats Ordering Menu
Enable Settings
Uber Eats will need to be enabled in the default system settings (use the Apply to All option if relevant) and in the system settings for the relevant POS location(s).
To do this:
- Access Polygon POS Management.
- Access the Default Location System Settings (or POS Location System Settings as appropriate).
- Place a tick in the Enable the UberEATS web menu ordering module box under External System Settings | Web Menu Ordering Interfaces | Uber Eats.
- Ensure the Interface API root URL is completed with /api/v1/interfaces/uber_eats
Applying the (Default) POS Location Setting will enable Uber Eats as an option in the External Web Menu Ordering Interfaces on the POS Location Details form.
- Open the POS Location Details form for the relevant location.
- Place a tick in UberEATS.
Apply the Integration
Now that the setup is complete, the final step is to assign the store for Uber Eats integration.
Admin users will need to be assigned the following user role:
- Uber Eats Store Configuration
You can learn more about User Roles in this article.
Assign Stores to Uber Eats Integration
The stores that will be available to the Uber Eats Integration for ordering will need to be assigned in Polygon Central. Please note: The initial menu push and link between Uber Eats and Polygon Central occurs when the Integration is setup.
To do this:
- Access Polygon Central | Integrations | Uber Eats.
- Use the Add Integration button to add the locations that will accept orders from Uber Eats.
- Choose the relevant location from the Locations List drop down.
- Enter the Uber Eats UUID Code (supplied by client | Uber Eats)
- Enter the corresponding Uber Account Email Login (supplied by client | Uber Eats)
- You must enable the New Uber Menu Structure setting (MIM | OLO3 utilises this by default).
- Determine what the Trading Hours logic for this location should be. If desired, ensure the Subtract Avg Prep Time from Closing Time option is selected
- Choose Uber API version 2 from the Uber API Version drop-down list.
Note: Uber ceased to support API version 1 from 31 May 2021.
- Use the Submit button to save.
Managing the Integration
Pausing Uber Orders
The Pause Uber Orders and Unpause Uber Orders buttons are available should a store need to temporarily suspend orders from Uber Eats.
The ‘paused’ status is recognised by Uber and will therefore stop orders at the source, rather than have orders accepted by Uber and then fail to pass through the integration.
The current restaurant status is displayed above the Check Restaurant Paused Status button, and the button can be used to query Uber Eats and refresh the status.
Special Trading Hours
The Uber Eats V2 integration is able to store and respond to customised trading hours. You can upload, download and clear special trading hours.
The Export Special Trading Hours button will send to Uber Eats any records for this location present in Loyalty & Ordering | Customise Trading Hours.
The Download Special Trading Hours button will query Uber Eats for the current list of custom trading hours for this location and download the response in .csv file format.
The Clear Special Trading Hours button will instruct Uber Eats to remove any custom trading hours for this location.
Clearing The Uber Menu
Occasionally it is desirable to remove the entire menu for a location, usually so that a new and complete menu sync may then be performed.
This can be performed only by Redcat staff using the Clear Menu Data button (this buttons will be disabled for all non-Redcat Admin logins.
Price Levels
The Uber Eats integration can be configured to operate a specified price level if Uber Eats online orders should utilise a different price point to normal POS sales.
This needs to be configured in Polygon Central and can be found at the following location.
Polygon Central | Loyalty & Ordering | Price Levels
Menu Synchronisation
Once Polygon Central has the connections configured, the menu can be published to Uber Eats.
It is not recommended that the menu be published to Uber Eats during store trading hours if possible. If a customer is in the process of entering an order, the items already in the cart will be invalidated by the menu sync.
From Polygon POS Management
This can be done from within Polygon POS Management | POS Updates | Web Menu Interfaces tab.
Ensure that the correct location(s) is selected, a tick has been placed next to Uber Eats and use the Publish Update to Web Menu Interfaces.
Note: Publishing the menu will queue the export in the task schedule – there is no reporting of configuration or timeout errors. For this reason, you may wish to export the menu from Polygon Central instead.
From Polygon Central
You can publish the web menu to Uber Eats from Polygon Central | Integrations | Uber Eats.
- Select the desired locations from the Locations List
- Use the Export Menu Data for Selected Locations button
- Removing the Queue Exports in Tasks tick box will force the menu export to the top of the tasks list rather than queuing the export behind any other jobs waiting in the server task list. This will also provide responses for configuration or timeout errors.
Limitations with the Uber Menu Export
Free Choices: Uber does not support ‘free choices’ for PLU ingredients.
OLO2: If a choice set has 1 or more free items programmed Uber interpret this to mean that all choices in the choice set have no charge.
OLO3: Redcat provides a modified version of choice sets in the menu export. For example: If a choice set is "choose 4, 2 are free" two choice sets will be displayed on Uber - one for the selection of 2 free choices, and the other for the selection of 2 priced choices.
Uber Eats API V2 Features
Uber Eats have made these features available in their API V2.
Expanded Sale Types
All orders placed through Uber Eats API V1 were to be collected and delivered by Uber. An expanded set of sale Types is available in Uber Eats API V2.
- Pickup (new)
- Dine In (new)
- Delivery by Restaurant (new)
- Delivery by Uber (existed in V1)
Expanded Delivery Handover Options
These options are available when a customer places an order, and are included in the notes to POS.
- Leave at door
- Curbside / Meet outside
- Deliver to door
Improved Modifier (sizing) Recognition
Size modifiers will exhibit the same behaviour as Polygon Customer Ordering.
The Size Options Name label can be defined in Configuration | Integrations | Uber Eats.
Configuration settings are not generally exposed to Admin users and you may need assistance from your Redcat contact to define this.
Recognition of Items as Vegetarian or Alcohol
Uber API V2 will recognise items tagged at either VEGETARIAN or ALCOHOL and will flag or restrict items accordingly.
To enable this, the string ‘vegetarian’ or ‘alcohol’ must be included as part of the keypad name.
Item Energy Details
The Energy data (kJ) entered for a PLU is recognised and displayed on the Uber menu.
Order Notes
If Order Notes are enabled in Uber Eats, these notes will flow to the POS.
Order notes are only available globally for the order, notes for individual items are not available.
Article Change Log
| Date | Record of Changes | Author |
|
August 2024 |
Migration of this article to the knowledge base. |
S Black |