Toast · Schema
Location
Information about the physical location of a restaurant.
RestaurantsPoint Of SalePaymentsOnline OrderingDeliveryLoyaltyGift CardsMenusOrdersKitchenLaborSchedulingInventoryHospitalityPartner Integrations
Properties
| Name | Type | Description |
|---|---|---|
| address1 | string | The first line of the street address of the restaurant. |
| address2 | string | The second line of the street address of the restaurant. |
| city | string | The city or town of the restaurant. restaurant. |
| stateCode | string | Deprecated. Get the state or province of a restaurant in the `administrativeArea` value. The abbreviation of the state or province of the restaurant. |
| administrativeArea | string | The name of the geographical division (for example, state, province, or county) that the restaurant is located in. |
| zipCode | string | The ZIP or postal code of the restaurant. |
| country | string | The nation of the restaurant. |
| phone | string | |
| phoneCountryCode | string | A numeric code corresponding to one or more countries, used as a telephone number prefix when making international telephone calls. |
| latitude | number | The north/south geographic coordinate of the restaurant, in decimal degrees. |
| longitude | number | The east/west geographic coordinate of the restaurant, in decimal degrees. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/toast-tab/refs/heads/main/json-schema/restaurants-location-schema.json",
"title": "Location",
"description": "Information about the physical location of a restaurant.",
"type": "object",
"properties": {
"address1": {
"type": "string",
"description": "The first line of the street address of the restaurant.",
"example": "string"
},
"address2": {
"type": "string",
"description": "The second line of the street address of the restaurant.",
"example": "string"
},
"city": {
"type": "string",
"description": "The city or town of the restaurant. restaurant.",
"example": "string"
},
"stateCode": {
"type": "string",
"description": "Deprecated. Get the state or province of a restaurant in the\n`administrativeArea` value.\n\nThe abbreviation of the state or province of the restaurant.\n",
"example": "string"
},
"administrativeArea": {
"type": "string",
"description": "The name of the geographical division (for example, state, province,\nor county) that the restaurant is located in.\n",
"example": "string"
},
"zipCode": {
"type": "string",
"description": "The ZIP or postal code of the restaurant.",
"example": "string"
},
"country": {
"type": "string",
"description": "The nation of the restaurant.",
"example": "string"
},
"phone": {
"type": "string",
"example": "string"
},
"phoneCountryCode": {
"type": "string",
"description": "A numeric code corresponding to one or more countries,\nused as a telephone number prefix when making \ninternational telephone calls.\n",
"example": "string"
},
"latitude": {
"type": "number",
"format": "double",
"description": "The north/south geographic coordinate of the restaurant, in decimal degrees.",
"example": 1.0
},
"longitude": {
"type": "number",
"format": "double",
"description": "The east/west geographic coordinate of the restaurant, in decimal degrees.",
"example": 1.0
}
}
}