Aloha POS · Schema

Order

An order (check) created through the NCR Voyix Order API.

POSRestaurantHospitalityNCR

Properties

Name	Type	Description
id	string	The order identifier.
channel	string	Origination channel of the order.
comments	string	Free-text comments on the order.
customer	object	The customer placing the order.
orderLines	array	The line items on the order.

View JSON Schema on GitHub

JSON Schema

{
  "$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-order-schema.json",
  "title": "Order",
  "description": "An order (check) created through the NCR Voyix Order API.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The order identifier."
    },
    "channel": {
      "type": "string",
      "description": "Origination channel of the order."
    },
    "comments": {
      "type": "string",
      "description": "Free-text comments on the order."
    },
    "customer": {
      "type": "object",
      "description": "The customer placing the order.",
      "properties": {
        "email": { "type": "string", "format": "email" },
        "firstName": { "type": "string" },
        "lastName": { "type": "string" }
      }
    },
    "orderLines": {
      "type": "array",
      "description": "The line items on the order.",
      "items": {
        "type": "object",
        "properties": {
          "productId": {
            "type": "object",
            "properties": {
              "type": { "type": "string" },
              "value": { "type": "string" }
            }
          },
          "quantity": {
            "type": "object",
            "properties": {
              "unitOfMeasure": { "type": "string" },
              "unitOfMeasureLabel": { "type": "string" },
              "value": { "type": "number" }
            }
          },
          "unitPrice": { "type": "number", "format": "double" }
        }
      }
    }
  },
  "required": ["orderLines"]
}