Sign in

v1

latestOpenAPI 3.0.02026-07-26318168886.7 KB
Settings

Get Users Setting

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

get/settings/users

Query parameters

include_fields[]string[]

Provide additional attributes in the response<br>結果添加哪些參數

Response

OK

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"為當月一號）

pos_apply_creditboolean nullable
pos_apply_member_pointboolean nullable
minimum_age_limitstring 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_pointboolean

Whether the member point rules are activated <br>會員點數規則是否正在生效

enable_user_creditboolean

Store Credits Toggle<br>商店購物金總開關

enable_age_policyboolean

Age Policy Toggle<br>是否開啟顧客已滿年齡同意文案

signup_method'email' | 'mobile' | 'email_and_mobile'

Customer signup method<br>顧客註冊方式

Example response

{
  "membership_promo_banner": {
    "text": {
      "custom_content": {
        "zh": {
          "title": "尊榮會員專屬優惠",
          "content": "立即享有滿千折百優惠！\n更多好康等你拿～"
        },
        "en": {
          "title": "Exclusive VIP Offer",
          "content": "Enjoy $100 off every $1000 spent.\nJoin now for more surprises!"
        }
      }
    },
    "image": {
      "custom_content": {
        "zh": {
          "images": {
            "original": {
              "width": 56,
              "height": 56,
              "url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/68400502f67621269287fa5b/original.png?1749026050"
            }
          },
          "_id": "68400502f67621269287f15b"
        }
      }
    }
  },
  "user_credit_rules": [
    {
      "apply_conditions": [
        {
          "credit_value": 100,
          "apply_threshold": 1000
        }
      ],
      "created_at": "2018-01-10T09:32:29.154+00:00",
      "updated_at": "2018-01-10T09:32:29.154+00:00"
    }
  ],
  "member_point_rules": [
    {
      "id": "61af3c6be0adc70043875be9",
      "status": "active",
      "unit_price": 50,
      "points_per_unit": 5,
      "points_expire_day": 1,
      "points_expire_month": 1,
      "pending_days": 1,
      "rule_type": "earn_from_order",
      "remarks_translations": {
        "en": "rules",
        "zh-hant": "規則"
      },
      "membership_tier_id": "5a7bf962e3880950d100026a",
      "unit_point": 50,
      "price_per_unit": 1,
      "point_value": 20,
      "apply_threshold": 30,
      "available_platforms": [
        "ec",
        "retail"
      ]
    }
  ],
  "minimum_age_limit": "13",
  "enable_member_point": true,
  "enable_user_credit": true
}