Toast · Schema

ConfigReference

A wrapper object containing identifier values for Toast platform entities.

Food ServicePoint of SaleRestaurantsHospitality
View JSON Schema on GitHub

JSON Schema

orders-config-reference-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/toast/refs/heads/main/json-schema/orders-config-reference-schema.json",
  "title": "ConfigReference",
  "description": "A wrapper object containing identifier values for Toast platform entities.\n",
  "type": "object",
  "allOf": [
    {
      "$ref": "#/definitions/ToastReference"
    },
    {
      "type": "object",
      "properties": {
        "multiLocationId": {
          "description": "A consistent identifier for Toast platform entities, such\nas menu items, that applies to all versions of a shared\nentity at all locations in a restaurant group.\n\nFor example, you can use the `multiLocationId` value to\nidentify menu entities that are versions of a shared menu\nentity. For more information about the menus API `multilocationId` value, see\n[the _Toast Developer Guide_](https://doc.toasttab.com/doc/devguide/apiUnderstandingGuidsEntityIdentifiersAndMultilocationIds_V2.html#apiMultilocationIdValues_V2).\n",
          "type": "string"
        },
        "externalId": {
          "description": "An external identifier that is prefixed by a naming\nauthority. Deprecated for use in `ConfigReference`.\n",
          "type": "string"
        }
      }
    }
  ]
}