Menu

API reference · Schema

StorefrontMenuResponse

StorefrontMenuResponsecontract storefront.menu.response
  • outlet_idUuid7required
  • channel_idUuid7required
  • channel_kindone of 2required
  • brandsarray of objectrequired
    • brand_idUuid7required
    • namestringrequired
  • prices_include_taxbooleanrequired
  • acceptingStorefrontAcceptingResponserequired
  • itemsarray of objectrequired
    • item_idUuid7required
    • name_keystringrequired
      pattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
    • display_namestring | nullrequired
    • descriptionstring | nullrequired
    • dietenum (4) | nullrequired
      vegnon_vegeggvegan
    • categorystringrequired
    • brand_idUuid7 | nullrequired
    • kindenum (3)required
      dishskucombo
    • availablebooleanrequired
    • price_minorinteger | nullrequired
      ≥ -9007199254740991≤ 9007199254740991
    • currencystringrequired
      pattern ^[A-Z]{3}$
    • variantsarray of objectrequired
      • variant_idUuid7required
      • name_keystringrequired
        pattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
      • display_namestring | nullrequired
      • descriptionstring | nullrequired
      • availablebooleanrequired
      • price_minorintegerrequired
        ≥ -9007199254740991≤ 9007199254740991
    • option_groupsarray of objectrequired
      • option_group_idUuid7required
      • name_keystringrequired
        pattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
      • display_namestring | nullrequired
      • descriptionstring | nullrequired
      • min_selectintegerrequired
        ≥ 0≤ 9007199254740991
      • max_selectintegerrequired
        ≥ 1≤ 9007199254740991
      • requiredbooleanrequired
      • optionsarray of objectrequired
        Show fields of options
        • option_idUuid7required
        • name_keystringrequired
          pattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
        • display_namestring | nullrequired
        • descriptionstring | nullrequired
        • price_delta_minorintegerrequired
          ≥ -9007199254740991≤ 9007199254740991
  • dealsarray of objectrequired
    • deal_idUuid7required
    • name_keystringrequired
      pattern ^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$
    • kindstringrequired
    • windowsarray of objectrequired
      • daysarray of integerrequired
        min items 1max items 7
      • fromstringrequired
        pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$
      • tostringrequired
        pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$
    • valid_fromstring (date)required
      pattern ^(?:(?:[0-9][0-9][2468][048]|[0-9][0-9][13579][26]|[0-9][0-9]0[48]|[02468][048]00|[13579][26]00)-02-29|[0-9]{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12][0-9]|3[01])|(?:0[469]|11)-(?:0[1-9]|[12][0-9]|30)|(?:02)-(?:0[1-9]|1[0-9]|2[0-8])))$
    • valid_tostring (date) | nullrequired
      pattern ^(?:(?:[0-9][0-9][2468][048]|[0-9][0-9][13579][26]|[0-9][0-9]0[48]|[02468][048]00|[13579][26]00)-02-29|[0-9]{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12][0-9]|3[01])|(?:0[469]|11)-(?:0[1-9]|[12][0-9]|30)|(?:02)-(?:0[1-9]|1[0-9]|2[0-8])))$
  • pay_at_counterconst truerequired
  • pay_at_counter_methodsarray of enum (3) | nullrequired

Used by