Skip to content

Get Basic Settings

Description

取得基本設定。

Resource

GET /v1/basic/settings

Authorization

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

Query Parameters

Name Type Description
store_id string 門市代碼
(optional)

Request Example

GET /v1/basic/settings?store_id=A701001

Response Body Parameters

Name Type Description
register_url string 註冊網址
available_days int 可訂餐天數
has_points boolean KIOSK是否開放集點功能
(option)
有傳入門市代碼才會回傳此參數
maximum_order_amount int KIOSK單筆交易金額限制
table_no_type string
(enum)		 桌號種類
ALLOWED VALUES:
  • DO_NOT_USE
  • VIBRATION_PLATE_QR_CODE
  • QR_CODE
  • KEYBOARD
preparation_time int 準備時間(分鐘)
time_interval int 取餐間隔時間（分鐘）
kiosk_product_name_type string
(enum)		 KIOSK商品名稱類型
ALLOWED VALUES:
  • FIRST_NAME
  • SECOND_NAME
  • ABBREVIATED_NAME
use_member_carrier boolean 是否使用會員載具
member_carrier_type string
(enum)		 會員載具類型
print_order_qrcode boolean KIOSK收據是否列印訂單QRCode
use_member boolean KIOSK是否使用會員
(option)
有傳入門市代碼才會回傳此參數
kiosk_qrcode_description string KIOSK活動QRCode文案
(option)
amount_calculation_type string
(enum)		 金額計算類型
ALLOWED VALUES:
  • ROUND_HALF_UP
  • ROUND_HALF_DOWN
  • ROUND_UP
  • ROUND_DOWN
app_download_url string APP下載網址
head_office_shop_id string 總部門市編號
enable_not_use_pos boolean 有 WISE 沒 POS
enable_twqr_recognition boolean 是否開啟辨識TWQR
crm_login_url string CRM登入網址
discount_type string 折扣類型
use_scan_ticket boolean 是否開啟KIOSK掃描優惠券
enable_kiosk_exception_notifications boolean 是否啟用Kiosk異常通知
enable_kkday_ticket boolean KKDay票券啟用狀態
enable_klook_ticket boolean Klook票券啟用狀態
enable_eztravel_ticket boolean 易遊網票券啟用狀態
enable_payment_carrier_alert boolean 啟用列印發票提示窗
transfer_url string 門市傳輸網址
linea_member_centre string LINE@會員中心網址
ec_store_id string EC門店編號
is_show_amount_decimal boolean 是否顯示金額小數點
shared_login_feature boolean 共享登入功能狀態
meal_begin_time string 取餐時間起
meal_end_time string 取餐時間訖
saleret_premonth boolean 訂單允許跨月退貨
saleret_day integer 訂單可退貨天數
member_login_type string 會員登入方式
ALLOWED VALUES:
  • ALL: 全部
  • MEMBER_CARD: 掃描會員條碼(會員卡)
  • PHONE_NUMBER: 手機號碼
transaction_amount float 交易金額
transaction_token float 交易代幣
languages Languages 可用語系
invoice_image_url string 發票 LOGO 圖片網址
tax_id_number string 統一編號
enable_edit_cart_product_memo boolean 允許編輯購物車商品備註
call_number_system_url string 叫號系統URL
KIOSK 用來列印叫號 QR Code 讓消費者可以掃描取得目前訂單狀態與等待組數
(optional)
shop_layout_type string
(enum)		 KIOSK 版型設定 - 商店版型類型
ALLOWED VALUES:
  • TOP_HORIZONTAL: 類別顯示在上方(預設)
  • LEFT_VERTICAL: 類別顯示在左側

(option)
有傳入門市代碼才會回傳此參數
product_column_count int KIOSK 版型設定 - 商品欄位數量
類別為上排時可選：4欄(預設)、3欄、2欄
類別為左排時可選：3欄(預設)、2欄、1欄
(option)
有傳入門市代碼才會回傳此參數
enable_credential_discount boolean 啟用憑證優惠

Response Body Parameters - Languages

Name Type Description
id string 語系編號
name string 語系名稱
translate_name string 語系翻譯名稱

Response Body Example

{
  "register_url": "https://www.kiosk/register",
  "available_days": 3,
  "has_points": true,
  "maximum_order_amount": 1000,
  "table_no_type": "QR_CODE",
  "preparation_time": 15,
  "time_interval": 15,
  "kiosk_product_name_type": "FIRST_NAME",
  "use_member_carrier": true,
  "member_carrier_type": "3J0002",
  "print_order_qrcode": true,
  "use_member": true,
  "kiosk_qrcode_description": "測試活動說明",
  "amount_calculation_type": "ROUND_HALF_UP",
  "app_download_url": "https://app_download_url",
  "head_office_shop_id": "0",
  "enable_not_use_pos": false,
  "enable_twqr_recognition": true,
  "crm_login_url": "https://crm.test.url",
  "discount_type": "0",
  "use_scan_ticket": false,
  "enable_kiosk_exception_notifications": false,
  "enable_mohist_ticket": false,
  "enable_payment_carrier_alert": false,
  "transfer_url": "https://transfer.wixtar.com",
  "linea_member_centre": "https://lineat.com.tw",
  "ec_store_id": "EC01",
  "is_show_amount_decimal": false,
  "shared_login_feature": false,
  "meal_begin_time": "09:00",
  "meal_end_time": "18:00",
  "ticket_cooperation_platform_image_url": "",
  "saleret_premonth": false,
  "saleret_day": 10,
  "member_login_type": "ALL",
  "transaction_amount": 10.0,
  "transaction_token": 1,
  "languages": [
    {
      "id": "TRADITIONAL_CHINESE",
      "translate_name": "繁體中文"
    },
    {
      "id": "JAPANESE",
      "translate_name": "日本語"
    },
    {
      "id": "KOREAN",
      "translate_name": "한국어"
    }
  ],
  "invoice_image_url": "https://lafreshcdn.blob.core.windows.net/siteinfo/18090377-4-1744097116.png",
  "tax_id_number": "24436074",
  "enable_edit_cart_product_memo": true,
  "call_number_system_url": "https://call.system.url/qrcode",
  "shop_layout_type": "TOP_HORIZONTAL",
  "product_column_count": 4,
  "enable_credential_discount": false
}