Metafields and Metadata

Defining metafields and adding metadata to your products and modifiers

Using metafields for catalog items and catalog groups, we can add metadata of different types to entities in our catalog. This is useful when building a custom integration, or mapping products in Flipdish to a point of sale system, for instance.

To manage metafields and metadata via the Flipdish Portal, see the helpdesk article here.

Sample Payloads

When you add metadata to items in your catalog, the information is sent to two places.

  1. The order webhook events. See sample payloads here
  2. The menu JSON. When products in a menu have metadata, the menu JSON will include a CatalogItems array, containing metadata information for the relevant items

JSON sample below has rest of the object removed for brevity

{
  ...
  "CatalogItems": [
    {
        "CatalogItemId": "p_312892180043702272",
        "Metadata": {
            "custom": {
                "calories": "300",
                "deliciousness": "4/10"
            }
        }
    },
    {
        "CatalogItemId": "p_312892180102422528",
        "Metadata": {
            "custom": {
                "calories": "30"
            }
        }
    },
    {
        "CatalogItemId": "p_312892185378856960",
        "Metadata": {
            "custom": {
                "deliciousness": "9"
            }
        }
    },
    {
        "CatalogItemId": "p_317778078375895040",
        "Metadata": {
            "chris": {
                "notes": "test"
            },
            "custom": {
                "calories": "200",
                "deliciousness": "9/10"
            },
            "customer": {
                "rating": "8"
            },
            "ima": {
                "boolean": "false"
            }
        }
    }
  ]
  ...
}