This guide will be removed on April 29, 2022. Please use our new, easier-to-use Toast technical documentation site. All updated content is on the new site.
The multiLocationId is an identifier that is used to
identify and consolidate menu entities that are versions of each
other.
|
Note |
|
Menu entities can be versioned. Those versions can be assigned to specific restaurant locations, or groups of locations, in a management group. For example, you could have two versions of a Breakfast menu, one for a Boston location and another for a New York City location. Versioned menu entities share the majority of, but not all of, their data. For example, the Boston version includes waffles while the New York City version does not.
You use the multiLocationId to identify menu entities
that are versions of each other. To continue the example above, the
Breakfast menu in the JSON returned for the Boston location has the same
multiLocationId as the Breakfast menu in the JSON returned
for the New York City location. These matching
multiLocationId values indicate that the two menus are
related versions.
The Toast platform ensures that once a
multiLocationId value is assigned to a set of versions
within a management group, that multiLocationId is not used
for any other versioned menu entities in the same management group. It
does not guarantee, however, that the multiLocationId is
not used by another management group to identify a set of versions
within it.
For detailed information on the enterprise module and versioning, see Enterprise Restaurant Chains in the Toast Platform Guide.