Skip to content

Get Store

Description

取得門市資訊。

Resource

GET /v1/store/{store_id}

Authorization

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

Path Parameters

Name Type Description
store_id string 門市代碼
language string
(enum)		 語系
ALLOWED VALUES:
  • TRADITIONAL_CHINESE: 繁體中文
  • JAPANESE: 日語
  • KOREAN: 韓語
  • ENGLISH: 英語
  • FRENCH: 法語
  • INDONESIAN: 印尼語
  • THAI: 泰語
  • VIETNAMESE: 越南語
  • SPANISH: 西班牙語
  • GERMAN: 德語
  • RUSSIAN: 俄語
(optional)
client_device string
(enum)		 客戶端裝置。帶入時回應會包含該裝置適用的銷售方式 (sale_methods)；未帶入時 sale_methods 回傳 null
ALLOWED VALUES:
  • KIOSK
  • PWA
  • EC_QUICK_ORDER
  • UBER_EATS
  • FOODPANDA
  • APP
  • EC_HAO_SPEED
  • EC_NIDIN
  • MPOS
  • POS
(optional)

Request Example

GET /v1/store/1101

Response Body Parameters

Name Type Description
id string 門市代碼
name string 門市名稱
translate_name string 門市翻譯名稱
type string
(enum)		 門市類型
ALLOWED VALUES:
  • REGULAR_CHAIN
  • VOLUNTARY_CHAIN
phone string 電話
fax string 傳真
profile string 門市介紹
(HTML格式)
business_hours string 營業時間
can_use_receipt boolean 是否開立發票
location Location 地理資訊
support_phone string 支援電話
purchase_type list 購買類型
ALLOWED VALUES:
  • RESTAURANT
  • SHOPPING
authkey string 公司代碼
(optional)
company string 公司名稱
多品牌經營情境下，若該門市屬於特定品牌，回傳該品牌名稱
enable_nidin boolean 是否啟用nidin
image_url string 圖片網址
enable_quickclick boolean 是否啟用快一點
enable_uber_eats boolean 是否啟用UberEats
enable_foodpanda boolean 是否啟用Foodpanda
enable_app boolean 是否啟用APP
mstore_use_version integer mStore使用版本
mobile_report_url string 手機報表網址
enable_store_marketing boolean 是否啟用門市行銷
enable_ordering_system boolean 是否啟用訂貨系統
enable_business_analysis boolean 是否啟用商務分析
enable_store_management boolean 是否啟用店務管理
enable_ticket_redeem_management boolean 是否啟用核銷管理
enable_ai_recommend_menu boolean 是否啟用菜單AI推薦
enable_ai_recommend_item boolean 是否啟用商品AI推薦
enable_ai_recommend_cart boolean 是否啟用購物車AI推薦
kiosk_device Kiosk Device KIOSK 裝置列表
brand_logo_url string 品牌 LOGO URL
pwa_small_logo_url string WiXGo(PWA) 餐廳 LOGO 網址 (原 WiXGo 小 LOGO)
enable_call_number boolean 是否啟用叫號
enable_pwa boolean 是否啟用 WiXGo (PWA)
enable_kiosk boolean 是否啟用 KIOSK
enable_jenda boolean 是否啟用鉦達
pwa_meal boolean 提供 WiXGo(PWA) 取餐
kiosk_meal boolean 提供 Kiosk 取餐
is_kiosk_open boolean KIOSK 是否開啟
is_pwa_open boolean PWA (WIXGO) 是否開啟
以下任一情況固定為 false：
1. 今日為門市店休日（今日落在 closed_dates）
2. 門市有可判定的當日營業時段時，目前時間不在任一營業時段內，或已超過該時段的最後可接單時間（時段結束時間往前扣 preparation_time 備餐時間）
門市未設定當日營業時段（或當日無可取餐時段）時，第 2 項不適用
此規則僅會將狀態關閉為 false，不會覆寫其他已關閉的狀態
enable_delivery_service boolean 是否啟用外送服務
preparation_time integer 備餐時間
closed_dates list 自今日起於門市可取餐天數區間內的店休日期清單
格式 YYYY-MM-DD，已去重並依日期升序排序
已設定營業時間的門市依營業時間與特殊店休日推算；未設定者依門市班表推算，未安排班次的日期視為店休
區間內無店休日時回傳 null
(optional)
sale_methods Sale Method 門市銷售方式清單
僅於 request 帶入 client_device 時回傳；未帶入時為 null
(optional)
kiosk_single_coupon_enable boolean 是否啟用 KIOSK 一品一券

