Get Menus

Description

取得菜單列表。

Resource

GET /manager/v1/product/menus

Authorization

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

Query Parameters

Name	Type	Description
company_id	string	公司編號
shop_id	string	門市編號

Request Example

GET /manager/v1/product/menus?company_id=18090377&shop_id=000030

Response Body Parameters

Name	Type	Description
menus	Menu[]	菜單列表

Response Body Parameters - Menu

Name	Type	Description
platform_id	string	平台編號
platform_name	string	平台名稱
id	integer	菜單編號
name	string	菜單名稱
usage_period	list[string]	菜單使用週期 ALLOWED VALUES: MON: 週一 TUE: 週二 WED: 週三 THU: 週四 FRI: 週五 SAT: 週六 SUN: 週日
usage_begin_time	string	菜單使用起始時間
usage_end_time	string	菜單使用結束時間
sync_type	string	菜單同步類型 ALLOWED VALUES: PENDING: 完成但不啟用 IMMEDIATELY: 立即啟用菜單 SCHEDULE: 排程啟用菜單
sync_date	string	菜單同步時間 (option)
stop_usage_date	string	菜單停用時間 (option)
menu_status	string	菜單狀態 ALLOWED VALUES: STAGING_1: 暫存第1步 STAGING_2: 暫存第2步 COMPLETED: 已完成 < IN_USE: 使用中
sync_status	string	菜單同步狀態 ALLOWED VALUES: ON_SYNC: 同步中 SYNC_FAIL: 同步失敗 SYNC_SUCCESS: 同步成功 (option)
can_sync_to_platform	boolean	是否可同步至平台
can_copy	boolean	是否可複製
can_view_records	boolean	是否可查看使用歷程

Response

Status-Code: 200

{
  "menus": [
    {
      "platform_id": "001",
      "platform_name": "UberEats",
      "id": 1,
      "name": "UberEats_全時段菜單",
      "usage_period": [
        "MON",
        "TUE",
        "WED",
        "THU",
        "FRI",
        "SAT",
        "SUN"
      ],
      "usage_begin_time": "10:00",
      "usage_end_time": "20:00",
      "sync_type": "SCHEDULE",
      "sync_date": "2024-09-18 05:00:00",
      "stop_usage_date": null,
      "menu_status": "IN_USE",
      "sync_status": "SYNC_SUCCESS",
      "can_sync_to_platform": true,
      "can_copy": true,
      "can_view_records": true
    },
    {
      "platform_id": "001",
      "platform_name": "UberEats",
      "id": 2,
      "name": "UberEats_特殊時段菜單",
      "usage_period": [
        "FRI",
        "SAT"
      ],
      "usage_begin_time": "22:00",
      "usage_end_time": "02:00",
      "sync_type": null,
      "sync_date": null,
      "stop_usage_date": null,
      "menu_status": "STAGING_2",
      "sync_status": null,
      "can_sync_to_platform": false,
      "can_copy": true,
      "can_view_records": true
    }
  ]
}