ExternalReference

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

entityType
required
string

The type of object this is. Response only.

externalId
string

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.

guid
required
string

The GUID maintained by the Toast platform.

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