ExternalReference

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/toast-tab/refs/heads/main/json-schema/orders-external-reference-schema.json",
  "title": "ExternalReference",
  "description": "A wrapper object with fields that allow reference to a Toast platform entity by Toast GUID or a partner's identifier.",
  "type": "object",
  "allOf": [
    {
      "$ref": "#/$defs/ToastReference"
    },
    {
      "type": "object",
      "properties": {
        "externalId": {
          "description": "External identifier string that is prefixed by the naming authority. You can use the orders API to set an `externalId` for an order and then GET the order with that `externalId`.",
          "type": "string"
        }
      }
    }
  ],
  "$defs": {
    "ToastReference": {
      "type": "object",
      "description": "A wrapper object with fields that allow reference to a Toast entity by Toast GUID.",
      "required": [
        "guid",
        "entityType"
      ],
      "properties": {
        "guid": {
          "description": "The GUID maintained by the Toast platform.",
          "type": "string",
          "example": "5a401af8-d2e2-4090-8c45-9f87b8b6c4d1"
        },
        "entityType": {
          "x-toast-read-only": true,
          "description": "The type of object this is. Response only.",
          "type": "string",
          "example": "string"
        }
      }
    }
  }
}