Synchronization Model Reference
This page provides a detailed lexicon for each section and object in the UEAT Open API Synchronization Model. Use this as a reference when building or validating menu synchronization payloads.
The POS is the source of truth for menu synchronization and the payload must provide consistent IDs, modifier structures, and availability information.
Menu
The root object containing the complete menu definition.
- Items: Master catalog of all products and modifiers available in the menu.
- Categories: Menu grouping structure used to expose products to customers.
- Modifiers: Modifier groups and their relationships.
For a complete menu payload, see Example Synch Payload #1.
Items
Contains all sellable elements exposed to UEAT.
- Id: Unique identifier coming from the POS.
- Must remain stable across synchronizations.
- Used as the reference throughout the menu structure.
- Name: Display name of the item or modifier.
- Type: Defines the item type.
Item: A sellable product or a variation attached to another product.modifier: A selectable option, extra.
- Prices: Service-specific pricing configuration.
Prices
- ServiceType: Service for which the price applies.
- Ex:
Takeout,Delivery,Generic5,Generic8 - For the service list see the service enum.
- Ex:
- Price: Price in cents.
Example:
{
"Prices": [
{
"ServiceType": "Takeout",
"Price": 1500
},
{
"ServiceType": "Delivery",
"Price": 1550
}
]
}
Categories
Categories define the customer-facing menu structure.
- Id: Unique category identifier from the POS.
- Name: Category name displayed in UEAT.
- ParentCategoryId: Parent category identifier.
nullfor top-level categories.- References another category ID when the category is nested under a parent category.
- Items: Array of items included in the category.
Category Item
Represents the association between a product and its modifier groups.
- Id: Item identifier referencing an object from
Menu.Items. - ModifierGroups: Array of modifier group identifiers attached to the item. Example:
{
"Id": "1001",
"Name": "Burgers",
"ParentCategoryId": null,
"Items": []
}
Modifier Groups
The Modifiers collection defines groups of selectable modifiers.
- Id: Unique modifier group identifier.
- Name: Modifier group display name.
- Modifiers: Array of item identifiers belonging to the group.
Example:
{
"Id": "10171",
"Name": "Options",
"Modifiers": ["80086", "80087", "80088"]
}
Item Variations
Variations are represented as a modifier group attached to a parent item.
A variation group behaves similarly to a modifier group, except each entry represents a product variation rather than an optional modifier.
Example:
{
"Id": "variant_80083",
"Name": "variant_80083",
"Modifiers": ["80099", "80100", "80083"]
}
In this example:
- product_80083 is the parent product.
- 80083, 80099, and 80100 represent available variations.
- Each variation can have its own price.
Service Types
Prices may vary depending on the service type.
The available service types are identical to those used in the Order Model.
Each service type may define a different price for the same item.
ID Relationships
The synchronization model relies heavily on ID references.
Item Reference
A category item references an object from Menu.Items.
{
"Id": "80079"
}
Must match:
{
"Id": "80079",
"Type": "item"
}
Modifier Group Reference
A category item references modifier groups.
{
"ModifierGroups": ["10171"]
}
Must match:
{
"Id": "10171"
}
Modifier Reference
A modifier group references modifier items.
{
"Modifiers": ["80086"]
}
Must match:
{
"Id": "80086",
"Type": "modifier"
}
Price Model
- Prices are always expressed in cents.
- Example: 1500 = $15.00
- Each item can define multiple prices.
- A price can vary by service type.
- A price of
0is accepted when applicable.
Naming
- Item names are synchronized from the POS.
- Category names are synchronized from the POS.
- Modifier group names are synchronized from the POS.
- UEAT uses the synchronized names when displaying products and generating order payloads.
UEAT may display customized names to customers, but order payloads always use the synchronized POS names.
Synchronization Validation Checklist
Before publishing a synchronization payload, validate:
- Every item has a unique ID.
- Every category references valid item IDs.
- Every modifier group references valid modifier IDs.
- Every modifier group attached to an item exists.
- Service-specific prices are defined as expected.
- Item and modifier names are correctly synchronized.
- Variation groups reference valid variation items.
- Every referenced ID exists exactly once in the payload.
- IDs remain stable between synchronizations. Consistent ID mapping is a key validation point for menu synchronization.
If any of these rules is not met, the menu will not be saved. A menu validator is not yet available.