Menus

A menu in the T-Gate platform represents a curated list of items that a branch offers. It serves as an organized collection of all the available food and beverage options provided by the branch.

For more details on the hierarchical structure of a menu and the different types of items in T-Gate, please refer to General → Menu Structure Guides.

Model Attributes

AttributeDescriptionType
idthe unique identifier of that table entityInteger
logoMenu Logo URLString or Null
description_enMenu description in EnglishString or Null
description_arMenu description in ArabicString or Null
is_activeSpecifies the current state of a menu.Boolean
inactive_in_branchesArray that specifies which branches this section is inactive in.Integer Array
name_enMenu name in EnglishString
name_arMenu name in ArabicString or Null
branch_idsArray of ids that represents all the branches this menu is linked toInteger Array
section_idsArray of ids that represents all the sections linked under that menuInteger Array
📘

Active Status

when companies need to stop accepting orders from a specific menu, T-Gate offers the company a way to deactivate it's menu which prevents new orders from being created from these menus

Check Partner API → Force Closure Guides to learn more.

📘

is_active VS inactive_in_branches

Menu deactivation can be done either on all branches or on specific branches.

is_active is a status related to the menu regardless which branches its assigned to, this means that if menu.is_active = False, Orders cannot be made from that menu from any branch. However, a menu can be deactivated under specific branches, These branches will have there IDs in the inactive_in_branches Array.

📘

section_ids

T-Gate adds a bi-directional link between a menu and its sections to allow applications to fetch and link data in the order that best suits their needs.

This means that if you navigate to the section entity using the section_id found in a menu, you will find the id of that menu under the menu_id attribute. This bi-directional link ensures that you can start from either the menu or the section and establish their relationship effectively.