Get Sale Method

Description

取得銷售方式。

Resource

GET /v1/sale_method

Authorization

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

Query Parameters

Name	Type	Description
store_id	string	門市代碼
client_device	string (enum)	客戶端裝置 ALLOWED VALUES: APP KIOSK PWA (option)
language	string (enum)	語系 ALLOWED VALUES: TRADITIONAL_CHINESE: 繁體中文 JAPANESE: 日語 KOREAN: 韓語 ENGLISH: 英語 FRENCH: 法語 (option)

Request Example

GET /v1/sale_method?store_id=A001&client_device=PWA

Response

{
  "sale_methods": [
    {
      "id": "1",
      "name": "內用",
      "has_address": false,
      "type": "DINE_IN",
      "translate_name": "Dine-in",
      "is_paused": false,
      "suspend_reason": null,
      "suspend_reason_color": null,
      "resume_at": null
    },
    {
      "id": "2",
      "name": "外帶",
      "has_address": false,
      "type": "PICK_UP",
      "translate_name": "Takeout",
      "is_paused": true,
      "suspend_reason": "天候不佳，暫停外帶",
      "suspend_reason_color": "#FF0000",
      "resume_at": "2026-08-14 18:00:00"
    },
    {
      "id": "3",
      "name": "外送",
      "has_address": true,
      "type": "DELIVERY",
      "translate_name": "Delivery",
      "is_paused": false,
      "suspend_reason": null,
      "suspend_reason_color": null,
      "resume_at": null
    }
  ]
}

Response Body Parameters

Name	Type	Description
sale_methods	Sale Method[]	銷售方式列表

Response Body Parameters - Sale Method

Name	Type	Description
id	string	編號
name	string	名稱
has_address	boolean	是否需填寫地址
type	string (enum)	銷售方式 ALLOWED VALUES: DEFAULT DINE_IN PICK_UP DELIVERY
translate_name	string (enum)	翻譯名稱
is_paused	boolean	是否暫停接單
suspend_reason	string	暫停原因文字 無暫停或未帶 client_device 時回傳 null (Optional)
suspend_reason_color	string	暫停原因標籤色碼 無暫停或未帶 client_device 時回傳 null (Optional)
resume_at	string	待開啟時間 (格式 YYYY-MM-DD HH:MM:SS) 未設定定時或永久關閉時回傳 null (Optional)