Aloha POS · JSON Structure

Ncr Voyix Platform Item Price Structure

A price for a catalog item, tied to the item by its item code.

Type: object Properties: 6 Required: 2
POSRestaurantHospitalityNCR

ItemPrice is a JSON Structure definition published by Aloha POS, describing 6 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

version price currency effectiveDate status priceId

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aloha-pos/refs/heads/main/json-structure/ncr-voyix-platform-item-price-structure.json",
  "name": "ItemPrice",
  "description": "A price for a catalog item, tied to the item by its item code.",
  "type": "object",
  "properties": {
    "version": {
      "type": "int32",
      "description": "Optimistic-concurrency version; must increase on each update."
    },
    "price": {
      "type": "double",
      "description": "The price amount."
    },
    "currency": {
      "type": "string",
      "description": "Currency of the price.",
      "default": "US Dollar"
    },
    "effectiveDate": {
      "type": "datetime",
      "description": "When the price becomes effective."
    },
    "status": {
      "type": "string",
      "description": "Price lifecycle status.",
      "enum": [
        "ACTIVE",
        "INACTIVE"
      ]
    },
    "priceId": {
      "type": "object",
      "description": "Identifier tying the price to its item.",
      "properties": {
        "itemCode": {
          "type": "string"
        }
      }
    }
  },
  "required": [
    "version",
    "price"
  ]
}