Skip to main content
All Systems Operational
Deutsch Español

Brink - Integration Settings Configuration

Permanently deleted user
  • Updated

Context

This article explains which fields have to be configured, how, and by whom, to successfully setup Brink as a POS integration.

Assigned formatting

While reading, you'll see the following formatting to make it easier for you to understand whose responsibility it is to setup a certain field:

  • aquamarine - these fields have to be completed by Brink and shared with MENU in advance
  • orange - these fields have to be completed by MENU internally
  • triple asterisk/star symbol *** - these fields are the basic mandatory ones. They have to be configured in order to complete the configuration - in any Brink setup. Without them, you won't be able to complete this process
  • bold black - these are the fields that are optional and enhance functionalities based on your requirements and preferences

Settings fields

To make this article easier to read, we've divided it into three sections you can see below. Click on each one to expand/collapse them and be able to read about the type of configuration that interests you:

 

Brink Integration Settings

FIELD DESCRIPTION
API endpoint  *** The API endpoint is the specific URL where the MENU system can send requests to access and interact with a particular API
Access Key  *** The access key is a unique alphanumeric code that grants authorized access to a specific API or service. It serves as a secure authentication mechanism
Location Key  *** The location key refers to a unique identifier associated with a physical location. It helps the API accurately determine and identify the specific geographical area or site
Item ID For Comments The Item ID for Comments is a unique identifier from a specific POS item. This will allow restaurant users to provide specific comments or feedback
Menu Tender Type ID The Menu Tender Type ID represents the unique identifier associated with different types of payment methods or tender options available in our POS
Dine-In Destination The Dine-In Destination refers to a specific location/area within the restaurant where Customers can choose to enjoy their meals on-site
Take-Out Destination The Take-Out Destination represents a designated area or station where Customers can collect their orders for takeaway
Delivery Destination The Delivery Destination refers to the specified location where a Customer wants their order to be delivered
Full-Service Destination The Full-Service Destination refers to a designated area or section within our establishment where Customers can enjoy a full-service dining experience. It may include a sit-down area with waitstaff, table service, and additional amenities
UberEats Destination The UberEats Destination represents an aggregator platform from which Customers can place orders for delivery from our stores. It signifies the integration with the Uber Eats platform, enabling the sales team to manage and process orders received through Uber Eats seamlessly
Minimal Surcharge ID The Minimal Surcharge ID is a unique identifier associated with a specific POS item that can be utilized for certain transactions or services. Brands have the option to designate an item with a minimum price of "x$". If the total sum of the individual items ordered does not meet or exceed this minimum price, the final users will still be charged the designated "x$" amount. This ensures that a minimum threshold is maintained for orders, allowing brands to cover their costs and provide a consistent pricing structure
Delivery Fee Item ID​ The Delivery Fee Item ID is a unique identifier associated with a POS specific item that can be utilized as a “fixed amount” delivery fee
Enable MPF (Toggle - Inactive or Active) The Enable MPF toggle allows brands to activate or deactivate the Minimum Purchase Fee (MPF) feature. When enabled, the MPF ensures that a minimum purchase amount must be met before an order can be processed. It provides control over order sizes and helps businesses maintain profitability, especially for low-value transactions
MPF surcharge ID The MPF surcharge ID is a unique identifier associated with a specific POS item. This is strictly related to the previous configuration field (Enable MPF toggle)
Price inflation (Toggle - Inactive or Active) The Price Inflation toggle allows brands to adjust prices dynamically based on factors such as demand, supply, or operational costs
Discount ID The Discount ID is an open amount item where MENU are doing calculation and send the correct minus amount with the order injection to the POS
Gift card tender type ID The Gift Card Tender Type ID is a unique identifier associated with a specific payment option dedicated to gift card transactions. It enables Customers to use gift cards as a form of payment for their purchases
Loyalty Guest The Loyalty Guest field ID is an Open Amount Item in Brink, which is used to send as an identifier to the POS for every order placed by a guest from Punchh
Loyalty User The Loyalty User field ID is an Open Amount Item in Brink, which is used to send as an identifier to the POS for every order placed by a user with a Punchh account
Modifier code IDs Modifier code IDs are unique identifiers associated with specific customization options or modifications available for products or services. These codes allow Customers or sales teams to select and apply additional features, variations, or adjustments to an item

 

Brink Webhook Settings

FIELD DESCRIPTION
Status

It can state:

  • available
  • coming soon
Webhook API endpoint

The Webhook API endpoint is a specific URL where incoming webhook notifications are sent. Webhooks are a way for applications to communicate with each other in real time, and the API endpoint acts as the receiver of these notifications. For example, we use this for:

  • Order Status: The Order Status webhook is responsible for providing real-time updates and notifications regarding the status of an order. For example, if an order is marked as Ready in the POS, a notification to the Customer should be triggered automatically at MENU

    • Once we receive this webhook, based on the orderId and locationId we find the MENU order. Depending on the order type, we proceed with either sending an automatic push notification to Customers containing the Order ID through our Tablet API or simply updating the order state to "Final."

  • Item availability: The Item Availability webhook is used to notify MENU about the availability or stock status of specific items. This will dictate if certain items can be ordered while a user is ordering

    • Once we receive this webhook, based on the item ID and locationId properties from the request we find the MENU item. Then, we modify the “isAvailable“ flag attribute to enable or disable the MENU item or just the price level

  • Item price change: The Item Price Change webhook is utilized to inform systems or applications about any modifications or updates in the prices of specific items
Webhook authenticate endpoint The Webhook authenticate endpoint is a designated URL that handles the authentication process for incoming webhook requests. When a webhook notification is sent, the authenticate endpoint verifies the authenticity and integrity of the request to ensure that it comes from a trusted source. It provides an additional layer of security, protecting against unauthorized access and ensuring that only legitimate webhook notifications are processed

 

Common Integration Settings

FIELD DESCRIPTION
Auto Sync Recurrence Auto Sync Recurrence refers to the frequency or interval at which automatic synchronization of data or settings occurs between the MENU platform and the POS. It determines how often the synchronization process takes place to ensure that data remains up to date and consistent across all connected systems
Logger enabled

  • The Logger Enabled setting enables the logging functionality within an integration. It captures and records relevant information, events, or errors that occur during the integration process.
    Please note: This must be discussed with the brand and configure according to their interests and needs
Centralized POS Centralized POS refers to a system or approach where multiple point-of-sale (POS) terminals or locations are connected and managed through a centralized platform. It allows the team to oversee and control various aspects of the sales process, such as inventory management, sales reporting, and Customer data, from a central point

 

Related articles

Comments

0 comments

Please sign in to leave a comment.