Toast · JSON Structure

Orders External Reference Structure

A wrapper object with fields that allow reference to a Toast platform entity by Toast GUID or a partner's identifier.

Type: object Properties: 0
Food ServicePoint of SaleRestaurantsHospitality

ExternalReference is a JSON Structure definition published by Toast. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

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-external-reference-structure.json",
  "name": "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": "#/definitions/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"
        }
      }
    }
  ]
}