---
title: "Get Setting"
method: GET
path: "/settings"
tags: ["Settings"]
---

# Get Setting

`GET /settings`

To retrieve settings<br>獲取設定

## Response `200`

OK

- Settings
  - `users` UsersSetting
    - `birthday_format` 'YYYY/MM/DD' | 'YYYY/MM' | 'MM/DD' — The birthday format of the user (default: "YYYY/MM/DD")<br> 會員生日格式（預設："YYYY/MM/DD"）
    - `send_birthday_credit_period` 'monthly' | 'daily' — The birthday credit sending setting of the user (default: "daily")<br> 會員生日點數發送時間（預設："daily"為當日, "monthly"為當月一號）
    - `line_login` object, nullable
      - `status` 'active' | 'inactive' — line login active status
    - `facebook_login` object, nullable
      - `status` 'active' | 'inactive' — facebook login enable status
      - `app_id` string — facebook app id
      - `app_secret` string — facebook app_secret
      - `client_token` string — facebook client_token
    - `enable_facebook_comment` object, nullable
      - `status` boolean — facebook comment enable status
    - `membership_promo_banner` object, nullable
      - `text` object
        - `display` 'hidden' | 'default' | 'custom' — membership promo banner text display status <br> 會員權益宣傳版位文字顯示狀態
        - `custom_content` object — membership promo banner text custom content <br> 會員權益宣傳版位文字自定內容<br> Key is language code (e.g. zh, en) and value contains title and content<br> key 為語言代號（例如：zh, en），value 包含 title 和 content
      - `image` object
        - `display` 'hidden' | 'custom' — membership promo banner image display status <br> 會員權益宣傳版位圖片顯示狀態
        - `custom_content` object — membership promo banner image custom content <br> 會員權益宣傳版位圖片自定內容<br> Key is language code (e.g. zh, en) and value contains images and _id<br> key 為語言代號（例如：zh, en），value 包含 images 和 _id
    - `pos_apply_credit` boolean, nullable
    - `pos_apply_member_point` boolean, nullable
    - `user_credit_rules` UserCreditRule[]
      - `id` string
      - `status` 'active' | 'inactive'
      - `rule_type` 'pos_apply_credit' | 'auto_reward' | 'apply_partial_credit' | 'welcome_credit' | 'birthday_credit' | 'max_amount_per_order' | 'max_percentage_per_order' | 'apply_user_credit' — pos_apply_credit: POS 購物金折抵 auto_reward: 滿額送購物金 apply_partial_credit: 允許顧客自行設定折抵金額 welcome_credit: 新加入會員購物金 birthday_credit: 生日購物金 max_amount_per_order: (舊) 購物金折抵上限 by amount max_percentage_per_order: (舊) 購物金折抵上限 by percentage apply_user_credit: (新) 折抵購物金上限，支援多層級設定
      - `credit_value` integer — 購物金
      - `credit_value_type` 'amount' | 'percentage' — Only the rule whose rule_type is apply_user_credit will use this field to distinguish the credit_value is fixed amount or percentage.<br> 僅 rule_type 為 apply_user_credit 的規則會使用到，用來區分 credit_value 的值是固定金額還是百分比
      - `credit_valid_period` integer — 購物金有效日期（天），0 / -1 代表無限
      - `credit_threshold` integer — 購物金生效條件
      - `is_accumulated` boolean — 自動累計
      - `accumulated_type` 'credit' | 'percentage' — 累計類型 credit: 固定金額 percentage: 百分比
      - `apply_threshold` integer — 購物金生效條件
      - `apply_conditions` object[] — Tiered application of user credits.<br>套用購物金折抵條件(多階層)
        - `credit_value` integer — Credit Value<br>購物金
        - `apply_threshold` integer — Apply Threshold<br>購物金折抵門檻
      - `created_at` string — Created Date<br>創造時間<br>(UTC +0)
      - `updated_at` string — Created Date<br>更新時間<br>(UTC +0)
    - `member_point_rules` MemberPointRule[]
      - `id` string — Member Point Rule ID<br />會員點數ID
      - `status` 'active' | 'inactive' — Whether the rules is applying<br />規則是否正在生效
      - `unit_price` integer — The amount of purchase to earn a unit of points.<br /> This field will be null if the rule_type is not "earn_from_order."<br /> 賺取一個單位的點數所需的購買金額<br /> 如rule_type不是"earn_from_order"，此欄會是null
      - `points_per_unit` integer — The amount of points earned by a unit of unit_price.<br /> This field will be null if the rule_type is not "earn_from_order".<br /> 一個單位的unit_price能夠賺取的點數 如rule_type不是"earn_from_order"，此欄會是null
      - `points_expire_day` integer — The expiry date of points, null if there is no expiry date.<br /> This field will be null if the rule_type is not "earn_from_order".<br /> 點數的到期日，如規則並沒有設置點數會到期，此欄會是null 如rule_type不是"earn_from_order"，此欄會是null
      - `points_expire_month` integer — The expiry month of points, null if there is no expiry date.<br /> This field will be null if the rule_type is not "earn_from_order".<br /> 點數的到期月份，如規則並沒有設置點數會到期，此欄會是null 如rule_type不是"earn_from_order"，此欄會是null
      - `pending_days` integer — The number of days after delivery received (Arrived/ Collected) will the system automatically assign the point to customer.<br /> This field will be null if the rule_type is not "earn_from_order".＜br /> 顧客訂單轉變為 已取貨 / 已到達(宅配) 後幾天自動發送點數<br /> 如rule_type不是"earn_from_order"，此欄會是null
      - `rule_type` 'earn_from_order' | 'max_percentage_per_order' | 'max_amount_per_order' — Define the types of rules that the current object is representing.<br /> 定義這個物件正在表示的規則類別
      - `remarks_translations` object — Remarks of the rules in different language.<br /> 不同語言的點數規則說明
        - `en` string — Merchant defined English name<br>店家定義英文名稱
        - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
        - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
        - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
        - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
        - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
        - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
        - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
        - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
        - `fr` string — Merchant defined France name<br>店家定義法文名稱
      - `membership_tier_id` string — The id of membership_tier.
      - `unit_point` integer — The amount of points needed to redeem a unit of discount.<br /> This field will be null if the rule_type is "earn_from_order".<br /> 兌換一個單位的折扣所需的點數<br /> 如rule_type是"earn_from_order"，此欄會是null
      - `price_per_unit` integer — The amount of discount per unit of points.<br /> This field will be null if the rule_type is "earn_from_order".<br /> 一個單位的點數兌換到的折扣<br /> 如rule_type是"earn_from_order"，此欄會是null
      - `point_value` integer — The price to apply point discount.<br /> It will be -1 if there is no constraint on applying discount.<br /> This field will be -1 if the rule_type is "earn_from_order".<br /> 可以使用折扣的價錢<br /> 如沒有設置使用折扣的價格，此欄會是-1<br /> 如rule_type是"earn_from_order"，此欄會是-1
      - `apply_threshold` integer — Maximum amount of point discount could be applied, the metric depends on the rule_type.<br /> This field will be null if the rule_type is "earn_from_order".<br /> 可使用的最高折扣額，此欄的單位會因應rule_type而改變<br /> 如rule_type是"earn_from_order"，此欄會是null
      - `available_platforms` string[] — Available platforms.<br />此規則生效的平台
    - `minimum_age_limit` string, nullable — The minimum age required for customers to shop at the online store<br>在網店購物的年齡下限<br> minimum: "13"<br> 最小: "13"<br> maximum: "130"<br> 最大: "130"
    - `enable_member_point` boolean — Whether the member point rules are activated <br>會員點數規則是否正在生效
    - `enable_user_credit` boolean — Store Credits Toggle<br>商店購物金總開關
    - `enable_age_policy` boolean — Age Policy Toggle<br>是否開啟顧客已滿年齡同意文案
    - `email_verification` object — Require customer email verification<br>是否開啟顧客電郵驗證
      - `status` string — email verification enable status
    - `email_login_with_verification` object — Customer login requrie email verification<br>是否開啟顧客完成電郵驗證後才可能入
      - `status` string — email login verification enable status
    - `sms_verification` object — Require customer sms verification<br>是否開啟顧客手機驗證
      - `status` string — mobile_phone verification enable status
      - `supported_countries` string[] — mobile_phone support countries
    - `signup_method` 'email' | 'mobile' | 'email_and_mobile' — Customer signup method<br>顧客註冊方式
  - `app` AppSetting
    - `appName` object
  - `pos` PosSetting
    - `mobile_logo_media_url` string
    - `terms_and_condition` string
    - `show_title` boolean
    - `show_original_price` boolean
    - `show_footer_image` boolean
    - `apply_platform` string
    - `footer_image_media_url` string
    - `enable_pos_salesperson_password_required` boolean
    - `enable_pos_transaction_password_required` boolean
    - `enable_pos_purchase_order_password_required` boolean
    - `enable_pos_inventory_count_password_required` boolean
    - `enable_pos_inventory_transfer_password_required` boolean
    - `enable_pos_settlement_password_required` boolean
    - `enable_pos_customer_info_show_out_before_search` boolean
  - `products` ProductsSetting
    - `enabled_pos_product_customized_price` boolean
    - `enabled_pos_product_price_tier` boolean
    - `enabled_product_review` boolean — Enable product review.<br>啟用商品評價
    - `price_range_enabled` boolean — Show Price Range in the Store<br>前台顯示「價格區間」
    - `variation_display` 'dropdown' | 'swatches' — Display style for product variations in the store (Dropdown selection or Label swatches).<br> 商品規格於商店的顯示方式為「下拉選單」或「文字選項」
    - `addon_limit_enabled` boolean — Addon Limit Enabled<br>加購品數量上限
    - `enabled_show_member_price` boolean — Show member price in the store.<br>在前台顯示「會員價」
    - `enabled_stock_reminder` boolean — Show Low Inventory Reminder in the Store<br>在前台顯示「低庫存」提示
    - `show_sold_out` boolean — Show Sold Out Reminder in the Store<br>前台顯示「售完」提示
    - `enabled_pos_pinned_product` boolean — Enable pos pinned product.<br>啟用 POS 釘選商品功能
    - `show_max_discount_rate` object — Show max discount rate in the store.<br>在前台顯示「最低折扣規格」，與折扣的顯示方式
    - `sold_out_at_last` boolean — Enable Sort Sold-out Products Last on Storefront.<br>啟用「在前台將售完商品排序於後」
  - `checkout` CheckoutSetting
    - `enable_fast_checkout_qty` boolean
    - `enable_tc_location_redesign` boolean
    - `enable_ec_fast_checkout` boolean
    - `enable_sc_fast_checkout` boolean
    - `checkout_without_customer_name` boolean
    - `enforce_user_login_on_checkout` boolean
    - `checkout_without_email` boolean
    - `enabled_abandoned_cart_notification` boolean
    - `enable_membership_autocheck` boolean
    - `enable_subscription_autocheck` boolean
    - `rounding_setting` object
      - `enabled` boolean
      - `smallest_denomination` integer
      - `rounding_mode` string
    - `multi_checkout` object
      - `enabled` boolean
      - `cart_tags` object[]
        - `id` string
        - `priority` integer
        - `name_translations` NameTranslations — unresolved $ref
  - `third_party_ads` ThirdPartyAdsSetting
    - `facebook_domain_verification` object
      - `api_response` object
        - `status` string
    - `facebook` object — facebook ads setting
      - `business_id` string
      - `fb_access_token` string
      - `business_manager_id` string
      - `commerce_merchant_settings_id` string
      - `onsite_eligible` string
      - `pixel_id` string
      - `profiles` string[]
      - `ad_account_id` string
      - `catalog_id` string
      - `token_type` string
      - `pages` string[]
    - `adwords_data` object
      - `adwords_enabled` string
      - `credit_orders` object[]
        - `order_id` string
        - `credits` string
  - `tax` TaxSetting
    - `products_taxable` boolean — All Shops need Tax Collection<br>全店皆需收稅
  - `payments` PaymentsSetting
    - `deep_link` object
      - `ios` object — ios 平台的深層連結跳轉設定<br>
        - `schema` string — Deep Link URL Schema<br>付款完成後跳轉的深層連結<br>-<br>DeepLink Format:<br>saas{merchant_id}://web?url={redirect_url}
        - `enabled` boolean — Deep Link Enabled<br>是否開啟深層連結跳轉<br>
      - `android` object — android 平台的深層連結跳轉設定<br>
        - `schema` string — Deep Link URL Schema<br>付款完成後跳轉的深層連結<br>-<br>DeepLink Format:<br>saas{merchant_id}://web?url={redirect_url}
        - `enabled` boolean — Deep Link Enabled<br>是否開啟深層連結跳轉<br>
  - `product_review` ProductReviewSetting
    - `hide_review` boolean — Hide Review<br>是否隱藏評價
    - `hide` string[] — Hide Reviews of Given Stars<br>隱藏評價星等
    - `show_media` boolean — Show Media<br>是否顯示圖片
    - `allow_customer_upload_media` boolean — Allow Upload Media<br>評價是否可以上傳圖片
    - `enable_reward` boolean — Enable Reward<br>是否開啟評價獎賞
    - `reward_type` 'user_credit' | 'member_point' — Reward Type<br>評價獎賞類別
    - `review_reward_condition` object — Reward Condition<br>評價獎賞條件
      - `min_length` integer — Minimum comment length required<br>最少評論字數
      - `deadline_days` integer — Deadline days for reward<br>評價在order完成後送出的期限天數
      - `picture_upload` integer — Picture upload required<br>圖片上傳要求
  - `promotions` PromotionsSetting
    - `one_coupon_limit_enabled` boolean — Checkout Limitation to One Coupon<br> 購物車限用一組優惠代碼
    - `show_promotion_reminder` boolean — Show non-applied 'Free Shipping' promotion reminder on checkout page<br> 顯示未套用 '免運費' 活動提示於結帳購物車
    - `show_coupon` boolean — Show 'Coupon' in Storefront Member Center<br> 網店會員中心顯示 '優惠券'
    - `multi_order_discount_strategy` 'order_or_tier_promotion' | 'order_and_tier_promotions' | 'multi_order_and_tier_promotions' — Order-Level Discount Setting<br> 全店折扣優惠套用設定<br> order_or_tier_promotion:<br> Apply the promotion with largest discount among order-level discount promotions and membership offer.<br> 結帳擇優套用一組 全店滿額滿件折扣優惠 或 會員等級默認優惠<br> order_and_tier_promotions<br> Apply the promotion with largest discount among order-level discount promotions first and apply membership offer afterward.<br> 結帳擇優套用一組 全店滿額滿件折扣優惠後，疊加套用會員等級默認優惠<br> multi_order_and_tier_promotions<br> Apply multiple order-level discount promotions first and and apply membership offer afterward. 結帳疊加套用多組 全店滿額滿件折扣優惠 與 會員等級默認優惠<br>
    - `order_promotions_ignore_exclude_product` boolean — Order-level discount / Membership offer exclude 'product not applicable to discount'<br> 全店折扣優惠/會員等級默認優惠 排除「不適用折扣商品」
    - `order_gift_exclude_credit_and_point` boolean — [DEPRECATED] Total order over Minimum Amount Gift promotion condition deduct Credits and Points.<br> 全店滿額送贈品優惠條件扣除 折抵購物金 與 點數折現<br> This field will be deprecated. Please use `order_gift_threshold_mode` instead.<br> 此欄位即將淘汰，請改用 `order_gift_threshold_mode`。
    - `order_gift_threshold_mode` 'after_price_discounts' | 'after_all_discounts' — Gift Promotion – Minimum Amount Settings<br> 全店滿額送贈品<br> - `after_price_discounts`: Minimum amount is calculated as: Cart subtotal - Discounts (default)<br> 滿額條件以（購物車小計 - 折扣）計算（默認選中）<br> - `after_all_discounts`: Minimum amount is calculated as: Cart subtotal - Discounts - Credits - Points<br> 滿額條件以（購物車小計 - 折扣 - 折抵購物金 - 點數折現）計算
    - `category_item_gift_threshold_mode` 'before_discounts' | 'after_price_discounts' | 'after_all_discounts' — Free gift for selected products/categories over a minimum amount<br> 指定商品／分類滿額送贈品<br> - `before_discounts`: Minimum amount is calculated as: Selected product subtotal (default)<br> 滿額條件以（指定商品小計）計算（默認選中）<br> - `after_price_discounts`: Minimum amount is calculated as: Selected product subtotal - Discounts<br> 滿額條件以（指定商品小計 - 折扣）計算<br> - `after_all_discounts`: Minimum amount is calculated as: Selected product subtotal - Discounts - Credits - Points<br> 滿額條件以（指定商品小計 - 折扣 - 折抵購物金 - 點數折現）計算
    - `order_free_shipping_threshold_mode` 'after_price_discounts' | 'after_all_discounts' — Free shipping for order over a minimum amount<br> 全店滿額免運費<br> - `after_price_discounts`: Minimum amount is calculated as: Cart subtotal - Discounts<br> 滿額條件以（購物車小計 - 折扣）計算<br> - `after_all_discounts`: Minimum amount is calculated as: Cart subtotal - Discounts - Credits - Points (default)<br> 滿額條件以（購物車小計 - 折扣 - 折抵購物金 - 點數折現）計算（默認選中）
    - `category_item_free_shipping_threshold_mode` 'before_discounts' | 'after_price_discounts' | 'after_all_discounts' — Free shipping for selected products/categories over a minimum amount<br> 指定商品／分類滿額免運費<br> - `before_discounts`: Minimum amount is calculated as: Selected product subtotal (default)<br> 滿額條件以（指定商品小計）計算（默認選中）<br> - `after_price_discounts`: Minimum amount is calculated as: Selected product subtotal - Discounts<br> 滿額條件以（指定商品小計 - 折扣）計算<br> - `after_all_discounts`: Minimum amount is calculated as: Selected product subtotal - Discounts - Credits - Points<br> 滿額條件以（指定商品小計 - 折扣 - 折抵購物金 - 點數折現）計算

---

[API](https://skmtc.net/shoplineapp/apis/shopline-open-api.md) · [All operations](https://skmtc.net/shoplineapp/apis/shopline-open-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shoplineapp/shopline-open-api/revisions/1675ac12cde7/schema)