NCR · Schema

Site

Site schema from NCR Voyix Commerce Platform APIs

RestaurantRetailBankingATMPoint of SaleCommerceFortune 500

Properties

Name	Type	Description
siteName	string
enterpriseUnitName	string
referenceId	string
address	object
coordinates	object
currency	string
timeZone	string
status	object
id	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Site",
  "description": "Site schema from NCR Voyix Commerce Platform APIs",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ncr/refs/heads/main/json-schema/ncr-voyix-commerce-platform-site-schema.json",
  "type": "object",
  "properties": {
    "siteName": {
      "type": "string",
      "example": "Downtown Store"
    },
    "enterpriseUnitName": {
      "type": "string",
      "example": "Downtown Store"
    },
    "referenceId": {
      "type": "string",
      "example": "example"
    },
    "address": {
      "$ref": "#/components/schemas/Address"
    },
    "coordinates": {
      "$ref": "#/components/schemas/Coordinates"
    },
    "currency": {
      "type": "string",
      "example": "USD"
    },
    "timeZone": {
      "type": "string",
      "example": "America/New_York"
    },
    "status": {
      "$ref": "#/components/schemas/Status"
    },
    "id": {
      "type": "string"
    }
  },
  "required": [
    "siteName",
    "enterpriseUnitName",
    "status"
  ]
}