Response Body Parameters - Location

Name Type Description
address string 地址
zip_code string 郵遞區號
latitude double 緯度
longitude double 經度

Response Body Parameters - Kiosk Device

Name Type Description
device_id string 裝置代碼
is_cash_model boolean 是否為現金機種

Response Body Parameters - Sale Method

Name Type Description
id string 銷售方式編號
name string 銷售方式名稱
has_address boolean 是否需填寫地址
type string 銷售方式類型（如 DINE_IN、PICK_UP、DELIVERY 等）
translate_name string 銷售方式翻譯名稱（依 language；無對應翻譯時為 null）
is_paused boolean 是否暫停接單
suspend_reason string 暫停原因文字
無暫停或自動恢復時回傳 null
(Optional)
suspend_reason_color string 暫停原因標籤色碼
無暫停或自動恢復時回傳 null
(Optional)
resume_at string 待開啟時間 (格式 YYYY-MM-DD HH:MM:SS)
未設定定時或永久關閉時回傳 null
(Optional)

Response

[
  {
    "id": "1101",
    "name": "高雄直營",
    "translate_name": "translate_name",
    "type": "VOLUNTARY_CHAIN",
    "phone": "",
    "fax": "",
    "profile": "<p>&nbsp;</p>\r\n<div id=\"katalon\" style=\"top: 0px;\">\r\n<div id=\"katalon-rec_elementInfoDiv\" style=\"display: none;\">&nbsp;</div>\r\n</div>",
    "business_hours": "",
    "location": {
      "address": "",
      "zip_code": "",
      "latitude": 0.0,
      "longitude": 0.0
    },
    "support_phone": "886-6-8885888",
    "purchase_type": [
      "RESTAURANT"
    ],
    "company": "QA_測試",
    "enable_nidin": true,
    "enable_quickclick": false,
    "enable_uber_eats": false,
    "enable_foodpanda": false,
    "enable_app": true,
    "mstore_use_version": 1,
    "mobile_report_url": "http://cloud.lafresh.com.tw:28445",
    "enable_store_marketing": false,
    "enable_ordering_system": false,
    "enable_business_analysis": true,
    "enable_store_management": true,
    "enable_ticket_redeem_management": true,
    "enable_ai_recommend_menu": true,
    "enable_ai_recommend_item": true,
    "enable_ai_recommend_cart": true,
    "kiosk_device": [
      {
        "deveice_id": "k1",
        "is_cash_model": false
      },
      {
        "deveice_id": "k2",
        "is_cash_model": true
      }
    ],
    "image_url": null,
    "can_use_receipt": false,
    "brand_logo_url": "http://test.com/image.png",
    "pwa_small_logo_url": "http://test.com/image.png",
    "enable_call_number": true,
    "enable_pwa": true,
    "enable_kiosk": true,
    "enable_jenda": true,
    "pwa_meal": true,
    "kiosk_meal": true,
    "is_kiosk_open": true,
    "is_pwa_open": false,
    "enable_wpos": true,
    "enable_delivery_service": true,
    "preparation_time": 5,
    "closed_dates": ["2025-08-13", "2025-08-20"],
    "sale_methods": [
      {
        "id": "1",
        "name": "內用",
        "has_address": false,
        "type": "DINE_IN",
        "translate_name": null
      },
      {
        "id": "2",
        "name": "外帶",
        "has_address": false,
        "type": "PICK_UP",
        "translate_name": null
      }
    ],
    "kiosk_single_coupon_enable": true
  }
]