Page Properties | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
🗒 Overview
This page provides information about how to setup the integration with the Centegra POS using their new API which allows us to import the full menu structure.
Table of Contents | ||||||
---|---|---|---|---|---|---|
|
⚡ Functionality
See
Jira Legacy | ||||||
---|---|---|---|---|---|---|
|
Example Demos
Environment | URL | Notes |
---|---|---|
|
|
|
Figma Designs
⚙ Operations & Support Information
🔨 How to Setup
Config line | Sample value | Description | How to locate it | |
---|---|---|---|---|
QS | type | CENTEGRA | integration type | |
QS | qsBaseUrl | pos-service base url (can be changed to other instances than prod if neccessary) | ||
QS | qsApiKey | CH6fm*** | pos-service API key (should match the instance) | |
CENT | baseUrl | |||
CENT | siteId | 439 | The site with the desired menu to be synchronized to | In the Cetengra Pluss dashboard, under “Company Settings/Site Setup/Site”, you can check the siteId in the url: |
CENT | centegraLocationId | 460 | Formaly “locationId”, the location with the desired menu to be synchronized to. | In the Cetengra Pluss dashboard, under “Company Settings/Site Setup/Locations”, and clicking in “edit” on the desired location, you can check the siteId in the URL: centegraplus-us-staging.herokuapp.com/company-settings/locations/460/edit |
CENT | tillId | 1331 | In the Cetengra Pluss dashboard, under “Company Settings/Tills”, and clicking in “edit” on the desired till, you can check the tillId in the URL: | |
CENT | clerkId | 218 | ||
CENT | saleTypeId | 1 | ||
CENT | priceLevelId | 47 | The price level used for importing products and submitting orders | In the Cetengra Pluss dashboard, under “Product Management/Price Setup/Price Levels”, and clicking in “edit” on the desired till, you can check the priceLevelId in the URL: centegraplus-us-staging.herokuapp.com/product-management/price-levels/45/edit |
CENT | QEMPriceLevelId | 2 | The price type index used in V1, still needed to submit orders | In the Cetengra Pluss dashboard, under “Product Management/Price Setup/Price Levels”, the value should be the index of the desired price level |
CENT | sourceId | 6 | ||
CENT | tillSecureKey | 05E80175A4E94B9A9F3D | In the Cetengra Pluss dashboard, under “Company Settings/Tills”, and clicking in “edit” on the same till used for tillId, you will see the API Till Secure Key field | |
CENT | mediaId | 11149 | ||
CENT | secureKey | 61B38A164B9445CF | APIKey for Environment | |
CENT | destinationUID | B590F2FD-D57E-497E-9911-5DFB2F6FC6A8 | The unique UID for the destination containing the menus | Needs to contact Centegra support |
CENT | menuId | 9 | The desired menu you wish to sync with | In the Cetengra Pluss dashboard, under “Menu Management/Menu Builder”, and clicking in “edit” on the desired menu, you can check the menuId in the URL: centegraplus-us-staging.herokuapp.com/menu-management/menu-managements/9/edit |
Menu Management
Info |
---|
Sections, Tax groups and modifiers are pre-assigned at the POS level. |
Once everything has been imported all sections, items, modifiers, and tax groups will be set up as configurated in the POS.
The display names, descriptions, and images of items can either be edited once they have been imported into the relevant sections or by searching for the item in the ‘Items’ tab of ‘Menus’.
To edit the modifier display names, visit the ‘Modifiers’ tab under ‘Menus’ and make the relevant changes. Just like items, modifier options can be hidden from the menu in real-time.
If you are wanting to add new items to your menu after the initial synchronization, you will first need to create these items on your POS. Once you have done this, return to your QikServe dashboard and recreate this item by clicking on ‘Create new item’ under the relevant section. Fill in all the relevant item information.
Importing Menu from Channel
It’s possible to import the menu from the venue and from the channel, if the venue has the feature UPDATE_EXTERNAL_MENU enabled a new option will show up in the side panel in the webapp Global Dashboar.
Venue Dashboard: If you access this menu through a venue Dashboard you will see the name of the venue with an option to “Sync Menu” this will update a menu in that venue with the menu from the POS, the menu to be updated is the menu configured on Internal Tools → Providers → POS Providers.
Global Dashboard: When accessing through a Channel (Global Dashaboard) you will see a list of venues (Channel venues that has the UPDATE_EXTERNAL_MENU feature enabled). By clicking the 3 dots at the right of the venue box, you will see the option “Show available menus” that will give you the following options:
Import items only: Will import the items from the POS to the channel
Create a new Menu: Will import the menu from the POS to the channel with the name “VENUE_NAME CURRENTE_DATE”, eg: “London Stadium 03/10/2023”
Bellow, there will be a list of menus already registered in this channel, selecting one of the menus will update this menu with the menu from the POS
Note |
---|
Keep in mind that this feature currently works if you have only one type of POS Provider set in the Channel venues, having two or more may result in undesired overrides. |
⚠ Dependencies
📽 Demo Video
🐛 Troubleshooting
Known Issues
Issue | Cause | Fix / Mitigation |
---|---|---|
📊 Log Queries
DataDog
Example Link | Description |
---|---|
Rapid 7
Example Link | Description |
---|---|
/ |
🗣 3rd Party Support Process
Info |
---|
Delete section if not applicable |
Name | Contact Information | Notes |
---|---|---|
Production Support Desk | ||
Integration Team Support | ||
Escalation |
🕵️♂️ Development & Technical Information
🔎 Integration Overview
🗺 Sequence & Flow Diagrams
Centegra Sandbox Configuration
Code Block |
---|
type=CENTEGRA qsBaseUrl=https://b342-191-248-160-216.sa.ngrok.io/v2 qsApiKey=CH6fmKBJZk6LVYiACUFp2xJdxKz8ltBvMIJa2G1BroXZIExbguQRFmc1ElhLkPIz siteId=439 centegraLocationId=460 tillId=1331 clerkId=218 saleTypeId=1 priceLevelId=47 sourceId=6 tillSecureKey=05E80175A4E94B9A9F3D mediaId=11149 secureKey=61B38A164B9445CF baseUrl=http://devapi.centegraplus.us destinationUID=B590F2FD-D57E-497E-9911-5DFB2F6FC6A8 menuId=9 QEMPriceLevelId=2 |
📚 API Docs and Links
Artefact | Link | Notes | ||||
---|---|---|---|---|---|---|
Centegra Plus Sandbox |
| |||||
API Dev Endpoint | The Sandbox has everything you need to get started with an integration and using Centegra Plus. There is a single Site, a Location within it and a Till, there are Products, Groups, Prices, Combos, Modifiers, Media and a Transaction Source to use for sending Order data to centegra. | |||||
Centegra Plus API US - Menus & Menu Publication - V2 |
|
🖥 Test Environments
Test Environment Questionnaire
Question | How to | Notes | |||||
---|---|---|---|---|---|---|---|
1 | How do I log in? | ||||||
2 | How do I start an order in the UI? |
| |||||
3 | How do I access orders? |
| |||||
4 | How do I access previous orders? |
| |||||
5 | Who do I void items / orders? |
|