Otter · Schema

Marketintel_GeoLocationInformation

The geographical location information used to discover stores. This information will need be pass back with the result.

RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

Properties

Name	Type	Description
regionId	string	The region id of the geographical location.
superRegion	string	The super region of the geographical location.
h3Index	string	The H3Index value of the geographic location.
searchText	string	The text used to search for stores.
address	object	The address of the geographical location.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Marketintel_GeoLocationInformation",
  "description": "The geographical location information used to discover stores.  This information will need be pass back with the result.",
  "$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-marketintel-geo-location-information-schema.json",
  "type": "object",
  "properties": {
    "regionId": {
      "type": "string",
      "description": "The region id of the geographical location.",
      "example": [
        "LATAM-N"
      ]
    },
    "superRegion": {
      "type": "string",
      "description": "The super region of the geographical location.",
      "example": [
        "LATAM"
      ]
    },
    "h3Index": {
      "type": "string",
      "description": "The H3Index value of the geographic location.",
      "example": [
        "886d344c81fffff"
      ]
    },
    "searchText": {
      "type": "string",
      "nullable": true,
      "description": "The text used to search for stores.",
      "example": [
        "chinese food"
      ]
    },
    "address": {
      "type": "object",
      "description": "The address of the geographical location.",
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-address-schema.json"
    }
  }
}