物流整合API技術文件

宅配 / 產生逆物流訂單Ⅱ

應用場景

當有退貨的情況時，產生逆物流訂單，宅配業者會至退貨地址收件。
注意事項：中華郵政不提供逆物流服務

API介接網址

  • 測試環境：https://logistics-stage.ecpay.com.tw/Express/ReturnHome
  • 正式環境：https://logistics.ecpay.com.tw/Express/ReturnHome

HTTPS傳輸協定

  • Accept：text/html
  • Content Type：application/x-www-form-urlencoded
  • HTTP Method：POST

特店Request參數說明

MerchantID String(10)
廠商編號 必填

由綠界科技提供

AllPayLogisticsID String(20)
綠界科技的物流交易編號

❗ 注意事項：

  • 與物流子類型[LogisticsSubType]擇一不可為空。
  • 僅限數字，不可使用特殊符號、英文

LogisticsSubType String(20)
物流子類型

TCAT:黑貓

❗ 注意事項：

  • 若物流交易編號[AllPayLogisticsID]不為空值時，且原物流類型[LogisticsType]為HOME(宅配)本欄位可為空值。
  • 若物流交易編號[AllPayLogisticsID]不為空值時，且原物流類型[LogisticsType]為CVS(超商取貨)，本欄位不可為空值。
  • 若物流交易編號[AllPayLogisticsID]為空值時，本欄位不可為空值。

ServerReplyURL String(200)
Server端回覆網址 必填

物流狀態都會透過此URL通知。

SenderName String(10)
退貨人姓名 

  • 若AllPayLogisticsID有值且該訂單為相同的「物流子類型」時，退貨收件人與寄件人資訊會與原訂單相反且自動帶入宅配規格、溫層、距離、品名。
  • 若資訊與關連物流交易不同時，可自行輸入

❗ 注意事項：

  • 若物流交易編號[AllPayLogisticsID]不為空值時，且原物流類型[LogisticsType]為HOME(宅配)本欄位可為空值。
  • 若物流交易編號[AllPayLogisticsID]不為空值時，且原物流類型[LogisticsType]為CVS(超商取貨)，本欄位不可為空值。
  • 若物流交易編號[AllPayLogisticsID]為空值時，本欄位不可為空值。
  • 字元限制為4~10個字元(例：半形英文可支援4~10個字，中文可支援2~5個字)
  • 不可帶入數字和特殊符號(禁用特殊符號如下所示)
  • 不可帶入不符合姓名規則的文字如表情圖示(emoji符號)

SenderPhone String(20)
退貨人電話 

❗ 注意事項：

  • 若物流交易編號[AllPayLogisticsID]不為空值時，且原物流類型[LogisticsType]為HOME(宅配)本欄位可為空值。
  • 若物流交易編號[AllPayLogisticsID]不為空值時，且原物流類型[LogisticsType]為CVS(超商取貨)，本欄位不可為空值。
  • 若物流交易編號[AllPayLogisticsID]為空值時，本欄位與退貨人手機[SenderCellPhone]擇一不可為空
  • 允許數字+特殊符號；特殊符號僅限()-#

SenderCellPhone String(20)
退貨人手機 

❗ 注意事項：

  • 若物流交易編號[AllPayLogisticsID]不為空值時，且原物流類型[LogisticsType]為HOME(宅配)本欄位可為空值。
  • 若物流交易編號[AllPayLogisticsID]不為空值時，且原物流類型[LogisticsType]為CVS(超商取貨)，本欄位不可為空值。
  • 若物流交易編號[AllPayLogisticsID]為空值時，本欄位與退貨人電話[SenderPhone]擇一不可為空
  • 只允許數字、10碼、09開頭

SenderZipCode String(6)
退貨人郵遞區號

❗ 注意事項：

  • 若物流交易編號[AllPayLogisticsID]不為空值時，且原物流類型[LogisticsType]為HOME(宅配)本欄位可為空值。
  • 若物流交易編號[AllPayLogisticsID]不為空值時，且原物流類型[LogisticsType]為CVS(超商取貨)，本欄位不可為空值。
  • 若物流交易編號[AllPayLogisticsID]為空值時，本欄位不可為空值。

SenderAddress String(60)
退貨人地址

❗ 注意事項：

  • 若物流交易編號[AllPayLogisticsID]不為空值時，且原物流類型[LogisticsType]為HOME(宅配)本欄位可為空值。
  • 若物流交易編號[AllPayLogisticsID]不為空值時，且原物流類型[LogisticsType]為CVS(超商取貨)，本欄位字元限制需大於6個字元，且不可超過60個字元。
  • 若物流交易編號[AllPayLogisticsID]為空值時，本欄位字元限制需大於6個字元，且不可超過60個字元。

ReceiverName String(10)
收件人姓名

