Items

An item in T-Gate belongs to a section within a menu. These items are the actual selectable entities within a users order.

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

Model Attributes

Attribute	Description	Type
id	the unique identifier of that table entity	Integer
children_ids	Array of ids that represents all item_ids which are under that specific item in the items hierarchy	Integer Array
description_en	Item description in English	String or Null
description_ar	Item description in Arabic	String or Null
image_url	Item image URL.	String or Null
is_active	Boolean attribute that specifies the status of the item. non-active items cannot be used in new orders.	Boolean
inactive_in_branches	Array that specifies which branches this item is inactive in.	Integer Array
item_type	the type of a item	Enum String
max	For modifier_group item types, this specifies the maximum number of modifiers to be selected under each group. This attribute is Null for other item types	Integer or Null
max_num_of_same_item	For modifier_group item types, this specifies the maximum number of the same modifier to be selected under each group. This attribute is Null for other item types	Integer or Null
min	For modifier_group item types, this specifies the minimum number of modifiers to be selected under each group. This attribute is Null for other item types	Integer or Null
name_en	Item Name in English	String
name_ar	Item Name In Arabic	String or Null

📘

Children IDS

For each item, T-Gate returns an integer array of all items that are directly assigned under it. We recommend that you fetch all the items first then create these association hierarchies. refer to Partner API → Best Practices Guides to learn more.