應用場景：
當有退貨的情況時，產生逆物流訂單，宅配業者會至退貨地址收件
注意事項：中華郵政不提供逆物流服務。 API介接網址：
- 測試環境：https://logistics-stage.ecpay.com.tw/Express/v2/ReturnHome
- 正式環境：https://logistics.ecpay.com.tw/Express/v2/ReturnHome
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)
綠界訂單編號
LogisticsSubType String(20)
物流子類型
注意事項：
- 若綠界訂單編號[LogisticsID]有值，且原物流類型[LogisticsType]為HOME(宅配)，本欄位可為空值。
- 若綠界訂單編號[LogisticsID]有值，且原物流類型[LogisticsType]為CVS(超商取貨)，本欄位不可為空值。
- 若綠界訂單編號[LogisticsID]為空值時，本欄位不可為空值。
ServerReplyURL String(200)
Server端回覆網址 必填
SenderName String(10)
退貨人姓名
- 若綠界訂單編號[LogisticsID]有值且與該訂單為相同的「物流子類型」時，退貨收件人與寄件人資訊會與原訂單相反且自動帶入宅配規格、溫層、距離、品名。
- 若資訊與關連物流交易不同時，可自行輸入
注意事項：
- 若綠界訂單編號[LogisticsID]有值，且原物流類型[LogisticsType]為HOME(宅配)，本欄位可為空值。
- 若綠界訂單編號[LogisticsID]有值，且原物流類型[LogisticsType]為CVS(超商取貨)，本欄位不可為空值。
- 若綠界訂單編號[LogisticsID]為空值時，本欄位不可為空值。
- 字元限制為4~10個字元(例：半形英文可支援4~10個字，中文可支援2~5個字)
- 不可帶入數字和特殊符號(禁用特殊符號如下所示)
- 不可帶入不符合姓名規則的文字如表情圖示(emoji符號)
SenderPhone String(20)
退貨人電話
注意事項：
- 若綠界訂單編號[LogisticsID]有值，且原物流類型[LogisticsType]為HOME(宅配)，本欄位可為空值。
- 若綠界訂單編號[LogisticsID]有值，且原物流類型[LogisticsType]為CVS(超商取貨)，本欄位不可為空值。
- 若物流交易編號[LogisticsID]為空值時，本欄位與退貨人手機 [SenderCellPhone]擇一不可為空)
- 允許數字+特殊符號；特殊符號僅限 ()-#
SenderCellPhone String(20)
退貨人手機
注意事項：
- 若綠界訂單編號[LogisticsID]有值，且原物流類型[LogisticsType]為HOME(宅配)，本欄位可為空值。
- 若綠界訂單編號[LogisticsID]有值，且原物流類型[LogisticsType]為CVS(超商取貨)，本欄位不可為空值。
- 若綠界訂單編號[LogisticsID]有值時，本欄位與退貨人電話 [SenderPhone]擇一不可為空
- 只允許數字、10 碼、09 開頭
SenderZipCode String(6)
退貨人郵遞區號
注意事項：
- 若綠界訂單編號[LogisticsID]有值，且原物流類型[LogisticsType]為HOME(宅配)，本欄位可為空值。
- 若綠界訂單編號[LogisticsID]有值，且原物流類型[LogisticsType]為CVS(超商取貨)，本欄位不可為空值。
- 若綠界訂單編號[LogisticsID]為空值時，本欄位不可為空值
SenderAddress String(60)
退貨人地址
注意事項：
- 若綠界訂單編號[LogisticsID]有值時，且原物流類型[LogisticsType] 為HOME(宅配)，本欄位可為空值。
- 若綠界訂單編號 [LogisticsID]有值時，且原物流類型[LogisticsType] 為CVS(超商取貨)，本欄位字元限制需大於 6 個字元，且不可超過 60個字元。
- 若綠界訂單編號[LogisticsID]為空值時，本欄位字元限制需大於6 個字元，且不可超過60個字元。
ReceiverName String(10)
收件人姓名
注意事項：
- 若綠界訂單編號[LogisticsID]有值時，且原物流類型[LogisticsType] 為HOME(宅配)，本欄位可為空值。
- 若綠界訂單編號[LogisticsID]有值時，且原物流類型[LogisticsType] 為CVS(超商取貨)，本欄位不可為空值。
- 若綠界訂單編號[LogisticsID]為空值時，本欄位不可為空值。
- 字元限制為4~10個字元(例：半形英文可支援4~10個字，中文可支援2~5個字)
- 不可帶入數字和特殊符號(禁用特殊符號如下所示)
- 不可帶入不符合姓名規則的文字如表情圖示(emoji符號)
ReceiverPhone String(20)
收件人電話
注意事項：
- 若綠界訂單編號[LogisticsID]不為空值時，且原物流類型[LogisticsType] 為HOME(宅配)，本欄位可為空值。
- 若綠界訂單編號[LogisticsID]不為空值時，且原物流類型[LogisticsType] 為CVS(超商取貨)，本欄位不可為空值。
- 若綠界訂單編號[LogisticsID]為空值時，本欄位與收件人手機 [ReceiverCellPhone]擇一不可為空)
- 允許數字+特殊符號；特殊符號僅限()-#
ReceiverCellPhone String(20)
收件人手機
注意事項：
- 若綠界訂單編號[LogisticsID]有值時，且原物流類型[LogisticsType] 為宅配HOME(宅配)，本欄位可為空值。
- 若綠界訂單編號[LogisticsID]有值時，且原物流類型[LogisticsType] 為CVS(超商取貨)，本欄位不可為空值。
- 若綠界訂單編號[LogisticsID]為空值時，本欄位與收件人電話 [ReceiverPhone]擇一不可為空
- 只允許數字、10 碼、09 開頭
ReceiverZipCode String(6)
收件人郵遞區號
注意事項：
- 若綠界訂單編號[LogisticsID]有值時，且原物流類型[LogisticsType] 為HOME(宅配)，本欄位可為空值。
- 若綠界訂單編號[LogisticsID]有值時，且原物流類型[LogisticsType] 為CVS(超商取貨)，本欄位不可為空值。
- 若綠界訂單編號[LogisticsID]為空值時，本欄位不可為空值。
ReceiverAddress String(60)
收件人地址
注意事項：
- 若綠界訂單編號[LogisticsID]有值時，且原物流類型[LogisticsType] 為HOME(宅配)，本欄位可為空值。
- 若綠界訂單編號[LogisticsID]有值時，且原物流類型[LogisticsType] 為CVS(超商取貨)，本欄位字元限制需大 於 6 個字元，且不可超過 60 個字元。
- 若綠界訂單編號[LogisticsID]為空值時，本欄位字元限制需大於 6 個字元，且不可超過 60 個字元。
ReceiverEmail String(50)
收件人Email
注意事項：
- 若綠界訂單編號[LogisticsID]有值時，且原物流類型[LogisticsType] 為HOME(宅配)，本欄位可為空值。
- 若綠界訂單編號[LogisticsID]有值時，且原物流類型[LogisticsType] 為CVS(超商取貨)，本欄位不可為空值。
- 若綠界訂單編號[LogisticsID]為空值時，本欄位不可為空值。
GoodsAmount Int
商品金額 必填
GoodsName String(50)
商品名稱
注意事項：不得輸入^ ‘ ` ! @ # % & * + \ ” < >| _ [ ]等特殊符號。
Temperature String(4)
溫層
- 0001:常溫 (預設值)
- 0002:冷藏
- 0003:冷凍
Distance String(2)
距離
- 00:同縣市 (預設值)
- 01:外縣市
- 02:離島
注意事項：當系統檢查到收件人地址(ReceiverAddress)與寄件人地址 (SenderAddress)所屬縣市與距離(Distance) 輸入的值不相符時，系統將自動更正距離 (Distance)為正確值。
Specification String(4)
規格
- 0001: 60cm (預設值)
- 0002: 90cm
- 0003: 120cm
- 0004: 150cm
注意事項：溫層選擇0002:冷藏和0003:冷凍時，此規格參數不可帶入0004:150cm。
ScheduledDeliveryTime String(2)
預定送達時段
- 1: 13 前
- 2: 14~18
- 4:不限時
PlatformID String(10)
特約合作平台商代號
- PlatformID為與綠界有合作專案的特約平台商身分使用。一般特店或賣家身分(Merchant)，或平台商本身，此參數請帶放空值。
- 若隸屬於特約平台商的一般特店，此參數請帶放平台商的MerchantID。
Remark String(40)
備註
由綠界科技提供，此參數為專案合作的平 台商使用，一般廠商介接請放空值。若為專案合作的平台商使用時， MerchantID 請帶賣家所綁定的 MerchantID。
Data參數範例
{
"MerchantID":"2000132",
"LogisticsID":"1168007",
"LogisticsSubType":"TCAT",
"ServerReplyURL":"https://domain/test",
"SenderName":"測試退貨人",
"SenderPhone":"02-26551775",
"SenderCellPhone":"0941555444",
"SenderZipCode":"115",
"SenderAddress":"台北市南港區xxxxx",
"ReceiverName":"測試收件人",
"ReceiverPhone":"02-26551775",
"ReceiverCellPhone":"09xxxxxxxxx",
"ReceiverZipCode":"115",
"ReceiverAddress":"台北市南港區xxxxxx",
"ReceiverEmail":"xxxx@xxxxxx.com",
"GoodsAmount":1000,
"GoodsName":"測試商品",
"Temperature":"0001",
"Distance":"00",
"Specification":"0001",
"ScheduledDeliveryTime":"4",
"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參數範例
{
"RtnCode": 1,
"RtnMsg": "成功"
}