❗ 注意事項：

  • 若物流交易編號[AllPayLogisticsID]不為空值時，且原物流類型[LogisticsType]為HOME(宅配)本欄位可為空值。
  • 若物流交易編號[AllPayLogisticsID]不為空值時，且原物流類型[LogisticsType]為CVS(超商取貨)，本欄位不可為空值。
  • 若物流交易編號[AllPayLogisticsID]為空值時，本欄位不可為空值。
  • 字元限制為4~10個字元(例：半形英文可支援4~10個字，中文可支援2~5個字)
  • 不可帶入數字和特殊符號(禁用特殊符號如下所示)
  • 不可帶入不符合姓名規則的文字如表情圖示(emoji符號)

ReceiverPhone String(20)
收件人電話 

❗ 注意事項：

  • 若物流交易編號[AllPayLogisticsID]不為空值時，且原物流類型[LogisticsType]為HOME(宅配)本欄位可為空值。
  • 若物流交易編號[AllPayLogisticsID]不為空值時，且原物流類型[LogisticsType]為CVS(超商取貨)，本欄位不可為空值。
  • 若物流交易編號[AllPayLogisticsID]為空值時，本欄位與收件人手機[ReceiverCellPhone]擇一不可為空
  • 允許數字+特殊符號；特殊符號僅限()-#

ReceiverCellPhone String(20)
收件人手機

❗ 注意事項：

  • 若物流交易編號[AllPayLogisticsID]不為空值時，且原物流類型[LogisticsType]為HOME(宅配)本欄位可為空值。
  • 若物流交易編號[AllPayLogisticsID]不為空值時，且原物流類型[LogisticsType]為CVS(超商取貨)，本欄位不可為空值。
  • 若物流交易編號[AllPayLogisticsID]為空值時，本欄位與收件人電話[ReceiverPhone]擇一不可為空
  • 只允許數字、10碼、09開頭

ReceiverZipCode String(6)
收件人郵遞區號

❗ 注意事項：

  • 若物流交易編號[AllPayLogisticsID]不為空值時，且原物流類型[LogisticsType]為HOME(宅配)本欄位可為空值。
  • 若物流交易編號[AllPayLogisticsID]不為空值時，且原物流類型[LogisticsType]為CVS(超商取貨)，本欄位不可為空值。
  • 若物流交易編號[AllPayLogisticsID]為空值時，本欄位不可為空值。

ReceiverAddress String(60)
收件人地址

❗ 注意事項：

  • 若物流交易編號[AllPayLogisticsID]不為空值時，且原物流類型[LogisticsType]為HOME(宅配)本欄位可為空值。
  • 若物流交易編號[AllPayLogisticsID]不為空值時，且原物流類型[LogisticsType]為CVS(超商取貨)，本欄位字元限制需大於6個字元，且不可超過60個字元。
  • 若物流交易編號[AllPayLogisticsID]為空值時，本欄位字元限制需大於6個字元，且不可超過60個字元。

ReceiverEmail String(50)
收件人email 

❗ 注意事項：

  • 若物流交易編號[AllPayLogisticsID]不為空值時，且原物流類型[LogisticsType]為HOME(宅配)本欄位可為空值。
  • 若物流交易編號[AllPayLogisticsID]不為空值時，且原物流類型[LogisticsType]為CVS(超商取貨)，本欄位不可為空值。
  • 若物流交易編號[AllPayLogisticsID]為空值時，本欄位不可為空值。

GoodsAmount Int
商品金額 必填

  • 金額範圍為1~20000元
  • 此為商品遺失賠償依據，僅可使用數字

GoodsName String(60)
商品名稱 

  • 不得輸入^ ‘ ` ! @ # % & * + \ ” < >| _ [ ]等特殊符號。
  • 若物流子類型[LogisticsSubType]為TCAT(黑貓)，請勿使用全形符號。

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

❗ 注意事項：當溫層(Temperature)選擇【0002:冷藏】和【0003:冷凍】時，規格(Specification)請勿使用【0004:150cm】

ScheduledPickupTime String(1)
預定取件時段

  • 宅配物流商預定取貨的時段
  • 目前不提供預定取貨時段，請固定帶入4 (不限時)

ScheduledDeliveryTime String(2)
預定送達時段 

宅配物品預定送達的時段

  • 1: 13點前
  • 2: 14點~18點
  • 3: 14點~18點
  • 4:不限時

Remark String(200)
備註

PlatformID String(10)
特約合作平台商代號

  • 由綠界科技提供，此參數為專案合作的平台商使用，一般廠商介接請放空值。
  • 若為專案合作的平台商使用時，請帶賣家所綁定的MerchantID。

CheckMacValue String
檢查碼 必填

請參考附錄檢查碼機制

綠界Response參數說明

回傳值為純字串並無參數名稱。

  • 若回傳值為1|OK時為成功
  • 未回傳或回傳為非1|OK時為失敗
				
					1|OK

Copyright © Green World FinTech Service Co., Ltd. All rights reserved.

綠界官方網站