Get Menus
Description
取得包含多張菜單的所有商品詳細資料。
Resource
GET /v1/product/menus
Authorization
採用 OAuth 2.0 Bearer Token,詳細使用流程請參考 Auth Login。
Query Parameters
| Name | Type | Description |
|---|---|---|
| menu_group_id | string | 菜單群組編號 (option) |
| store_id | string | 門市編號 (option) |
| client_device | string | 銷售方式 ALLOWED VALUES:
|
Request Example
GET /v1/product/menus?store_id=STORE001&client_device=KIOSK
Response Body Parameters
| Name | Type | Description |
|---|---|---|
| menu_group | Menu Group[] | 菜單群組 |
| menus | Menu[] | 菜單列表 |
Response Body Parameters - Menu Group
| Name | Type | Description |
|---|---|---|
| menu_group_id | string | 菜單群組編號 |
| applicable_shop_ids | list[string] | 適用門市編號清單 |
| platform_id | string | 平台編號 ALLOWED VALUES
|
| menu_group_name | list[string] | 菜單銷售方式 ALLOWED VALUES
|
Response Body Parameters - Menu
| Name | Type | Description |
|---|---|---|
| menu_group_id | string | 菜單群組編號 |
| menu_id | string | 菜單編號 |
| menu_name | string | 菜單名稱 |
| menu_sale_methods | list[string] | 菜單銷售方式 ALLOWED VALUES
|
| menu_usage_begin_time | string | 菜單起始時間 |
| menu_usage_end_time | string | 菜單結束時間 |
| menu_usage_period | list[integer] | 菜單週期 |
| menu_position | integer | 菜單排序 |
| products | Product | 商品列表 |
Response Body Parameters - Product
| Name | Type | Description |
|---|---|---|
| categories | Category[] | 商品類別 |
| sub_category | Sub Category | 商品子類別 |
| pos_dep_id | string | POS 類別編號 |
| dep_name | string | POS 類別名稱 |
| id | string | 商品編號 |
| title | string | 商品名稱 |
| translate_title | string | 商品名稱翻譯 |
| english_title | string | 商品名稱英文翻譯 |
| second_title | string | 商品第二名稱 |
| translate_second_title | string | 商品第二名稱翻譯 |
| english_second_title | string | 商品第二名稱英文翻譯 |
| description_url | string | 描述URL |
| description | string | 描述 |
| translate_description | string | 商品描述翻譯 |
| english_description | string | 商品描述英文翻譯 |
| spec_url | string | 規格URL |
| spec_html | string | 規格(HTML格式) |
| translate_spec_html | string | 商品規格HTML翻譯 |
| english_spec_html | string | 商品規格HTML英文翻譯 |
| promotion_content | string | 促銷內容 |
| translate_promotion_content | string | 商品促銷內容翻譯 |
| english_promotion_content | string | 商品促銷內容英文翻譯 |
| memo | string | 商品備註 |
| translate_memo | string | 商品備注翻譯 |
| english_memo | string | 商品備註英文翻譯 |
| spec | string | 規格 |
| translate_spec | string | 商品規格翻譯 |
| english_spec | string | 商品規格英文翻譯 |
| unit | string | 單位 |
| translate_unit | string | 商品單位翻譯 |
| english_unit | string | 商品單位英文翻譯 |
| introduction | string | 商品簡介 |
| translate_introduction | string | 商品簡介翻譯 |
| english_introduction | string | 商品簡介英文翻譯 |
| abbreviated_title | string | 商品簡稱 |
| translate_abbreviated_title | string | 商品簡稱翻譯 |
| english_abbreviated_title | string | 商品簡稱英文翻譯 |
| enable | boolean | 啟用 |
| is_combo | boolean | 是否為套餐商品 |
| is_combo_item | boolean | 是否為套餐子項目 |
| show_combo_item_image | boolean | 是否顯示套餐子項目圖片 |
| combo_price | float | 套餐商品價格,is_combo=true 才有資料 |
| combo | Combo | 套餐商品,is_combo=true 才有資料 |
| is_package | boolean | 是否為系列組合商品 |
| show_pack_item_image | boolean | 是否顯示系列組合子項目圖片 |
| pack_price_type | string | 系列組合價格方式 ALLOWED VALUES:
|
| package_price | float | 系列組合商品價格,is_package=true 才有資料 |
| pack | Pack | 系列組合清單,is_package=true 才有資料 |
| is_float | boolean | 是否為浮動價 |
| is_stop_sale | boolean | 是否為停售商品 |
| can_get_points | boolean | 是否可累積點數 |
| can_redeemed | boolean | 是否可用點數兌換 |
| spend_points | integer | 兌換所需點數 |
| origin | string | 產地 |
| element | string | 成份 |
| caloric | string | 熱量 |
| img | string | 商品圖檔網址 |
| EC_url | string | EC官網URL |
| tags | string | 標籤 |
| brand | string | 品牌 |
| is_hidden | boolean | 是否隱藏 |
| type | string (enum) |
商品類型 ALLOWED VALUES:
|
| price | float | 商品原價金額 |
| special_price | float | 商品特價金額 |
| single_price | float | 單品金額(單品原價金額+預選加值金額) |
| default_data_price | float | 預設資料金額(預選品項金額+預選加值金額) |
| szfprod_id | string | 尺寸主商品編號 |
| nutrition_facts | object | 營養標示 |
| member_discount_rate | fload | 會員折扣率 |
| position | integer | 商品排序 |
| sale_start | string | 商品開始銷售時間 |
| sale_end | string | 商品結束銷售時間 |
| gencods | list[string] | 國際條碼 |
| barcode | string | 條碼 |
| tax | float | 稅額 |
| tax_sign | string | 稅別 |
| limitations | Limitations | 限量商品資訊 |
| tastes | Taste[] | 加值列表 |
| default_size_child_product_id | string | 預設尺寸子商品編號 |
| size_child_products | Product | 尺寸子商品列表 |
| combo_mappings | ComboMapping | 單品關聯資訊 |
| sztaste_id | integer | 尺寸口味編號 |
| sztaste_sno | integer | 尺寸口味序號 |
Response Body Parameters - Category
| Name | Type | Description |
|---|---|---|
| id | string | 分類編號 |
| title | string | 分類名稱 |
| position | integer | 位置 |
Response Body Parameters - Sub Category
| Name | Type | Description |
|---|---|---|
| id | string | 子分類編號 |
| name | string | 子分類名稱 |
Response Body Parameters - Combo
| Name | Type | Description |
|---|---|---|
| product_id | string | 套餐主項商品編號 |
| show_item_image | boolean | 是否顯示套餐子項目圖片 |
| combo | Combo Group[] | 套餐群組 |
Response Body Parameters - Combo Group
| Name | Type | Description |
|---|---|---|
| id | int | 套餐群組編號 |
| group_name | string | 套餐群組名稱 |
| translate_group_name | string | 套餐群組名稱翻譯 |
| english_group_name | string | 套餐群組名稱英文翻譯 |
| is_multiple_choice | boolean | 套餐群組是否可多選 |
| control_quantity | boolean | 套餐群組控管數量 (若為多選才會判斷此參數) |
| group_min_quantity | int | 套餐群組最低可選數量 (若為多選才會判斷此參數) |
| group_max_quantity | int | 套餐群組最高可選數量 (若為多選才會判斷此參數) |
| item_max_quantity | int | 套餐群組底下的子項商品最高可選數量 (若為多選才會判斷此參數) |
| items | Combo Item[] | 套餐子項商品列表 |
| product_id | string | 預設套餐子項商品編號 |
| product_name | string | 預設套餐子項商品名稱 |
| translate_product_name | string | 預設套餐子項商品名稱翻譯 |
| english_product_name | string | 預設套餐子項商品名稱英文翻譯 |
| image_url | string | 預設套餐子項商品圖檔網址 |
| quantity | float | 預設套餐子項商品數量 |
| price | float | 預設套餐子項商品單價 |
| is_stop_sale | boolean | 預設套餐子項商品是否停售 |
| is_hidden | boolean | 預設套餐子項商品是否為隱藏商品 |
| limitations | Limitations | 預設套餐子項商品限量資訊 |
| taste | Taste[] | 預設套餐子項商品加值 |
Response Body Parameters - Combo Item
| Name | Type | Description |
|---|---|---|
| product_id | string | 套餐子項商品編號 |
| product_name | string | 套餐子項商品名稱 |
| translate_product_name | string | 套餐子項商品名稱翻譯 |
| english_product_name | string | 套餐子項商品名稱英文翻譯 |
| image_url | string | 套餐子項商品圖檔網址 |
| quantity | float | 套餐子項商品數量 |
| price | float | 套餐子項商品單價 |
| is_stop_sale | boolean | 套餐子項商品是否停售 |
| is_hidden | boolean | 套餐子項商品是否為隱藏商品 |
| limitations | Limitations | 套餐子項商品限量資訊 |
| taste | Taste[] | 套餐子項商品加值 |
Response Body Parameters - Pack
| Name | Type | Description |
|---|---|---|
| product_id | string | 系列組合主項商品編號 |
| show_item_image | boolean | 是否顯示系列組合子項目圖片 |
| pack_price_type | string | 價格類型 ALLOWED VALUES:
|
| pack | Package Group[] | 系列組合群組 |
Response Body Parameters - Pack Group
| Name | Type | Description |
|---|---|---|
| id | string | 系列組合主項商品編號 |
| pack_suit_id | string | 系列組合群組編號 |
| title | string | 系列組合群組名稱 |
| translate_title | string | 系列組合群組名稱翻譯 |
| english_title | string | 系列組合群組名稱英語翻譯 |
| pack_price_type | string | 系列組合群組價格類型 ALLOWED VALUES:
|
| quantity | int | 系列組合群組數量 |
| price | float | 系列組合群組單價 |
| items | Item[] | 系列組合子項商品列表 |
Response Body Parameters - Item
| Name | Type | Description |
|---|---|---|
| product_id | string | 系列組合子項商品編號 |
| title | string | 系列組合子項商品名稱 |
| translate_title | string | 系列組合子項商品名稱翻譯 |
| english_title | string | 系列組合子項商品名稱英語翻譯 |
| image_url | string | 系列組合子項商品圖檔網址 |
| price | float | 系列組合子項商品價格 |
| plus_price | float | 系列組合子項商品加價 |
| is_stop_sale | boolean | 系列組合子項商品是否停售 |
| default_quantity | int | 系列組合子項商品預設數量 |
| tastes | Taste[] | 系列組合子項商品加值 |
Response Body Parameters - Limitations
| Name | Type | Description |
|---|---|---|
| quantity | integer | 數量 |
| start_date | string | 起始時間 |
| end_date | string | 結束時間 |
Response Body Parameters - Taste
| Name | Type | Description |
|---|---|---|
| id | int | 加值編號 |
| title | string | 加值名稱 |
| translate_title | string | 加值名稱翻譯 |
| english_title | string | 加值名稱英文翻譯 |
| is_mutually_exclusive | bool | 是否互斥 |
| kind | string | 加值種類 |
| is_required | bool | 是否必填 |
| max_quantity | integer | 最大加值數量 |
| show_item_image | boolean | 是否顯示加值項目圖片 |
| position | integer | 加值排序 |
| default | Taste Item | 預設加值項目 |
| items | Item[] | 加值項目 |
Response Body Parameters - Taste Item
| Name | Type | Description |
|---|---|---|
| id | int | 加值項目編號 |
| title | string | 加值項目名稱 |
| price | int | 加值項目價格 |
| size_child_product_id | string | 尺寸子商品編號 |
| translate_title | string | 加值項目名稱翻譯 |
| english_title | string | 加值項目名稱英文翻譯 |
| image_url | string | 加值項目圖片網址 |
Response Body Parameters - Combo Mapping
| Name | Type | Description |
|---|---|---|
| id | string | 套餐商品編號 |
| name | string | 套餐商品名稱 |
| image_url | string | 套餐圖片URL |
| is_stop_sale | boolean | 是否停售 |
| combo_price | int | 套餐金額 |
| ## Response | ||
|