NCR · Schema

ItemInput

ItemInput schema from NCR Voyix Commerce Platform APIs

RestaurantRetailBankingATMPoint of SaleCommerceFortune 500

Properties

Name Type Description
version integer Optimistic-concurrency version; must increase on each update.
itemId object
shortDescription object
longDescription object
status object
merchandiseCategory string
departmentId string
View JSON Schema on GitHub

JSON Schema

ncr-voyix-commerce-platform-item-input-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ItemInput",
  "description": "ItemInput schema from NCR Voyix Commerce Platform APIs",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ncr/refs/heads/main/json-schema/ncr-voyix-commerce-platform-item-input-schema.json",
  "type": "object",
  "properties": {
    "version": {
      "type": "integer",
      "description": "Optimistic-concurrency version; must increase on each update.",
      "example": 1
    },
    "itemId": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "shortDescription": {
      "$ref": "#/components/schemas/LocalizedText"
    },
    "longDescription": {
      "$ref": "#/components/schemas/LocalizedText"
    },
    "status": {
      "$ref": "#/components/schemas/Status"
    },
    "merchandiseCategory": {
      "type": "string",
      "example": "example"
    },
    "departmentId": {
      "type": "string",
      "example": "example"
    }
  },
  "required": [
    "version",
    "status"
  ]
}