Location Module

v2.0.1
Module

Essential module for businesses with physical presence or geographic service areas. Provides standardized location data, service boundaries, and location-based capabilities.

Required Module
for Hotel, Restaurant, Clinic, and Ridesharing Service entities
4

Required For

7

Optional For

5

Service Area Types

6

Location Features

Module Purpose & Benefits

The Location module is fundamental for any business with a physical presence or geographic service area. It enables AI systems to understand where services are provided and how users can interact with the business.

Address Standardization

Uses the standardized address-format component for consistent location data

Service Area Definition

Define service boundaries using radius, polygons, or administrative areas

Multiple Locations

Support for businesses with multiple branches or service points

Location-Based Features

Rich metadata about delivery, pickup, mobile services, and on-site capabilities

Geographic Precision

Latitude/longitude coordinates with timezone and accessibility information

Business Hours Integration

Operating hours tied directly to specific locations

Required For
Entities that must include the location module
Required
Hotel

Required for accommodation services

Physical location essential for guest services

Required
Restaurant

Required for food service establishments

Address needed for dining, delivery, and pickup services

Required
Clinic

Required for healthcare facilities

Patient visits require precise location information

Required
Ridesharing Service

Required for transportation services

Service areas and pickup/dropoff locations essential

Optional For
Entities that may benefit from location features
Optional
Education Platform
Optional
Fitness Platform
Optional
Store
Optional
Business Services
Optional
Real Estate Platform
Optional
Marketplace
Optional
Dating Platform
Service Area Configuration
Different ways to define where your business provides services
radius
Circular Service Area

Define service area as a radius from a central point (ideal for delivery services)

administrative
Administrative Boundaries

Service specific cities, states, or countries

postal_codes
Postal Code Areas

Define coverage by ZIP codes or postal regions

polygon
Custom Polygons

Draw precise service boundaries using geographic coordinates

global
Global Service

Worldwide service availability (digital services, online platforms)

Module Schema
Complete location module structure and properties
location.json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Location Module",
  "description": "Module for location-based functionality and geographic information",
  "aimlVersion": "2.0.1",
  "schemaVersion": "2.0.1",
  "type": "object",
  "properties": {
    "version": {
      "type": "string",
      "const": "2.0.1",
      "description": "Module version"
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether location module is enabled"
    },
    "address": {
      "$ref": "../../components/address-format.json",
      "description": "Primary address using standardized format"
    },
    "additionalLocations": {
      "type": "array",
      "items": {
        "$ref": "../../components/address-format.json"
      },
      "description": "Additional addresses (branches, offices, etc.)"
    },
    "serviceArea": {
      "type": "object",
      "description": "Geographic area where services are provided",
      "properties": {
        "type": {
          "type": "string",
          "enum": ["radius", "polygon", "administrative", "postal_codes", "global"],
          "description": "Type of service area definition"
        },
        "radius": {
          "type": "object",
          "properties": {
            "centerPoint": {
              "type": "object",
              "properties": {
                "latitude": { "type": "number" },
                "longitude": { "type": "number" }
              },
              "required": ["latitude", "longitude"]
            },
            "radiusKm": {
              "type": "number",
              "minimum": 0,
              "description": "Service radius in kilometers"
            }
          }
        },
        "boundaries": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": { "type": "string" },
              "type": { "type": "string", "enum": ["city", "state", "country", "postal_code"] },
              "identifier": { "type": "string" }
            }
          }
        }
      }
    },
    "locationFeatures": {
      "type": "object",
      "properties": {
        "hasMultipleLocations": { "type": "boolean" },
        "supportsDelivery": { "type": "boolean" },
        "supportsPickup": { "type": "boolean" },
        "hasOnSiteServices": { "type": "boolean" },
        "mobileService": { "type": "boolean" }
      }
    }
  },
  "required": ["version", "enabled"]
}
Implementation Example
Restaurant entity with comprehensive location configuration
Restaurant with location module
{
  "modules": {
    "location": {
      "version": "2.0.1",
      "enabled": true,
      "address": {
        "addressType": "physical",
        "name": "Bella Vista Restaurant Main Location",
        "streetAddress": "123 Main Street",
        "city": "Downtown",
        "region": "CA",
        "postalCode": "90210",
        "country": "United States",
        "countryCode": "US",
        "geoCoordinates": {
          "latitude": 34.0522,
          "longitude": -118.2437
        },
        "timeZone": "America/Los_Angeles",
        "businessHours": [
          {
            "dayOfWeek": "Monday",
            "opens": "11:00",
            "closes": "22:00"
          },
          {
            "dayOfWeek": "Sunday",
            "opens": "12:00",
            "closes": "21:00"
          }
        ]
      },
      "serviceArea": {
        "type": "radius",
        "radius": {
          "centerPoint": {
            "latitude": 34.0522,
            "longitude": -118.2437
          },
          "radiusKm": 15
        }
      },
      "locationFeatures": {
        "hasMultipleLocations": false,
        "supportsDelivery": true,
        "supportsPickup": true,
        "hasOnSiteServices": true,
        "mobileService": false
      }
    }
  }
}
Location Features
Boolean flags that describe location-based capabilities
hasMultipleLocations

Business operates from multiple physical locations

supportsDelivery

Delivers products/services to customer locations

supportsPickup

Customers can collect orders from business location

hasOnSiteServices

Provides services at the business location

mobileService

Travels to customer locations to provide services

Module URL
Direct access to the location module schema
https://schemas.meta-aiml.org/v2.0.1/templates/module/location.json

Included in entity schemas via the modules object

← All ModulesAddress Format Component →Restaurant Entity →