Get Members

Description

取得會員列表。透過模糊查詢的方式，取得會員資料。

Resource

GET /v1/user/members

Authorization

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

Query Parameters

Name	Type	Description
type	string (enum)	帳號類型 ALLOWED VALUES: VIP_ID PHONE_NUMBER
id	string	帳號若 type = PHONE_NUMBER，則 id 輸入手機末三碼若 type = VIP_ID，則 id 輸入完成會員編號。
## Request Example
GET /v1/user/members?type=VIP_ID&id=VIP001

Response Body Parameters

Name	Type	Description
members	Member[]	會員列表

Response Body Parameters - Member

Name	Type	Description
id	String	會員ID
name	String	姓名
zip	String	郵遞區號
address	String	地址
telephone	String	電話
sex	String	性別 ALLOWED VALUES: male：男 female：女 unknown：未設定
birthday	String	生日
email	String	信箱
mobile	String	手機號碼
group_id	String	會員群組ID
group_name	String	會員群組名稱
card_no	String	會員卡卡號
phone_carrier	string	手機載具
points	int	會員持有點數
Invitation_code	string	邀請碼
seal_quantity	int	集章數量 (optional) 會員沒有集章數量資訊時，將不會回傳此參數.
points_exchanged_amount	int	點數兌換金額
tax_id_number	string	統一編號 (optional)
default_carrier_type	string	預設載具類別 ALLOWED VALUES: PHONE_CARRIER MEMBER_CARRIER CITIZEN_DIGITAL_CERTIFICATE
citizen_digital_certificate	string	自然人憑證
apply_shop_id	string	申請門市編號
apply_date	string	申請日期
discount_rate	int	折扣率
is_can_credit	boolean	是否可賒帳
memo	string	備註
is_blacklist	boolean	是否為黑名單
disable_stores	Array[string]	停用門市列表

Response

{
  "members": [
    {
      "id": "021100543",
      "name": "Jane",
      "zip": null,
      "address": "復興南路二段171巷20號1樓",
      "telephone": "27006275",
      "sex": "Female",
      "birthday": "2020-01-01T00:00:00",
      "email": "[email protected]",
      "mobile": "0987654321",
      "points": "100",
      "group_id": "APP",
      "group_name": "品牌APP會員",
      "card_no": "",
      "phone_carrier": "",
      "Invitation_code": "6vq4tt",
      "seal_quantity": 0,
      "points_exchanged_amount": 10,
      "tax_id_number": "",
      "citizen_digital_certificate": "",
      "default_carrier_type": "PHONE_CARRIER",
      "apply_shop_id": "0",
      "apply_date": "2020-01-01 00:00:00",
      "discount_rate": 100,
      "is_can_credit": false,
      "memo": null,
      "is_blacklist": false,
      "disable_stores": ["000030", "000031"]
    }
  ]
}