Skip to content

Get Member Data

Description

取得會員資料。

Resource

GET /v1/user

Authorization

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

Query Parameters

Name Type Description
source string 來源
ALLOWED VALUES:
  • SOOCKER

(optional)
phone_number string 會員手機號碼
(conditional)
Wixtar 會員（member_source = 5）為必填；若未傳入將回傳 HTTP 400 Bad Request（{"message": "缺少必要參數: phone_number"}）。非 Wixtar 會員無須傳入。

Response Body Parameters

Name Type Description
id string 會員ID
name string 姓名
zip string 郵遞區號
address string 地址
area_code string 市話區碼
telephone string 電話
extension_number string 分機號碼
sex string 性別
ALLOWED VALUES:
  • male：男
  • female：女
  • neutral：中性
  • unknown：未設定
birthday string 生日
email string 信箱
mobile string 手機號碼
group_id string 會員群組ID
group_name string 會員群組名稱
card_no string 會員卡卡號
phone_carrier string 手機載具
points string 會員持有點數
Invitation_code string 邀請碼
seal_quantity integer 集章數量
(optional)
會員沒有集章數量資訊時，將不會回傳此參數.
points_exchanged_amount integer 點數兌換金額
type string 類型
ALLOWED VALUES:
  • FRIEND
  • MEMBER
update_birthday_time string 修改生日時間，格式 YYYY-MM-DD HH:MM:SS
從未修改過生日時為 null
tax_id_number string 統一編號
(optional)
citizen_digital_certificate string 自然人憑證
default_carrier_type string 預設載具類別
ALLOWED VALUES:
  • PHONE_CARRIER
  • MEMBER_CARRIER
  • CITIZEN_DIGITAL_CERTIFICATE
is_blacklist boolean 是否為黑名單
會員帳號遭停權/凍結或已註銷時亦回傳 true
memo string 備註
member_card_image_url string 會員卡圖檔網址
tickets integer 會員持有票券張數
prepaid_card_no string 會員實體卡卡號
vip_level_validity_date string 會員等級有效期限
member_discount_rate Member Discount Rate 會員折扣率
city string 居住城市
(optional)
district string 居住區域
(optional)
available_ticket_count integer 可用票券數量
與票券列表（GET /v2/ticket?type=APP，不帶門市代碼）的內容一致：僅計入已收藏、尚未使用、且目前仍在有效期間內的票券。
票券有多組效期設定時，以最早到期者為準。
本平台不提供票券服務的品牌一律回 0
member_status string 會員狀態
ALLOWED VALUES:
  • 0：正常 (NORMAL)
  • 1：停權/凍結 (SUSPENDED)
  • 2：註銷/刪除 (DELETED)
daily_last_points integer 當日剩餘可折抵額度
已扣掉當日已使用的部分，並與會員持有點數取較小值。
未設定每日額度規則時，回與 points 相同的數值
excluded_store_ids array of string 此會員不可使用點數折抵的門市編號
無限制時為空陣列 []，不會是 null
employee_company_name string 員工所屬公司名稱
無資料時為空字串
cost_center_id string 成本中心編號
無資料時為空字串
cost_center_name string 成本中心名稱
無資料時為空字串
employee_no string 員工編號
無資料時為空字串

Response Body Parameters - Member Discount Rate

Name Type Description
product_category_id string 商品類別編號
discount_rate float 會員折扣率

Response

{
  "id": "021100543",
  "name": "Jane",
  "zip": null,
  "address": "台北市大安區復興南路二段171巷20號1樓",
  "area_code": "02",
  "telephone": "27006275",
  "extension_number": "20",
  "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,
  "type": "MEMBER",
  "update_birthday_time": "2022-09-07 14:28:47",
  "tax_id_number": "",
  "citizen_digital_certificate": "",
  "default_carrier_type": "PHONE_CARRIER",
  "is_blacklist": false,
  "memo": "",
  "member_card_image_url": "https://member_card_image_url.wixtar.com",
  "tickets": 1,
  "prepaid_card_no": "",
  "daily_last_points": 90,
  "excluded_store_ids": ["000030", "000031"],
  "employee_company_name": "",
  "cost_center_id": "",
  "cost_center_name": "",
  "employee_no": "",
  "vip_level_validity_date": "2024-12-12",
  "member_discount_rate": [
    {
      "product_category_id": "DEP_ID_001",
      "discount_rate": 0.8
    },
    {
      "product_category_id": "DEP_ID_002",
      "discount_rate": 0.7
    }
  ],
  "available_ticket_count": 1,
  "member_status": "0"
}

Notes

  • daily_last_points 與 points 是兩個不同的問題：points 是會員持有的總點數，daily_last_points 是「今天還能折抵多少」。有設定每日額度規則時兩者不同值。
  • daily_last_points 恆不大於 points（可作為前端的檢核依據）。
  • 折抵畫面應讀 daily_last_points，不是 points。
  • excluded_store_ids 與既有的 disable_stores 是不同層級的限制，兩者都需檢查，任一命中即不可折抵。後端在核銷點數時不檢查交易門市，須由前端自行比對並阻擋。