Toast · JSON Structure

Orders Toast Reference Structure

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

Type: object Properties: 2 Required: 2
Food ServicePoint of SaleRestaurantsHospitality

ToastReference is a JSON Structure definition published by Toast, describing 2 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

guid entityType

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/toast/refs/heads/main/json-structure/orders-toast-reference-structure.json",
  "name": "ToastReference",
  "description": "A wrapper object with fields that allow reference to a Toast entity by Toast GUID.",
  "type": "object",
  "required": [
    "guid",
    "entityType"
  ],
  "properties": {
    "guid": {
      "description": "The GUID maintained by the Toast platform.",
      "type": "string"
    },
    "entityType": {
      "x-toast-read-only": true,
      "description": "The type of object this is. Response only.",
      "type": "string"
    }
  }
}