HomeGuidesAPI ReferenceChangelogDiscussions
HomeLog In
Guides

Get Users Setting

Function

To retrieve the setting of users
獲取用戶設定

URL

GET https://open.shopline.io/v1/settings/users

Request Parameters

FieldTypeDescriptionExample
include_fields[]Array包含 fields

enum:
- membership_tier_rules
- user_credit_rules
include_fields[]=user_credit_rules&include_fields[]=member_point_rules

Response Example

FieldTypeDescriptionExample
pos_apply_creditBooleanfalse
minimum_age_limitStringThe minimum age required for customers to shop at the online store
在網店購物的年齡下限
minimum: "13"
最小: "13"
maximum: "130"
最大: "130"
"13"
enable_member_pointBooleanWhether the member point rules are activated
會員點數規則是否正在生效
true
enable_user_creditBooleanStore Credits Toggle
商店購物金總開關
true
user_credit_rulesUser Credit RuleUser Credit Rule
購物金規則
member_point_rulesMember Point RuleMember Point Rules
會員點數規則
line_loginObjectLine Login Rule
Line登入規則
{
"status": "active"
}
birthday_formatStringThe birthday format of the user (default: "YYYY/MM/DD")
會員生日格式(預設:"YYYY/MM/DD")

Example Values:
- YYYY/MM/DD
- YYYY/MM
- MM/DD
YYYY/MM/DD
email_verificationObjectEnable Email Verification{ "status": "true" }
email_login_with_verificationObjectCustomer require Email Verification to login{ "status": "true" }
sms_verificationObjectEnable MobilePhone Verification{
"status": "true",
"supported_countries": ["*"]
}

Supported_countries value * means all country, otherwise, the value would be country code, e.g. 'TW'

ref: https://zh.wikipedia.org/zh-tw/ISO_3166-1
{
    "pos_apply_credit": false,
    "minimum_age_limit": "13",
    "enable_member_point": true,
    "enable_user_credit": true,
    "line_login": {
      "status": "active"
    },
    "email_verification": { "status": "true" },
    "email_login_with_verification": { "status": "true" },
    "sms_verification": {  
      "status": "true",
      "supported_countries": ["*"]  
    },
    "birthday_format": "YYYY/MM/DD"
}