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

# Get Users Setting

`GET /settings/users`

To retrieve the setting of users<br>獲取顧客設定

## Query parameters

- `include_fields[]` string[]

## Response `200`

OK

- 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>顧客註冊方式

## Other responses

- `500` — Server error

---

[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)