Get Default Menu
Description
取得預設菜單，當使用者在菜單維護頁面點擊新增時，會請求此 API。
Resource
GET /v1/product/default_menu
Authorization
採用 OAuth 2.0 Bearer Token，詳細使用流程請參考 Auth Login。
Query Parameters
| Name | Type | Description |
|---|---|---|
| company_id | string | 公司編號 |
| shop_id | string | 門市編號 |
Request Example
GET /v1/product/default_menu?company_id=18090377&shop_id=000030
Response Body Parameters
| Name | Type | Description |
|---|---|---|
| category | Category[] | 商品類別 |
Response Body Parameters - Category
| Name | Type | Description |
|---|---|---|
| id | string | 全通路類別編號 |
| pos_dep_id | string | POS 類別編號 |
| name | string | 類別名稱 |
| image_url | string | 類別圖片 |
| enable | boolean | 是否啟用 |
| is_combo | boolean | 是否為套餐 |
| is_package | boolean | 是否為系列組合 |
| is_coupon | boolean | 是否為票券 |
| position | integer | 排序編號 |
| products | Product[] | 商品列表 |
Response Body Parameters - Product
| Name | Type | Description |
|---|---|---|
| id | string | 商品編號 |
| name | string | 商品名稱 |
| short_name | string | 商品名稱縮寫 |
| sale_start | string | 銷售時間起 |
| sale_end | string | 銷售時間迄 |
| memo | string | 商品備註 |
| gencods | array | 商品國際條碼 |
| tax | float | 商品稅額 |
| tax_sign | string | 商品稅別 |
| price | float | 商品價格 |
| enable | boolean | 是否啟用 |
| is_combo_item | boolean | 是否為套餐子項目 |
| is_float | boolean | 是否為浮動價 |
| can_get_points | boolean | 是否可累積點數 |
| can_redeemed | boolean | 是否可用點數兌換 |
| pack_price_type | string | 系列組合價格方式 ALLOWED VALUES:
|
| type | string (enum) |
商品類型 ALLOWED VALUES:
|
| promotion_content | string | 促銷內容 |
| description | string | 描述 |
| is_stop_sale | boolean | 是否停售 |
| member_discount_rate | float | 會員折扣率 |
| combo_price | float | 套餐價格 |
| package_price | float | 系列組合價格 |
| special_price | float | 特價價格 |
| single_price | float | 單品金額(單品原價金額+預選加值金額) (optional) |
| default_data_price | float | 預設資料金額(預選品項金額+預選加值金額) (optional) |
| image_url | string | 商品圖片網址 |
| position | integer | 排序編號 |
| combos | Combo[] | 套餐內容 |
| packs | Pack[] | 系列組合內容 |
| tastes | Taste[] | 加值列表 |
Response Body Parameters - Combo
| Name | Type | Description |
|---|---|---|
| id | int | 套餐商品編號 |
| name | string | 套餐商品名稱 |
| is_multiple_choice | boolean | 套餐是否多選 |
| control_quantity | boolean | 套餐控管數量 (若為多選才會判斷此參數) |
| group_name | string | 套餐群組名稱 |
| group_min_quantity | integer | 套餐群組最低可選數量 (若為多選才會判斷此參數) |
| group_max_quantity | integer | 套餐群組最高可選數量 (若為多選才會判斷此參數) |
| item_max_quantity | integer | 套餐品項最高可選數量 (若為多選才會判斷此參數) |
| limitations | Limitations | 套餐商品限量資訊 |
| items | Combo Item[] | 套餐項目 |
Response Body Parameters - Limitations
| Name | Type | Description |
|---|---|---|
| quantity | integer | 數量 |
| start_date | string | 起始時間 |
| end_date | string | 結束時間 |
Response Body Parameters - Combo Item
| Name | Type | Description |
|---|---|---|
| id | string | 商品編號 |
| name | string | 商品名稱 |
| image_url | string | 圖片網址 |
| price | float | 商品價格 |
| quantity | integer | 商品數量 |
| is_default | boolean | 是否為預設商品 |
| is_hidden | boolean | 是否隱藏倉品 |
| is_stop_sale | boolean | 是否停售 |
| tastes | Taste[] | 加值列表 |
Response Body Parameters - Pack
| Name | Type | Description |
|---|---|---|
| id | string | 系列組合商品編號 |
| name | string | 系列組合商品名稱 |
| pack_suit_id | string | 系列組合編號 |
| image_url | string | 圖片網址 |
| pack_price_type | string | 系列組合價格類型 ALLOWED VALUES:
|
| quantity | integer | 數量 |
| price | float | 單價 |
| items | Pack Item[] | 系列組合項目 |
Response Body Parameters - Pack Item
| Name | Type | Description |
|---|---|---|
| id | string | 系列組合項目編號 |
| name | string | 系列組合項目名稱 |
| image_url | string | 圖片網址 |
| price | float | 價格 |
| plus_price | float | 加價 |
| default_quantity | integer | 預設數量 |
| is_stop_sale | boolean | 是否停售 |
| tastes | Taste[] | 加值列表 |
Response Body Parameters - Taste
| Name | Type | Description |
|---|---|---|
| id | integer | 加值編號 |
| name | string | 加值名稱 |
| kind | string | 加值種類 |
| max_quantity | integer | 最大數量 |
| is_mutually_exclusive | boolean | 是否互斥 |
| is_required | boolean | 是否必填 |
| default_taste_item_id | integer | 預設加值項目編號 |
| items | Taste Item[] | 加值項目 |
Response Body Parameters - Taste Item
| Name | Type | Description |
|---|---|---|
| id | integer | 加值項目編號 |
| name | string | 加值項目名稱 |
| price | integer | 加值項目價格 |
Response
Status-Code: 200
{
"category": [
{
"id": "2772",
"pos_dep_id": "UC000",
"name": "主食",
"image_url": null,
"enable": true,
"is_combo": false,
"is_package": false,
"is_coupon": false,
"position": 72,
"products": [
{
"id": "UC06000002",
"name": "炸雞腿飯★",
"short_name": "炸腿飯★",
"sale_start": null,
"sale_end": null,
"memo": null,
"gencods": [
"1101",
"2202"
],
"tax": 0.05,
"tax_sign": null,
"price": 110.0,
"enable": true,
"is_combo_item": false,
"is_float": false,
"can_get_points": false,
"can_redeemed": false,
"pack_price_type": "PRODUCT",
"type": "GENERAL_PRODUCT",
"promotion_content": null,
"description": null,
"is_stop_sale": false,
"member_discount_rate": null,
"combo_price": null,
"package_price": null,
"special_price": null,
"single_price": 120.0,
"default_data_price": 10.0,
"image_url": null,
"position": 9999,
"combos": null,
"packs": null,
"tastes": [
{
"id": 3,
"name": "飯",
"kind": "0",
"max_quantity": 5,
"is_mutually_exclusive": false,
"is_required": false,
"default_taste_item_id": 7,
"items": [
{
"id": 1,
"name": "不加辣蘿蔔",
"price": 0
},
{
"id": 2,
"name": "不加玉米",
"price": 0
},
{
"id": 3,
"name": "+滷汁",
"price": 0
},
{
"id": 4,
"name": "不要飯",
"price": 0
},
{
"id": 5,
"name": "飯少",
"price": 0
},
{
"id": 6,
"name": "飯多",
"price": 0
},
{
"id": 7,
"name": "加購雞滷醬",
"price": 10
}
]
},
{
"id": 4,
"name": "切塊",
"kind": "0",
"max_quantity": null,
"is_mutually_exclusive": false,
"is_required": false,
"default_taste_item_id": null,
"items": [
{
"id": 1,
"name": "要切",
"price": 0
},
{
"id": 2,
"name": "切小塊",
"price": 0
},
{
"id": 3,
"name": "主食裝一起",
"price": 0
}
]
},
{
"id": 5,
"name": "環保餐具",
"kind": "0",
"max_quantity": 3,
"is_mutually_exclusive": false,
"is_required": false,
"default_taste_item_id": null,
"items": [
{
"id": 1,
"name": "自備餐具",
"price": 0
},
{
"id": 2,
"name": "環保餐具-主食分開裝",
"price": 0
},
{
"id": 3,
"name": "環保餐具-主食放一起",
"price": 0
}
]
},
{
"id": 13,
"name": "超值加購-白飯",
"kind": "0",
"max_quantity": null,
"is_mutually_exclusive": false,
"is_required": false,
"default_taste_item_id": null,
"items": [
{
"id": 1,
"name": "白飯",
"price": 10
}
]
}
]
}
]
},
{
"id": "2789",
"pos_dep_id": "UC100",
"name": "套餐",
"image_url": null,
"enable": true,
"is_combo": true,
"is_package": false,
"is_coupon": false,
"position": 72,
"products": [
{
"id": "UC10000001",
"name": "炸雞腿飯★",
"short_name": "A餐-雞腿飯",
"sale_start": null,
"sale_end": null,
"memo": null,
"gencods": null,
"tax": 0.05,
"tax_sign": null,
"price": 95.0,
"enable": true,
"is_combo_item": false,
"is_float": false,
"can_get_points": false,
"can_redeemed": false,
"pack_price_type": "PRODUCT",
"type": "GENERAL_PRODUCT",
"promotion_content": null,
"description": null,
"is_stop_sale": false,
"member_discount_rate": null,
"combo_price": 205.0,
"package_price": null,
"special_price": null,
"single_price": 0.0,
"default_data_price": 110.0,
"image_url": null,
"position": 1,
"combos": [
{
"id": 1,
"name": "主食",
"is_multiple_choice": false,
"control_quantity": false,
"group_name": "主食",
"group_min_quantity": 0,
"group_max_quantity": 0,
"item_max_quantity": 0,
"limitations": null,
"items": [
{
"id": "UC06000002",
"name": "炸雞腿飯★",
"image_url": "",
"quantity": 1.0,
"price": 0.0,
"is_default": true,
"is_hidden": false,
"is_stop_sale": false,
"tastes": [
{
"id": 3,
"name": "飯",
"kind": "0",
"max_quantity": 5,
"is_mutually_exclusive": false,
"is_required": false,
"default_taste_item_id": 7,
"items": [
{
"id": 1,
"name": "不加辣蘿蔔",
"price": 0
},
{
"id": 2,
"name": "不加玉米",
"price": 0
},
{
"id": 3,
"name": "+滷汁",
"price": 0
},
{
"id": 4,
"name": "不要飯",
"price": 0
},
{
"id": 5,
"name": "飯少",
"price": 0
},
{
"id": 6,
"name": "飯多",
"price": 0
},
{
"id": 7,
"name": "加購雞滷醬",
"price": 10
}
]
},
{
"id": 4,
"name": "切塊",
"kind": "0",
"max_quantity": null,
"is_mutually_exclusive": false,
"is_required": false,
"default_taste_item_id": null,
"items": [
{
"id": 1,
"name": "要切",
"price": 0
},
{
"id": 2,
"name": "切小塊",
"price": 0
},
{
"id": 3,
"name": "主食裝一起",
"price": 0
}
]
},
{
"id": 5,
"name": "環保餐具",
"kind": "0",
"max_quantity": 3,
"is_mutually_exclusive": false,
"is_required": false,
"default_taste_item_id": null,
"items": [
{
"id": 1,
"name": "自備餐具",
"price": 0
},
{
"id": 2,
"name": "環保餐具-主食分開裝",
"price": 0
},
{
"id": 3,
"name": "環保餐具-主食放一起",
"price": 0
}
]
},
{
"id": 13,
"name": "超值加購-白飯",
"kind": "0",
"max_quantity": null,
"is_mutually_exclusive": false,
"is_required": false,
"default_taste_item_id": null,
"items": [
{
"id": 1,
"name": "白飯",
"price": 10
}
]
}
]
},
{
"id": "UC06100012",
"name": "玫瑰油雞腿飯",
"image_url": "https://portal-dev.wixtar.com/kiosk/apptest/public/product00/142465-1-1611820710_s.jpg",
"quantity": 1.0,
"price": 15.0,
"is_default": false,
"is_hidden": false,
"is_stop_sale": false,
"tastes": [
{
"id": 3,
"name": "飯",
"kind": "0",
"max_quantity": null,
"is_mutually_exclusive": false,
"is_required": false,
"default_taste_item_id": null,
"items": [
{
"id": 1,
"name": "不加辣蘿蔔",
"price": 0
},
{
"id": 2,
"name": "不加玉米",
"price": 0
},
{
"id": 3,
"name": "+滷汁",
"price": 0
},
{
"id": 4,
"name": "不要飯",
"price": 0
},
{
"id": 5,
"name": "飯少",
"price": 0
},
{
"id": 6,
"name": "飯多",
"price": 0
},
{
"id": 7,
"name": "加購雞滷醬",
"price": 10
}
]
},
{
"id": 13,
"name": "超值加購-白飯",
"kind": "0",
"max_quantity": null,
"is_mutually_exclusive": false,
"is_required": false,
"default_taste_item_id": null,
"items": [
{
"id": 1,
"name": "白飯",
"price": 10
}
],
"default": {
"id": 1,
"name": "白飯",
"price": 10
}
}
]
}
]
},
{
"id": 2,
"name": "飲品",
"is_multiple_choice": false,
"control_quantity": false,
"group_name": "飲品",
"group_min_quantity": 0,
"group_max_quantity": 0,
"item_max_quantity": 0,
"items": [
{
"id": "UC05000001",
"name": "檸檬紅茶",
"image_url": "https://portal-dev.wixtar.com/kiosk/apptest/public/product00/142445-1-1611815376_s.jpg",
"quantity": 1.0,
"price": 0.0,
"is_default": true,
"is_hidden": false,
"is_stop_sale": false,
"tastes": [
{
"id": 1,
"name": "外帶",
"kind": "0",
"max_quantity": null,
"is_mutually_exclusive": true,
"is_required": false,
"default_taste_item_id": null,
"items": [
{
"id": 1,
"name": "內用",
"price": 0
},
{
"id": 2,
"name": "外帶",
"price": 0
}
]
},
{
"id": 5,
"name": "環保餐具",
"kind": "0",
"max_quantity": null,
"is_mutually_exclusive": false,
"is_required": false,
"default_taste_item_id": null,
"items": [
{
"id": 1,
"name": "自備餐具",
"price": 0
},
{
"id": 2,
"name": "環保餐具-主食分開裝",
"price": 0
},
{
"id": 3,
"name": "環保餐具-主食放一起",
"price": 0
}
]
},
{
"id": 25,
"name": "冰塊",
"kind": "0",
"max_quantity": null,
"is_mutually_exclusive": true,
"is_required": false,
"default_taste_item_id": 1,
"items": [
{
"id": 1,
"name": "正常",
"price": 0
},
{
"id": 2,
"name": "去冰",
"price": 5
}
]
}
]
},
{
"id": "UC05000005",
"name": "蜂蜜香檸茶",
"image_url": "",
"quantity": 1.0,
"price": 39.0,
"is_default": true,
"is_hidden": false,
"is_stop_sale": false,
"tastes": [
{
"id": 1,
"name": "外帶",
"kind": "0",
"max_quantity": null,
"is_mutually_exclusive": true,
"is_required": false,
"default_taste_item_id": null,
"items": [
{
"id": 1,
"name": "內用",
"price": 0
},
{
"id": 2,
"name": "外帶",
"price": 0
}
]
},
{
"id": 25,
"name": "冰塊",
"kind": "0",
"max_quantity": null,
"is_mutually_exclusive": true,
"is_required": false,
"default_taste_item_id": 1,
"items": [
{
"id": 1,
"name": "正常",
"price": 0
},
{
"id": 2,
"name": "去冰",
"price": 5
}
]
}
]
}
]
}
],
"packs": null,
"tastes": [
{
"id": 9,
"name": "青菜種類",
"kind": "0",
"max_quantity": null,
"is_mutually_exclusive": true,
"is_required": false,
"default_taste_item_id": 1,
"items": [
{
"id": 1,
"name": "美生菜",
"price": 10
},
{
"id": 2,
"name": "地瓜葉",
"price": 15
},
{
"id": 3,
"name": "大陸妹",
"price": 20
}
]
},
{
"id": 14,
"name": "超值加購-滷鴨蛋-原價15元,加購價12元",
"kind": "0",
"max_quantity": null,
"is_mutually_exclusive": false,
"is_required": false,
"default_taste_item_id": null,
"items": [
{
"id": 2,
"name": "滷鴨蛋",
"price": 12
}
]
},
{
"id": 18,
"name": "炸物加購",
"kind": "0",
"max_quantity": null,
"is_mutually_exclusive": false,
"is_required": true,
"default_taste_item_id": null,
"items": [
{
"id": 1,
"name": "炸排骨",
"price": 60
},
{
"id": 2,
"name": "香酥雞腿",
"price": 70
},
{
"id": 3,
"name": "炸紅糟肉",
"price": 40
}
]
}
]
}
]
},
{
"id": "18943",
"pos_dep_id": "UC105",
"name": "系列組合",
"image_url": null,
"enable": true,
"is_combo": false,
"is_package": true,
"is_coupon": false,
"position": 6,
"products": [
{
"id": "UC10000036",
"name": "小菜組合_系列合計★",
"short_name": "小菜組合_系列合計",
"sale_start": null,
"sale_end": null,
"memo": null,
"gencods": null,
"tax": 0.05,
"tax_sign": null,
"price": 11.0,
"enable": true,
"is_combo_item": false,
"is_float": false,
"can_get_points": false,
"can_redeemed": false,
"pack_price_type": "PACK",
"type": "GENERAL_PRODUCT",
"promotion_content": null,
"description": null,
"is_stop_sale": false,
"member_discount_rate": null,
"combo_price": null,
"package_price": 23.0,
"special_price": null,
"single_price": 0.0,
"default_data_price": 0.0,
"image_url": null,
"position": 9999,
"combos": null,
"packs": [
{
"id": "UC10000036",
"name": "小菜",
"pack_suit_id": "2",
"image_url": "",
"pack_price_type": "TOTAL",
"quantity": 2,
"price": 15.0,
"items": [
{
"id": "UC04200001",
"name": "秋葵",
"image_url": "",
"price": 10.0,
"plus_price": 5.0,
"default_quantity": 0,
"is_stop_sale": false,
"tastes": [
{
"id": 1,
"name": "外帶",
"kind": "0",
"max_quantity": null,
"is_mutually_exclusive": true,
"is_required": false,
"default_taste_item_id": null,
"items": [
{
"id": 1,
"name": "內用",
"price": 0
},
{
"id": 2,
"name": "外帶",
"price": 0
}
]
},
{
"id": 5,
"name": "環保餐具",
"kind": "0",
"max_quantity": null,
"is_mutually_exclusive": false,
"is_required": false,
"default_taste_item_id": null,
"items": [
{
"id": 1,
"name": "自備餐具",
"price": 0
},
{
"id": 2,
"name": "環保餐具-主食分開裝",
"price": 0
},
{
"id": 3,
"name": "環保餐具-主食放一起",
"price": 0
}
]
},
{
"id": 8,
"name": "燙青菜",
"kind": "0",
"max_quantity": null,
"is_mutually_exclusive": false,
"is_required": false,
"default_taste_item_id": null,
"items": [
{
"id": 1,
"name": "不加油蔥",
"price": 0
},
{
"id": 2,
"name": "不加油膏",
"price": 0
},
{
"id": 3,
"name": "全不加",
"price": 0
},
{
"id": 4,
"name": "油膏多",
"price": 0
}
]
}
]
},
{
"id": "UC04200003",
"name": "韓式泡菜",
"image_url": "",
"price": 15.0,
"plus_price": 5.0,
"default_quantity": 0,
"is_stop_sale": false,
"tastes": [
{
"id": 1,
"name": "外帶",
"kind": "0",
"max_quantity": null,
"is_mutually_exclusive": true,
"is_required": false,
"default_taste_item_id": null,
"items": [
{
"id": 1,
"name": "內用",
"price": 0
},
{
"id": 2,
"name": "外帶",
"price": 0
}
]
},
{
"id": 5,
"name": "環保餐具",
"kind": "0",
"max_quantity": null,
"is_mutually_exclusive": false,
"is_required": false,
"default_taste_item_id": null,
"items": [
{
"id": 1,
"name": "自備餐具",
"price": 0
},
{
"id": 2,
"name": "環保餐具-主食分開裝",
"price": 0
},
{
"id": 3,
"name": "環保餐具-主食放一起",
"price": 0
}
]
}
]
}
]
}
],
"tastes": null
}
]
}
]
}