Skip to content

Wixtar Omni Private Docs

Get Active Menus

Get Activate Menus

Description

取得啟用中的菜單群組清單，以及各菜單群組底下的菜單表頭資料。只會回傳 menu_group.usage_status = IN_USE 的資料。

Resource

GET /v1/product/active_menus

Authorization

採用 OAuth 2.0 Bearer Token，詳細使用流程請參考 Auth Login。

Query Parameters

Name	Type	Description
store_id	string	門市編號。 (optional) (註：非必填。若帶入，只回傳該門市適用的菜單群組；若未帶入，則不限制門市)
client_device	string	銷售方式 ALLOWED VALUES: KIOSK PWA EC_QUICK_ORDER
menu_group_id	string	多菜單群組 ID。 (optional) (註：若帶入此參數，將忽略菜單啟停狀態，直接回傳此群組內的所有菜單)

Request Example

GET /v1/product/active_menus?store_id=STORE001&client_device=KIOSK

Response Body Parameters

Name	Type	Description
menu_groups	Active Menu Group[]	啟用中菜單群組清單

Name	Type	Description
menu_group_id	string	菜單群組編號
applicable_shop_ids	list[string]	適用門市編號清單
platform_id	string	平台編號
menu_group_name	string	菜單群組名稱
usage_status	string	菜單群組使用狀態，固定為 `IN_USE`
menu_template_shop_id	string	菜單範本門市編號
menu_group_position	integer	菜單群組排序
menu_headers	Active Menu Header[]	菜單表頭清單

Name	Type	Description
menu_id	string	菜單編號
menu_name	string	菜單名稱
menu_status	string	菜單狀態
menu_sale_methods	list[string]	菜單銷售方式
menu_usage_begin_time	string	菜單起始時間，格式為 `HH:mm`
menu_usage_end_time	string	菜單結束時間，格式為 `HH:mm`
menu_usage_period	list[integer]	菜單週期，1 為週一，7 為週日
menu_position	integer	菜單排序

Response Example

{
  "menu_groups": [
    {
      "menu_group_id": "MG00000001",
      "applicable_shop_ids": [
        "000030",
        "000031"
      ],
      "platform_id": "KIOSK",
      "menu_group_name": "日常檔期菜單群組",
      "usage_status": "IN_USE",
      "menu_template_shop_id": "000030",
      "menu_group_position": 1,
      "menu_headers": [
        {
          "menu_id": "M00000001",
          "menu_name": "預設菜單",
          "menu_status": "COMPLETED",
          "menu_sale_methods": [
            "DINE_IN",
            "PICK_UP"
          ],
          "menu_usage_begin_time": "00:00",
          "menu_usage_end_time": "23:59",
          "menu_usage_period": [
            1,
            2,
            3,
            4,
            5,
            6,
            7
          ],
          "menu_position": 9999
        }
      ]
    }
  ]
}