應用場景
當特店的票券商品已完成上架，若需異動核銷或退貨的權限範圍，可透過本 API 依商品編號（ProductNo）重新設定該商品的核銷授權清單。可依需求彈性指定為「跨店核銷」（同一會員編號下所有分店皆可核銷）、「分店核銷」（僅限指定分店編號核銷），或另外開放「分店退貨」權限給特定門市。此設計適用於連鎖品牌總部視展店狀況、加盟合作調整或活動檔期，動態調整旗下各分店對特定商品的核銷／退貨授權範圍，而不需重新建立商品。
API 介接網址
- 測試環境：https://ecticket-stage.ecpay.com.tw/api/Ticket/SetproductsAuth
- 正式環境：https://ecticket.ecpay.com.tw/api/Ticket/SetproductsAuth
HTTPS傳輸協定
- Accept：text/html
- Content Type：application/json
- HTTP Method：POST
特店Request參數說明(JSON格式)
PlatformID String(10)
平台商編號
平台商在綠界的會員編號 [MerchantID]
MerchantID String(10)
特店編號 必填
RqHeader Object
傳輸資料 必填
Timestamp Number
傳入時間 必填
注意事項：
- 驗證時間區間暫訂為10分鐘內有效，若超過此驗證時間則此次訂單將無法建立，參考資料：http://www.epochconverter.com/。
- 合作特店須進行主機「時間校正」，避免主機產生時差，延伸API無法正常運作。
Data Object
加密資料 必填
CheckMacValue String
驗證碼 必填
請參考附錄檢查碼機制進行計算
特店Request參數範例(JSON格式)
{
"PlatformID": "3002599",
"MerchantID": "2000132",
"RqHeader": {
"Timestamp": 1525168923
},
"Data": "…",
"CheckMacValue": "…"
}
Data參數說明(Json格式)
注意事項：請在加密前對參數值進行 URLEncode
MerchantID String(10)
特店編號 必填
ProductNo String(8)
商品編號 必填
AuthorizeList Array[Object]
權限設定列表 必填
Type String(1)
權限類型 必填
- 1：跨店核銷權限
- 2：分店核銷權限
- 3：分店退貨權限
StoreIDs Array[String]
特店編號列表 必填
依 Type 傳入對應的編號：
- Type = 1（可跨店核銷）：請傳入會員編號（MID）
- Type = 2（可核銷分店）：請傳入分店編號
- Type = 3（可退貨分店）：請傳入分店編號
Data加密前資料範例(JSON格式)
{
"MerchantID":"2000132",
"ProductNo":"20240001",
"AuthorizeList": [
{"Type":"1","StoreIDs":["2000132","2000133"]},
{"Type":"2","StoreIDs":["1234567","1234568"]},
{"Type":"3","StoreIDs":["1234567"]}
]
}
特店Response參數說明(JSON格式)
PlatformID String(10)
平台商編號
平台商在綠界的會員編號 [MerchantID]
MerchantID String(10)
特店編號
特店編號
RpHeader Object
回傳資料
Timestamp Number
回傳時間
時間戳 Unix timestamp
TransCode Int
回傳代碼
1 代表 API 傳輸資料 (PlatformID, MerchantID, RqHeader, Data) 接收成功，實際的API執行結果狀態請參考 RtnCode 參數
TransMsg String(200)
回傳訊息
Data String
加密資料
此參數為加密過的 JSON 格式資料。加密方法說明
CheckMacValue String
檢查碼
請參考附錄檢查碼機制進行計算
綠界Response參數範例 (Json格式)
{
"PlatformID": "3002599",
"MerchantID": "2000132",
"RpHeader": {
"Timestamp": 1525169058
},
"TransCode": 1,
"TransMsg": "",
"Data": "…",
"CheckMacValue": "…"
}
Data參數說明(Json格式)
RtnCode Int
回應代碼
1為成功，其餘為失敗
RtnMsg String(200)
回應訊息
Data加密前資料範例(JSON格式)
{
"RtnCode":1,
"RtnMsg":"成功"
}
注意事項：
- API 限制：此 API 僅修改核銷及退貨權限，無法修改其他商品資訊。若需修改其他欄位，請呼叫「修改商品資訊」API。
- StoreIDs 覆蓋機制：傳入 StoreIDs 會直接覆蓋原有設定
- 請確認傳入資料正確，以免造成權限設定錯誤
- 若要清除設定（不指定／不開放），請傳入空陣列 []