應用場景
特店進行物流訂單查詢作業
API介接網址
- 測試環境：https://logistics-stage.ecpay.com.tw/Helper/QueryLogisticsTradeInfo/V5
- 正式環境：https://logistics.ecpay.com.tw/Helper/QueryLogisticsTradeInfo/V5
HTTPS傳輸協定
- Accept：text/html
- Content Type：application/x-www-form-urlencoded
- HTTP Method：POST
特店Request參數說明
MerchantID String(10)
廠商編號 必填
由綠界科技提供
AllPayLogisticsID String(20)
綠界科技的物流交易編號
與MerchantTradeNo(廠商交易編號)需二擇一填寫
MerchantTradeNo String(20)
廠商交易編號
- 廠商交易編號均為唯一值，不可重複使用。
- 英數字大小寫混合。
- 與AllPayLogisticsID(綠界科技的物流交易編號)需二擇一填寫
TimeStamp Int
驗證時間 必填
- 將當下的時間轉為UnixTimeStamp，用於驗證此次介接的時間區間。
- 綠界科技驗證時間區間暫訂為 3 分鐘內有效，超過則此次介接無效。
- 參考資料：http://www.epochconverter.com/。
PlatformID String(10)
特約合作平台商代號
- 由綠界科技提供，此參數為專案合作的平台商使用，一般廠商介接請放空值。
- 若為專案合作的平台商使用時，請帶賣家所綁定的MerchantID。
CheckMacValue String
檢查碼 必填
請參考附錄檢查碼機制
綠界Response參數說明
ActualWeight Number
實際重量
- 當物流子類型[LogisticsSubType]為POST(中華郵政)才會回傳
- 上限20公斤，最多顯示至小數3位
- 單位是公斤
AllPayLogisticsID String(20)
綠界科技的物流交易編號
BookingNote String(50)
托運單號
物流類型為HOME才會回傳
CollectionAllocateAmount Int
物流代收款項撥款金額
注意事項：
當收到CollectionAllocateAmount為0元時，以下2種情境不代表撥款金額為0元
- 若代收金額[CollectionAmount]不為0且物流代收款項撥款日期[CollectionAllocateDate]無值，表示尚未撥款
- 若代收金額[CollectionAmount]為0元，表示本訂單為不須代收貨款
CollectionAllocateDate String(10)
物流代收款項撥款日期
格式為：yyyy/MM/dd
CollectionAmount Int
代收金額
CollectionChargeFee Int
代收金額手續費
CVSPaymentNo String(15)
寄貨編號
- 物流類型為CVS才會回傳
- 超商C2C配送編號請抓取此欄位，7-ELEVEN需再抓取CVSValidationNo進行組合
CVSValidationNo String(10)
驗證碼
(C2C) 7-ELEVEN才會回傳
注意事項：7-ELEVEN C2C 交貨便代碼為CVSPaymentNo與CVSValidationNo的組合。
GoodsAmount Int
商品金額
商品遺失賠償依據
GoodsName String(200)
商品名稱
GoodsWeight Number
商品重量
- 當物流子類型[LogisticsSubType]為POST(中華郵政)才會回傳
- 上限20公斤，最多顯示至小數3位
- 單位是公斤
HandlingCharge Int
物流費用
LogisticsStatus String(8)
物流狀態
請參考物流狀態代碼一覽表
LogisticsType String(20)
會員選擇的物流方式
請參考物流方式一覽表
MerchantID String(9)
廠商編號
MerchantTradeNo String(20)
廠商交易編號
ShipChargeDate String(10)
物流運費扣款日期
格式為：yyyy/MM/dd
ShipmentNo String(25)
配送編號
- 物流類型為CVS才會回傳
- 超商B2C配送編號請抓取此欄位
TradeDate String(20)
訂單成立時間
格式為：yyyy/MM/dd HH:mm:ss
SenderName String(10)
寄件人姓名
SenderPhone String(20)
寄件人電話
由於此參數在建單時為非必填，且申請物流服務時也非必填，所以可能回傳空值
SenderCellPhone String(10)
寄件人手機
CheckMacValue String
檢查碼
請參考附錄檢查碼機制
回應訊息範例：
ActualWeight=null&AllPayLogisticsID=1817824&BookingNote=&CollectionAllocateAmount=0&CollectionAllocateDate=&
CollectionAmount=0&CollectionChargeFee=0&CVSPaymentNo=&CVSValidationNo=&GoodsAmount=1&GoodsName=測試商品&GoodsWeight=null&HandlingCharge=52&LogisticsStatus=300&LogisticsType=CVS_UNIMART&MerchantID=2000132&
MerchantTradeNo=20211215142334754&ShipChargeDate=&
ShipmentNo=82420218218&TradeDate=2021/12/15 14:23:34&SenderName=王大明&SenderPhone=0222018909&SenderCell=0987878787&CheckMacValue=B655FB0F67E8F89DB9DD997D19C3B62D