Flipdish · JSON Structure

Catalog Metafield Definition Structure

Metafield Definition

Type: object Properties: 8 Required: 2
RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

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

Properties

IsReadOnly OwnerEntity Key ValueType Name Description Behaviors MetafieldDefinitionRecommendationId

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-metafield-definition-structure.json",
  "name": "MetafieldDefinition",
  "description": "Metafield Definition",
  "type": "object",
  "properties": {
    "IsReadOnly": {
      "description": "Indicates if a definition can be edited or not",
      "type": "boolean",
      "example": true
    },
    "OwnerEntity": {
      "description": "The Metafield will extend the specified {Flipdish.Metafields.PublicModels.V1.MetafieldDefinitionBase.OwnerEntity}",
      "enum": [
        "CatalogItem",
        "CatalogGroup",
        "Menu"
      ],
      "type": "string",
      "example": "CatalogItem"
    },
    "Key": {
      "description": "Key of the metafield.\r\nThe key must have two parts, separated by a dot. The first part acts as a category, for organizational purposes.\r\nThe parts can be composed of lowercase letters, numbers, hyphen and underscore",
      "type": "string",
      "example": "string"
    },
    "ValueType": {
      "description": "The excepted type for the Value field",
      "enum": [
        "Boolean",
        "Json",
        "SingleLineString",
        "MultiLineString"
      ],
      "type": "string",
      "example": "Boolean"
    },
    "Name": {
      "description": "Field Name",
      "type": "string",
      "example": "Example Name"
    },
    "Description": {
      "description": "Field Description",
      "type": "string",
      "example": "string"
    },
    "Behaviors": {
      "description": "Enable Metafield Behaviors",
      "type": "array",
      "items": {
        "enum": [
          "SendToOrder",
          "SendToMenu"
        ],
        "type": "string"
      },
      "example": [
        "SendToOrder"
      ]
    },
    "MetafieldDefinitionRecommendationId": {
      "description": "Metafield Recommendation Id",
      "type": "int32",
      "nullable": true,
      "example": 500123
    }
  },
  "required": [
    "Key",
    "Name"
  ]
}