The Schema

caution

This schema might not be inclusive of all the functionality within certain Integrations with Stream. Ensure to look towards the related integration's API reference and guides for the most accurate information regarding that integration.

The Schema

{
  "$schema": "http://json-schema.org/draft-06/schema#",
  "$ref": "#/definitions/StandardCatalog",
  "definitions": {
    "StandardCatalog": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "objects": {
          "$ref": "#/definitions/Objects"
        }
      },
      "required": ["objects"],
      "title": "StandardCatalog"
    },
    "Objects": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "item": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Item"
          }
        },
        "item_family": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ItemFamily"
          }
        },
        "category": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Category"
          }
        },
        "modifier": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Modifier"
          }
        },
        "modifier_group": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ModifierGroup"
          }
        }
      },
      "required": [
        "category",
        "item",
        "item_family",
        "modifier",
        "modifier_group"
      ],
      "title": "Objects"
    },
    "Category": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "_id": {
          "type": "string",
          "format": "uuid"
        },
        "name": {
          "type": "string"
        },
        "item_family_ids": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uuid"
          }
        }
      },
      "required": ["_id", "item_family_ids", "name"],
      "title": "Category"
    },
    "Item": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "_id": {
          "type": "string",
          "format": "uuid"
        },
        "name": {
          "type": "string"
        },
        "price_amount": {
          "type": "integer",
          "description": "price in lowest denomination (cents)"
        },
        "price_currency": {
          "type": "string"
        }
      },
      "required": ["_id", "name", "price_amount", "price_currency"],
      "title": "Item"
    },
    "ItemFamily": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "_id": {
          "type": "string",
          "format": "uuid"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "images": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Image"
          }
        },
        "item_ids": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uuid"
          }
        },
        "modifier_group_ids": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uuid"
          }
        }
      },
      "required": [
        "_id",
        "description",
        "images",
        "item_ids",
        "modifier_group_ids",
        "name"
      ],
      "title": "ItemFamily"
    },
    "Image": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "url": {
          "type": "string",
          "format": "uri",
          "qt-uri-protocols": ["https"],
          "qt-uri-extensions": [".jpeg"]
        }
      },
      "required": ["url"],
      "title": "Image"
    },
    "Modifier": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "_id": {
          "type": "string",
          "format": "uuid"
        },
        "name": {
          "type": "string"
        },
        "price_amount": {
          "type": "integer"
        },
        "price_currency": {
          "type": "string"
        },
        "min_unique": {
          "type": "integer"
        },
        "max_unique": {
          "type": "integer"
        },
        "modifier_group_ids": {
          "type": "array",
          "items": {}
        }
      },
      "required": [
        "_id",
        "max_unique",
        "min_unique",
        "modifier_group_ids",
        "name",
        "price_amount",
        "price_currency"
      ],
      "title": "Modifier"
    },
    "ModifierGroup": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "_id": {
          "type": "string",
          "format": "uuid"
        },
        "name": {
          "type": "string"
        },
        "modifier_ids": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uuid"
          }
        },
        "default_modifier_quantities": {
          "$ref": "#/definitions/DefaultModifierQuantities"
        },
        "min_unique": {
          "type": "integer"
        },
        "max_unique": {
          "type": "integer"
        },
        "max_free": {
          "type": "integer"
        },
        "selection_type": {
          "type": "string",
          "enum": ["single", "multiple"]
        },
        "is_optional": {
          "type": "boolean"
        }
      },
      "required": [
        "_id",
        "default_modifier_quantities",
        "is_optional",
        "max_free",
        "max_unique",
        "min_unique",
        "modifier_ids",
        "name"
      ],
      "title": "ModifierGroup"
    },
    "DefaultModifierQuantities": {
      "type": "object",
      "additionalProperties": true,
      "properties": {
        "string": {
          "type": "integer",
          "required": false
        }
      },
      "required": [],
      "title": "DefaultModifierQuantities"
    }
  }
}