Wixtar Member Point Rules
Description
Wixtar 全通路會員中介平台 - 品牌點數規則總覽查詢 API。提供外部平台透過全通路 API 中介層發送點數規則總覽查詢請求至 Wixtar 會員平台 (GET /v1/public/point_rules)。涵蓋累點基礎規則、各會員群組累點倍率、折抵現金/兌換票券規則清單。
Resource
GET /v1/member/wixtar/point_rules
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。
認證模式二擇一:若提供 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 |
| brand_id |
string |
(optional) 品牌編號 (長度上限 10 字元) |
Request Example
GET /v1/member/wixtar/point_rules?brand_id=24436074 HTTP/1.1
Host: localhost:5000
Authorization: Bearer <YOUR_ACCESS_TOKEN>
X-Client-Id: POS01
X-Shop-Id: S001
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 |
| brand_id |
string |
品牌編號 |
| brand_name |
string |
品牌名稱 |
| spending_per_point |
number |
消費滿多少元累積 1 點 |
| vip_groups |
Vip Groups[] |
會員群組累點倍率清單 |
| cash_redeem_rule |
Cash Redeem Rule |
折現規則資訊 (無規則時為 null) |
| voucher_redeem_rules |
Voucher Redeem Rules[] |
兌換票券規則清單,無規則時為 [] |
Response Body Parameters - Vip Groups
| Name |
Type |
Description |
| vip_group_id |
string |
會員群組編號 |
| vip_group_name |
string |
會員群組名稱 |
| point_multiplier |
number |
點數倍率 (例如: 1.2 代表積點 1.2 倍) |
Response Body Parameters - Cash Redeem Rule
| Name |
Type |
Description |
| rule_id |
string |
折抵/兌換規則代碼 |
| rule_name |
string |
折抵/兌換規則名稱 |
| exchange_rate |
number |
折抵兌換比率 (多少點兌換 1 元或 1 張票券) |
| max_amount |
number |
金額上限 (元,無上限為 null) |
| max_percent |
number |
比例上限 (%,無上限為 null) |
| voucher_prod_id |
string |
兌換票券商品編號 (僅 voucher_redeem_rules 有值;cash_redeem_rule 固定為 null) |
| voucher_prod_name |
string |
兌換票券商品名稱 (僅 voucher_redeem_rules 有值;cash_redeem_rule 固定為 null) |
| description |
string |
票券說明或規則限制 |
Response Body Parameters - Voucher Redeem Rules
| Name |
Type |
Description |
| rule_id |
string |
折抵/兌換規則代碼 |
| rule_name |
string |
折抵/兌換規則名稱 |
| exchange_rate |
number |
折抵兌換比率 (多少點兌換 1 元或 1 張票券) |
| max_amount |
number |
金額上限 (元,無上限為 null) |
| max_percent |
number |
比例上限 (%,無上限為 null) |
| voucher_prod_id |
string |
兌換票券商品編號 (僅 voucher_redeem_rules 有值;cash_redeem_rule 固定為 null) |
| voucher_prod_name |
string |
兌換票券商品名稱 (僅 voucher_redeem_rules 有值;cash_redeem_rule 固定為 null) |
| description |
string |
票券說明或規則限制 |
Response Example - Http Code = 200
{
"status": 200,
"code": "000000",
"message": "Success",
"data": {
"brand_id": "24436074",
"brand_name": "星益欣資訊",
"spending_per_point": 100.0,
"vip_groups": [
{
"vip_group_id": "NORMAL",
"vip_group_name": "一般會員",
"point_multiplier": 1.0
},
{
"vip_group_id": "VIP",
"vip_group_name": "VIP 會員",
"point_multiplier": 1.2
}
],
"cash_redeem_rule": {
"rule_id": "20260522001",
"rule_name": "點數折抵現金",
"exchange_rate": 10.0,
"max_percent": 10.0,
"description": "每 10 點折抵 1 元,最高折抵 10%"
},
"voucher_redeem_rules": [
{
"rule_id": "20260522004",
"rule_name": "兌換美式咖啡",
"exchange_rate": 50.0,
"voucher_prod_id": "TicketBA02",
"voucher_prod_name": "美式咖啡兌換券",
"description": "使用 50 點兌換美式咖啡兌換券乙張"
}
]
}
}
Response Example 錯誤回應 - 400 品牌編號無法確定
{
"status": 200,
"code": "400",
"message": "品牌編號無法確定,請帶入 brand_id 或使用品牌 Token"
}
Response Example 錯誤回應 - 500 查詢點數規則失敗
{
"status": 200,
"code": "500",
"message": "查詢點數規則失敗"
}