Aloha POS · Schema

Site

A site (location) provisioned on the NCR Voyix Platform.

POSRestaurantHospitalityNCR

Properties

Name Type Description
id string The alphanumeric site identifier.
siteName string Display name of the site.
enterpriseUnitName string Enterprise unit name associated with the site.
coordinates object Geographic coordinates of the site.
status string Site lifecycle status.
View JSON Schema on GitHub

JSON Schema

ncr-voyix-platform-site-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aloha-pos/refs/heads/main/json-schema/ncr-voyix-platform-site-schema.json",
  "title": "Site",
  "description": "A site (location) provisioned on the NCR Voyix Platform.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The alphanumeric site identifier."
    },
    "siteName": {
      "type": "string",
      "description": "Display name of the site."
    },
    "enterpriseUnitName": {
      "type": "string",
      "description": "Enterprise unit name associated with the site."
    },
    "coordinates": {
      "type": "object",
      "description": "Geographic coordinates of the site.",
      "properties": {
        "latitude": { "type": "number", "format": "double" },
        "longitude": { "type": "number", "format": "double" }
      }
    },
    "status": {
      "type": "string",
      "description": "Site lifecycle status.",
      "enum": ["ACTIVE", "INACTIVE"]
    }
  },
  "required": ["siteName", "enterpriseUnitName", "status"]
}