Revel Systems · JSON Structure

Revel Open Api Product Structure

Product schema from Revel Open API

Type: object Properties: 19

POSRestaurantRetailiPad

Product is a JSON Structure definition published by Revel Systems, describing 19 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id uuid name description price cost barcode sku category active display_online dining_options establishment attribute_parent attribute_type course_number created_date updated_date resource_uri

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

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/revel-systems/refs/heads/main/json-structure/revel-open-api-product-structure.json",
  "name": "Product",
  "description": "Product schema from Revel Open API",
  "type": "object",
  "properties": {
    "id": {
      "type": "int32",
      "example": 1
    },
    "uuid": {
      "type": "uuid",
      "example": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d"
    },
    "name": {
      "type": "string",
      "example": "Cappuccino"
    },
    "description": {
      "type": "string",
      "nullable": true,
      "example": "Premium roast"
    },
    "price": {
      "type": "float",
      "example": 4.99
    },
    "cost": {
      "type": "float",
      "nullable": true,
      "example": 1.0
    },
    "barcode": {
      "type": "string",
      "nullable": true,
      "example": "0123456789012"
    },
    "sku": {
      "type": "string",
      "nullable": true,
      "example": "CAP-001"
    },
    "category": {
      "type": "int32",
      "description": "Foreign key to product category.",
      "example": 1
    },
    "active": {
      "type": "boolean",
      "example": true
    },
    "display_online": {
      "type": "boolean",
      "example": true
    },
    "dining_options": {
      "type": "string",
      "nullable": true,
      "example": "dine_in"
    },
    "establishment": {
      "type": "int32",
      "nullable": true,
      "example": 1
    },
    "attribute_parent": {
      "type": "int32",
      "nullable": true,
      "example": 42
    },
    "attribute_type": {
      "type": "int32",
      "nullable": true,
      "example": 42
    },
    "course_number": {
      "type": "int32",
      "nullable": true,
      "example": 42
    },
    "created_date": {
      "type": "datetime",
      "example": "2026-06-01T12:00:00Z"
    },
    "updated_date": {
      "type": "datetime",
      "example": "2026-06-01T12:00:00Z"
    },
    "resource_uri": {
      "type": "string",
      "example": "/resources/Resource/1/"
    }
  }
}