Wixtar Member Points Summary

Description

Wixtar 全通路會員中介平台 - 會員點數查詢 API。提供外部平台透過全通路 API 中介層發送點數摘要查詢請求至 Wixtar 會員平台 (GET /v1/public/members/points/summary)。支援以會員編號 (vip_id)、手機號碼 (mobile)、外部平台與卡號組合 (external_platform + external_card_no) 或身分綁定組合 (identity_type + identity_value) 查詢會員之剩餘總點數與最近到期日。

Resource

GET /v1/member/wixtar/points/summary

Authorization

採用 OAuth 2.0 Bearer Token（全通路 Token），並支援以下兩種 Wixtar 認證模式（兩者擇一提供）： * 模式 1 (裝置端自管 Token，推薦)：於 Header 帶入 X-Member-Center-Token（由 Wixtar Member Token 取得），此時 X-Client-Id 與 X-Shop-Id 為選填。 * 模式 2 (後端代管 Token，向後相容)：未帶入 X-Member-Center-Token 時，必須在 Header 提供 X-Client-Id 與 X-Shop-Id，全通路將自動依後台設定與 Redis 快取代管換發 Token。

Request Headers

認證模式二擇一：若提供 X-Member-Center-Token，則 X-Client-Id 與 X-Shop-Id 為選填；若未提供 X-Member-Center-Token，則 X-Client-Id 與 X-Shop-Id 為必填。

Name	Type	Description
X-Member-Center-Token	string	(optional) 裝置端自管之 Wixtar Access Token (由 POST /v1/member/wixtar/token 取得)。若有提供則優先以此 Token 轉發 Wixtar
X-Client-Id	string	(optional/條件必填) POS 機或呼叫端設備代碼。若未提供 X-Member-Center-Token 則為必填
X-Shop-Id	string	(optional/條件必填) 門市代碼。若未提供 X-Member-Center-Token 則為必填

Request Query Parameters

Name	Type	Description
vip_id	string	(optional) 會員編號 (查找鍵之一)
mobile	string	(optional) 手機號碼 (查找鍵之一)
external_platform	string	(optional) 外部平台代碼 (查找鍵之一，須搭配 external_card_no)
external_card_no	string	(optional) 外部會員卡號 (查找鍵之一，須搭配 external_platform)
identity_type	string	(optional) 身分綁定類型 (查找鍵之一，須搭配 identity_value；2=LINE UID)
identity_value	string	(optional) 身分綁定值 (查找鍵之一，須搭配 identity_type)
brand_id	string	(optional) 品牌編號

Request Example

GET /v1/member/wixtar/points/summary?vip_id=CM00000001 HTTP/1.1
Host: localhost:5000
Authorization: Bearer <YOUR_ACCESS_TOKEN>

Response Body Parameters

Name	Type	Description
status	integer	HTTP 狀態碼 (例如: 200)
code	string	業務回應代碼 (成功為 "000000")
message	string	回應訊息 (例如: "Success")
data	Data	主要業務資料內容

Response Body Parameters - Data

Name	Type	Description
vip_id	string	會員編號
remaining_total_points	integer	目前可用點數（已扣除 active freeze）
nearest_deadline	string	最近一筆點數到期日 (格式: YYYY-MM-DD HH:mm:ss，field 包含 point 時出現)
nearest_deadline_unused_points	integer	最近到期日剩餘點數
expire_in_30_days_unused_points	integer	30 天內到期點數
expire_in_60_days_unused_points	integer	60 天內到期點數
expire_in_90_days_unused_points	integer	90 天內到期點數

Response Example - Http Code = 200

{
  "status": 200,
  "code": "000000",
  "message": "Success",
  "data": {
    "vip_id": "CM00000001",
    "remaining_total_points": 500,
    "nearest_deadline": "2026-12-31 00:00:00",
    "nearest_deadline_unused_points": 200,
    "expire_in_30_days_unused_points": 0,
    "expire_in_60_days_unused_points": 0,
    "expire_in_90_days_unused_points": 50
  }
}

Response Example 錯誤回應 - 400 external欄位不成對

{
  "status": 200,
  "code": "400",
  "message": "external_platform 與 external_card_no 必須同時提供或同時省略"
}

Response Example 錯誤回應 - 400 external_platform不合法

{
  "status": 200,
  "code": "400",
  "message": "external_platform 不合法，合法值為：1~13"
}

Response Example 錯誤回應 - 400 identity欄位不成對

{
  "status": 200,
  "code": "400",
  "message": "identity_type 與 identity_value 必須同時提供或同時省略"
}

Response Example 錯誤回應 - 400 identity_type不合法

{
  "status": 200,
  "code": "400",
  "message": "identity_type 不合法，本 API 僅支援 2（會員載具）"
}

Response Example 錯誤回應 - 400 查找鍵全空

{
  "status": 200,
  "code": "400",
  "message": "vip_id、mobile、external_platform + external_card_no、identity_type + identity_value 至少填一個"
}

Response Example 錯誤回應 - 400 identity查詢需帶brand_id

{
  "status": 200,
  "code": "400",
  "message": "identity 查詢需帶 brand_id 或使用集團 Token"
}

Response Example 錯誤回應 - 404 查無對應會員

{
  "status": 200,
  "code": "404",
  "message": "查無對應會員"
}

Response Example 錯誤回應 - 400 會員交易處理中

{
  "status": 200,
  "code": "400",
  "message": "會員交易處理中，請稍後再試"
}

Response Example 錯誤回應 - 500 查詢點數摘要失敗

{
  "status": 200,
  "code": "500",
  "message": "查詢點數摘要失敗"
}