ConfigReference

A wrapper object with fields that allow reference to a Toast entity by Toast GUID.

entityType
required
string

The type of object this is. Response only.

externalId
string

An external identifier that is prefixed by a naming authority. Deprecated for use in ConfigReference.

guid
required
string

The GUID maintained by the Toast platform.

multiLocationId
string

A consistent identifier for Toast platform entities, such as menu items, that applies to all versions of a shared entity at all locations in a restaurant group.

For example, you can use the multiLocationId value to identify menu entities that are versions of a shared menu entity. For more information about the menus API multilocationId value, see the Toast Developer Guide.

{
  • "guid": "string",
  • "entityType": "string",
  • "multiLocationId": "string",
  • "externalId": "string"
}