Return to documentation index

Filter Examples

This page contains some examples of the generated JSON for various possible billboard button and small button filtering combinations.

Underlying Data

These examples assume the following information:

• BeverageSkuList id 1 is a wine List
• BeverageSkuList id 2 is a beer list
• BeverageSkuList id 3 is a spirit list
• Menu id 1 is a dinner menu
• MenuSection id 1 is an appetizers section on the dinner menu
• MenuSection id 2 is an entrees section on the dinner menu
• BeverageSkuListGroup id 1 is a Chardonnay section on the wine list
• BeverageSkuListGroup id 2 is a Merlot section on the wine list
• Tag value -1 has the value "Recommended" (NOTE: This is a reserved value that is the same for all accounts.)
• Tag value 2 has the value "Organic"
• Tag value 3 has the value "Local"

Simple Button to a Beverage List

A single button that links to the entire wine list:

{
  "button_list_type": 0,
  "caption": "wines",
  "ordinal": 1,
  "button_list_id": 1,
  "button_type": 0,
  "icon": 0,
  "icon_url": null,
  "filters": [
    {
      "filter_type": 0
      "tags": null,
      "sections": null,
      "units": null
    }
  ],
  "small_buttons": [
  ]
}

Simple Button to a Menu

A single button that links to the dinner menu:

{
  "button_list_type": 1,
  "caption": "dinner",
  "ordinal": 1,
  "button_list_id": 1,
  "button_type": 0,
  "icon": 3,
  "icon_url": null,
  "filters": [
    {
      "filter_type": 0
      "tags": null,
      "sections": null,
      "units": null
    }
  ],
  "small_buttons": [
  ]
}

Simple Button to a Beverage Group

A single button that links to the chardonnays:

{
  "button_list_type": 0,
  "caption": "chardonnays",
  "ordinal": 1,
  "button_list_id": 1,
  "button_type": 0,
  "icon": 0,
  "icon_url": null,
  "filters": [
    {
      "filter_type": 6
      "tags": null,
      "sections": [
        1
      ],
      "units": null
    }
  ],
  "small_buttons": [
  ]
}

Simple Button to a Size of Beverage

A single button that links to the wine bottles:

{
  "button_list_type": 0,
  "caption": "by the bottle",
  "ordinal": 1,
  "button_list_id": 1,
  "button_type": 0,
  "icon": 0,
  "icon_url": null,
  "filters": [
    {
      "filter_type": 7
      "tags": null,
      "sections": null,
      "units": [
        -2
      ]
    }
  ],
  "small_buttons": [
  ]
}

Simple Button to a Multiple Beverage Sizes

A single button that links to the wine demis and 500mL bottles:

{
  "button_list_type": 0,
  "caption": "by the bottle",
  "ordinal": 1,
  "button_list_id": 1,
  "button_type": 0,
  "icon": 0,
  "icon_url": null,
  "filters": [
    {
      "filter_type": 7
      "tags": null,
      "sections": null,
      "units": [
        3,
        4
      ]
    }
  ],
  "small_buttons": [
  ]
}

Simple Button to a Tagged Set of Beverages

A single button that links to all organic and local beers:

{
  "button_list_type": 0,
  "caption": "local and organic",
  "ordinal": 1,
  "button_list_id": 2,
  "button_type": 0,
  "icon": 1,
  "icon_url": null,
  "filters": [
    {
      "filter_type": 5
      "tags": [
        2,
        3
      ],
      "sections": null,
      "units": null
    }
  ],
  "small_buttons": [
  ]
}

Simple Button to Featured Beverages

A single button that links to all featured spirits. Note that this is just a special case of tag filtering:

{
  "button_list_type": 0,
  "caption": "featured",
  "ordinal": 1,
  "button_list_id": 3,
  "button_type": 0,
  "icon": 1,
  "icon_url": null,
  "filters": [
    {
      "filter_type": 5
      "tags": [
        -1
      ],
      "sections": null,
      "units": null
    }
  ],
  "small_buttons": [
  ]
}

Simple Button with multiple filters

A single button that links to the organic chardonnays:

{
  "button_list_type": 0,
  "caption": "organic chardonnays",
  "ordinal": 1,
  "button_list_id": 1,
  "button_type": 0,
  "icon": 0,
  "icon_url": null,
  "filters": [
    {
      "filter_type": 6
      "tags": null,
      "sections": [
        1
      ],
      "units": null
    },
    {
      "filter_type": 5
      "tags": [
        1
      ],
      "sections": null,
      "units": null
    }
  ],
  "small_buttons": [
  ]
}

Compound Button

A compound button for the wine list, with small buttons allowing the choice of by the bottle or by the glass. Small buttons may specify the same list as their parent button, or a different list.

{
"button_list_type": 0,
"caption": "wine",
"ordinal": 1,
"button_list_id": 1,
"button_type": 0,
"icon": 0,
"icon_url": null,
"filters": [
  {
    "filter_type": 0
    "tags": null,
    "sections": null,
    "units": null
  }
],
"small_buttons": [
  {
    "button_type": 2,
    "caption": "by the glass",
    "ordinal": 1,
    "filters": [
      {
        "filter_type": 7
        "tags": null,
        "sections": null,
        "units": [
          -1
        ]
      }
    ],
    "icon": 5,
    "icon_url": null,
    "button_list_id": 1,
    "button_list_type": 0
  },
  {
    "button_type": 2,
    "caption": "by the bottle",
    "ordinal": 2,
    "filters": [
      {
        "filter_type": 7
        "tags": null,
        "sections": null,
        "units": [
          -2
        ]
      }
    ],
    "icon": 6,
    "icon_url": null,
    "button_list_id": 1,
    "button_list_type": 0
  }
]

}