應用場景:
API介接網址:
- 測試環境:https://logistics-stage.ecpay.com.tw/Express/v2/ReturnUniMartCVS
- 正式環境:https://logistics.ecpay.com.tw/Express/v2/ReturnUniMartCVS
HTTPS 傳輸協定
- Content Type :application/json
- HTTP Method :POST
特店傳入參數(Json格式)
PlatformID String(10)
特約合作平台商代號
- PlatformID為與綠界有合作專案的特約平台商身分使用。一般特店或賣家身分(Merchant),或平台商本身,此參數請帶放空值。
- 若隸屬於特約平台商的一般特店,此參數請帶放平台商的MerchantID。
RqHeader Object
傳入資料 必填
Timestamp String(10)
傳入時間 必填
請將傳輸時間轉換為時間戳(GMT+8),綠界會利用此參數將當下的時間轉為Unix TimeStamp來驗證此次介接的時間區間。
注意事項:
- 驗證時間區間為 5 分鐘內有效,若超過此驗證時間則此次訂單將無法建立,產生時間戳請參考相關資料。
- 合作特店須進行主機「時間校正」,避免主機產生時差,延伸API無法正常運作。
Data String
加密資料 必填
回傳相關資料,此為加密過JSON格式的資料。加密方法說明
特店傳入參數範例(Json格式)
{
"MerchantID": "2000132",
"RqHeader": {
"Timestamp": "1525168923"
},
"Data": "加密資料"
}
Data參數說明(Json格式)
MerchantID String(10)
特店編號 必填
LogisticsID String(20)
綠界訂單編號
ServerReplyURL String(200)
Server端回覆網址 必填
GoodsName String(50)
商品名稱
注意事項:不得輸入^ ‘ ` ! @ # % & * + \ ” < >| _ [ ]等特殊符號。
GoodsAmount Int
商品金額 必填
ServiceType String(5)
服務型態代碼 必填
SenderName String(10)
退貨人姓名
注意事項:
- 字元限制為4~10個字元(例:半形英文可支援4~10個字,中文可支援2~5個字)
- 不可帶入不符合姓名規則的文字如表情圖示(emoji符號)
注意事項:不可帶入數字和特殊符號(禁用特殊符號如下所示)
SenderPhone String(10)
退貨人手機
Remark String(40)
備註
Data參數範例
{
"MerchantID": "2000132",
"LogisticsID": "2000123",
"ServerReplyURL": "https://domain/test/receive",
"GoodsName": "測試商品",
"GoodsAmount": 1000,
"ServiceType": "4",
"SenderName": "測試退貨人",
"SenderPhone": "09xxxxxxxx",
"Remark": "備註"
}
綠界回傳參數說明(Json格式)
PlatformID String(10)
特約合作平台商代號
- PlatformID為與綠界有合作專案的特約平台商身分使用。一般特店或賣家身分(Merchant),或平台商本身,此參數請帶放空值。
- 若隸屬於特約平台商的一般特店,此參數請帶放平台商的MerchantID。
RpHeader Object
回傳資料
Timestamp String(10)
回傳時間
請將傳輸時間轉換為時間戳(GMT+8),綠界會利用此參數將當下的時間轉為Unix TimeStamp來驗證此次介接的時間區間。
注意事項:
- 驗證時間區間為 5 分鐘內有效,若超過此驗證時間則此次訂單將無法建立,產生時間戳請參考相關資料。
- 合作特店須進行主機「時間校正」,避免主機產生時差,延伸API無法正常運作。
TransCode Int
回傳代碼
1 代表 API 傳輸資料(MerchantID, RqHeader, Data)接收成功,實際的 API 執行結果狀態請參考 RtnCode。
TransMsg String(200)
回傳訊息
Data String
加密資料
綠界回傳參數範例
{
"MerchantID": "2000132",
"RpHeader": {
"Timestamp": "1525169058"
},
"TransCode": 1,
"TransMsg": "",
"Data": "加密資料"
}
回傳Data參數說明(Json格式)
RtnCode Int
回應代碼
1 代表 API 執行成功,其餘代碼均為失敗,失敗代碼請參考交易訊息代碼表。
RtnMsg String(200)
回應訊息
RtnMerchantTradeNo String(20)
綠界科技逆物流交易編號
RtnOrderNo String(12)
退貨編號
回傳Data參數範例
{
"RtnCode": 1,
"RtnMsg": "成功",
"RtnMerchantTradeNo": "xxxxxxxxxxx",
"RtnOrderNo": "xxxxxxxxx"
}