Flipdish · JSON Structure

Catalog Create Product Structure

Create a Catalog Item

Type: object Properties: 9 Required: 4
RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

CreateProduct is a JSON Structure definition published by Flipdish, describing 9 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Groups Metafields ProductType Sku Name Description Price ImageFileName Alcohol

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/flipdish/refs/heads/main/json-structure/catalog-create-product-structure.json",
  "name": "CreateProduct",
  "description": "Create a Catalog Item",
  "type": "object",
  "properties": {
    "Groups": {
      "description": "Collection of groups associated with this item",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CreateGroupReference"
      },
      "example": []
    },
    "Metafields": {
      "description": "Collection of metafields",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Metafield"
      },
      "example": []
    },
    "ProductType": {
      "description": "Type of item (Product, Modifier, etc)",
      "enum": [
        "Product",
        "Modifier"
      ],
      "type": "string",
      "example": "Product"
    },
    "Sku": {
      "description": "Stock Keeping Unit (SKU)",
      "maxLength": 30,
      "minLength": 0,
      "type": "string",
      "example": "string"
    },
    "Name": {
      "description": "Product name",
      "maxLength": 300,
      "minLength": 0,
      "type": "string",
      "example": "Example Name"
    },
    "Description": {
      "description": "Product description",
      "maxLength": 3000,
      "minLength": 0,
      "type": "string",
      "example": "string"
    },
    "Price": {
      "description": "Product price",
      "minimum": 0,
      "type": "double",
      "example": 12.5
    },
    "ImageFileName": {
      "description": "Image File Name",
      "maxLength": 512,
      "minLength": 0,
      "type": "string",
      "example": "Example Name"
    },
    "Alcohol": {
      "description": "Product contains alcohol",
      "type": "boolean",
      "example": true
    }
  },
  "required": [
    "ProductType",
    "Sku",
    "Name",
    "Price"
  ]
}