API reference blizzfullMenuSchema.json

Blizzfull Menu (import)

A whole menu, as a point of sale or partner sends it to Blizzfull to create or update a restaurant's menu.

JSON Schema apiv2.blizzfull.com/schema/blizzfullMenuSchema.json Copy on this site

About

How an import works:

Every ID is yours (the sender's): categories, items, sizes, option groups and options. Blizzfull remembers which of its records each of your IDs became, so importing the same IDs again updates those records in place. Keep IDs stable. An option's ID only needs to be unique within its group.
Arrays are ordered: the menu shows categories, items, groups and options in the order you send them.
Prices are dollars as numbers (9.99), not cents.
Option groups are defined once in option_groups and attached to items (or whole categories) by ID through groups. Only groups that something attaches are imported; the same goes for sizes.
Unknown fields are ignored, so you can send extra data.

Used by POST /menu/import (request), POST /menu/importExternalPOSMenu/{posName} (request)

MenuImport

The document object

categoriescategory[]Required
The menu's categories, in display order. Each holds items and, one level deep, subcategories (children).
option_groupsoption_group[]Required
Every option group the menu uses (toppings, sauces, sides, cooking temperatures), defined once and attached to items and categories by ID. Send an empty array when there are none.
sizessize[] | map of sizeRequired
Every size the menu uses (Small, 12", 6 Pcs), defined once and attached to items by ID with a price for each item. Send an empty array when there are none. An object keyed by size ID is also accepted.
merchantobject
Optional settings for the restaurant itself rather than its menu. Sending this changes the live restaurant immediately.
- hoursobject
  When the restaurant takes orders, separately for delivery and pickup.
  - deliverystore_hours
    Ordering hours by weekday, or for one date (MM/DD). Each value is a list of [open, close] ranges in 24-hour HH:MM. A weekday you leave out is closed.
  - pickupstore_hours
    Ordering hours by weekday, or for one date (MM/DD). Each value is a list of [open, close] ranges in 24-hour HH:MM. A weekday you leave out is closed.
  No other keys.
- pausedboolean
  True stops the restaurant taking orders; false resumes.
custom_mapsobject | array
Extra ID mappings a point-of-sale integration keeps with the menu (for example, how its modifier combinations map to its own items). Stored as given; Blizzfull does not interpret it.
enforceSyncCompatibilityinteger
Only for POST /menu/importExternalPOSMenu/{posName}: the menu-sync version you built against. The current version is 1; an import is refused if it doesn't match. Ignored by other imports.

Example: the request body of POST /menu/import (Import a menu)

{
  "categories": [
    {
      "id": "wings",
      "name": "Wings",
      "items": [
        {
          "id": "w6",
          "name": "6 Wings",
          "price": 9.99,
          "tags": [
            "spicy"
          ],
          "groups": [
            {
              "id": "flavors",
              "required": true
            }
          ]
        }
      ]
    }
  ],
  "option_groups": [
    {
      "id": "flavors",
      "name": "Flavor",
      "type": "TYPE_SINGLE_SELECT",
      "options": [
        {
          "id": "buffalo",
          "name": "Buffalo",
          "price": 0
        },
        {
          "id": "lemon-pepper",
          "name": "Lemon Pepper",
          "price": 0.5
        }
      ]
    }
  ],
  "sizes": []
}

id

integer | string

Your ID for the record. Must be stable between imports and must not be 0 or empty.

Used by category.id, item.id, item_size.id, size.id, option_group.id, option.id, option.sub_options.id, option_group_link.id, option_link.id, option_link.sizePriceOverrides.id, option_link.sub_options.id, option_link.sub_options.options.id

images

string | string[]

Image URLs: one string, or an array of strings. Each must be absolute, public and point at an image; Blizzfull downloads them during the import, and a URL that is not an image stops the import.

Example: "https://example.com/images/wings.jpg"

Used by category.imageURL, category.imageUrl, item.imageURL, item.imageUrl

store_hours

object

Ordering hours by weekday, or for one date (MM/DD). Each value is a list of [open, close] ranges in 24-hour HH:MM. A weekday you leave out is closed.

Example: { "monday": [ [ "11:00", "14:30" ], [ "17:00", "21:00" ] ], "12/25": [] }

Used by MenuImport.merchant.hours.delivery, MenuImport.merchant.hours.pickup

Keys matching ^(sunday|monday|tuesday|wednesday|thursday|friday|saturday|\d{2}/\d{2})$time_range[]

No other keys.

time_range

string[]

An [open, close] pair in 24-hour HH:MM.

Example: ["11:00","21:30"]
Length: Exactly 2 items

Used by store_hours.key, category_hours.key

category_hours

object

When a category can be ordered, by weekday: {"monday": [["11:00", "14:45"]]}. Only the first range of each day is used. Times run from 04:00 to 28:00 (4 AM the next morning), and ["00:00", "00:00"] closes the day. A weekday you leave out is closed, so {} hides the category all week. Leave hours out entirely for a category available whenever the restaurant is open.

Used by category.hours

Keys matching ^(sunday|monday|tuesday|wednesday|thursday|friday|saturday)$time_range[]

item

object Menu item

Something a customer can order, with a flat price or a price per size, and the option groups that customize it.

Used by category.items

ididRequired
Your ID for the record. Must be stable between imports and must not be 0 or empty.
namestringRequired
descriptionstring | null
pricenumberRequired
The base price in dollars. For a sized item, each size's price is added to this.
Example
12.5
activeboolean | integer
true (or left out): on the menu. false: hidden. A Unix timestamp: sold out (86'd) until then. 0: sold out until turned back on.
Examples
true 1793142409
availableDatesobject[]
Limits the item to date windows, in the restaurant's time zone. Both dates are included. Leave it out for an item available every day.
Example
[{"start":"2026-11-26","end":"2026-12-31"}]
- startstringRequired
  First day, YYYY-MM-DD.
  Pattern
  ^\d{4}-\d{2}-\d{2}$
- endstringRequired
  Last day, YYYY-MM-DD.
  Pattern
  ^\d{4}-\d{2}-\d{2}$
tagsstring[]
Dietary and other badges. Recognized: spicy, specialty, vegan, gf (gluten free), keto, alcoholic, and the upper-case forms HOT, SPICY, SPECIALTY, VEGAN, GLUTEN_FREE. Anything else is ignored, including vegetarian: send vegan.
Example
["spicy","gf"]
imageURLimages
Image URLs: one string, or an array of strings. Each must be absolute, public and point at an image; Blizzfull downloads them during the import, and a URL that is not an image stops the import.
imageUrlimages
Older spelling of imageURL, used when imageURL is absent.
sizesitem_size[]
The sizes this item comes in, each with its price for this item. The item's displayed price becomes its cheapest size.
groupsoption_group_link[]Required
The option groups that customize this item, in display order. Send an empty array when there are none.
skustring
Your SKU, kept for loyalty-program matching.
loyaltyMapstring
Loyalty-program product codes for the item, comma separated.
Example
"478730,478734"
loyaltyTagsstring[] | string
Loyalty-program tags for the item: an array, or one comma-separated string.

item_size

object Item size

One size of this item and what it adds to the item's price.

Used by item.sizes

ididRequired
A size from the top-level sizes, or a new size defined here with name.
pricenumberRequired
Dollars added to the item's price for this size. With a base price of 5 and a size price of 1, the size costs 6.
namestring
The size's name, when it is not in the top-level sizes.

size

object Size

A size, priced per item where items attach it.

Used by MenuImport.sizes

ididRequired
Your ID for the record. Must be stable between imports and must not be 0 or empty.
namestring
Example
"Large 16\""

option_group

object Option group

A set of choices, such as wing flavors or burger toppings. How customers choose depends on type.

Used by MenuImport.option_groups

ididRequired
Your ID for the record. Must be stable between imports and must not be 0 or empty.
namestringRequired
typestring
TYPE_SINGLE_SELECT: pick one. TYPE_MULTI_SELECT: pick any. TYPE_UNIT_STEPPER: pick a quantity of each. TYPE_VARIABLE_AMOUNT: pick a level of each (light, regular, extra). When left out, it is inferred: allow_quantity above 0 makes a stepper, force_min and force_max both 1 make a single select, anything else a multi select.
One of
"TYPE_SINGLE_SELECT" "TYPE_MULTI_SELECT" "TYPE_UNIT_STEPPER" "TYPE_VARIABLE_AMOUNT"
allow_quantitynumber
Used only to infer type when it is absent: above 0 means a unit stepper.
force_minnumber
Used only to infer type when it is absent. Set limits per item on the group link instead.
force_maxnumber
Used only to infer type when it is absent. Set limits per item on the group link instead.
optionsoption[]Required
The choices, in display order. Send an empty array for a group with none.

option

object Option

One choice in an option group, such as Buffalo or Extra Cheese.

Used by option_group.options

ididRequired
Your ID for the option, unique within its group.
namestringRequired
pricenumberRequired
What the option adds, in dollars. May be 0 or negative.
inactiveEndsnumber
Sold out until this Unix time. Leave it out for an available option. Applied when an existing option is updated, not when it is first created.
min_unitsinteger
For a TYPE_UNIT_STEPPER group: the fewest of this option a customer may choose.
max_unitsinteger
For a TYPE_UNIT_STEPPER group: the most of this option a customer may choose.
sub_optionsobject[]
Option groups that open when this option is chosen (choosing Burger opens Cooking temperature). Each group must be in option_groups and also attached through some item's group link options[].sub_options, or it is skipped.
- ididRequired
  An option group's ID.
sortnumberDeprecated
Ignored: options keep the order they are sent in.

option_group_link

object Option group link

Attaches an option group to an item or category, with any rules and defaults for that item.

Used by category.groups, item.groups

ididRequired
The option group's ID.
requiredboolean | integer | string
True means the customer must choose from this group. Also accepts 1, "1" and "true".
force_minnumber
For multi-select groups, the fewest options a customer must choose; for unit steppers, the fewest units. Ignored for single-select and variable-amount groups.
force_maxnumber
For multi-select groups, the most options a customer may choose; for unit steppers, the most units in total. Ignored for single-select and variable-amount groups.
free_optionsnumber
How many choices are included free before options start costing extra. Options selected by default don't count. Ignored for single-select groups.
optionsoption_link[]
Per-item settings for particular options of the group: defaults, size prices and nested groups. It does not limit which options appear; every option in the group is offered.

option_link

object Option settings for an item

Settings for one option of the group, on this item only.

Used by option_group_link.options

ididRequired
The option's ID within the group.
defaultinteger | boolean
Pre-selects the option: the quantity or level, or true. 0 or false leaves it unselected. A single-select group with no defaults pre-selects its first option.
sizePriceOverridesobject[]
This option's price when the item is a given size.
- ididRequired
  The size's ID.
- pricenumber | stringRequired
  The option's price in dollars for this size, a percentage of its normal price as a string ("50%"), or -9999 to make the option unavailable in this size.
  Examples
  1.5 "50%" -9999
sub_optionsobject[]
Nested groups this option opens on this item, with their defaults. This is what attaches a nested group.
- ididRequired
  The nested option group's ID.
- optionsobject[]
  Defaults inside the nested group.
  - ididRequired
    Your ID for the record. Must be stable between imports and must not be 0 or empty.
  - defaultinteger | boolean