NCR · JSON Structure

Ncr Voyix Commerce Platform Order Structure

Order schema from NCR Voyix Commerce Platform APIs

Type: object Properties: 6 Required: 1
RestaurantRetailBankingATMPoint of SaleCommerceFortune 500

Order is a JSON Structure definition published by NCR, describing 6 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

channel comments customer orderLines id status

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

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "description": "Order schema from NCR Voyix Commerce Platform APIs",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ncr/refs/heads/main/json-structure/ncr-voyix-commerce-platform-order-structure.json",
  "type": "object",
  "properties": {
    "channel": {
      "type": "string",
      "example": "Web"
    },
    "comments": {
      "type": "string",
      "example": "Customer request"
    },
    "customer": {
      "$ref": "#/components/schemas/Customer"
    },
    "orderLines": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/OrderLine"
      }
    },
    "id": {
      "type": "string"
    },
    "status": {
      "type": "string"
    }
  },
  "required": [
    "orderLines"
  ],
  "name": "Order"
}