{
"$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"
}
}
}
]
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.