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.

externalId
string

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

guid
required
string

The GUID maintained by Toast.

multiLocationId
any

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. The multiLocationId value in the orders API corresponds to the masterId value for menu configuration entities in the menus API. For more information about the menus API masterId value, see the Toast Developer Guide. type: string

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