查詢及通知 / 查詢物流訂單

快速導引

應用場景

提供特店查詢物流訂單功能

API介接網址

測試環境：https://logistics-stage.ecpay.com.tw/CrossBorder/QueryLogisticsTradeInfo
正式環境：https://logistics.ecpay.com.tw/CrossBorder/QueryLogisticsTradeInfo

HTTPS 傳輸協定

Content Type ：application/json
HTTP Method ：POST

特店傳入參數(Json格式)

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

PlatformID為與綠界有合作專案的特約平台商身分使用。一般特店或賣家身分(Merchant)，或平台商本身，此參數請帶放空值。
若隸屬於特約平台商的一般特店，此參數請帶放平台商的MerchantID。

MerchantID String(10)
特店編號 必填

RqHeader Object
傳入資料 必填

Timestamp String(10)
傳入時間

請將傳輸時間轉換為時間戳(GMT+8)，綠界會利用此參數將當下的時間轉為Unix TimeStamp來驗證此次介接的時間區間。

注意事項：

驗證時間區間為 10 分鐘內有效，若超過此驗證時間則此次API request將無法建立，參考資料：http://www.epochconverter.com/。
特店需進行主機「時間校正」，避免主機產生時差，造成API request失敗。

Data String
加密資料 必填

回傳相關資料，此為加密過JSON格式的資料。加密方法說明

特店傳入參數範例(Json格式)

				
					{
    "MerchantID": "2000132",
    "RqHeader": {
        "Timestamp": "1525168923",
        "Revision": "1.0.0"
    },
    "Data": "加密資料"
}

Data參數說明(Json格式)

MerchantID String(10)
特店編號 必填

LogisticsID String(20)
綠界訂單編號

Data參數範例

				
					{
 "MerchantID": "2000132",
 "LogisticsID ": "100001"
}

綠界回傳參數(Json格式)

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

PlatformID為與綠界有合作專案的特約平台商身分使用。一般特店或賣家身分(Merchant)，或平台商本身，此參數請帶放空值。
若隸屬於特約平台商的一般特店，此參數請帶放平台商的MerchantID。

MerchantID String(10)
特店編號

RpHeader Object
傳入資料

Timestamp String(10)
傳入時間

請將傳輸時間轉換為時間戳(GMT+8)，綠界會利用此參數將當下的時間轉為Unix TimeStamp來驗證此次介接的時間區間。

注意事項：

驗證時間區間為 10 分鐘內有效，若超過此驗證時間則此次API request將無法建立，參考資料：http://www.epochconverter.com/。
特店需進行主機「時間校正」，避免主機產生時差，造成API request失敗。

TransCode Int
回傳代碼

1 代表 API 傳輸資料(MerchantID, RqHeader, Data)接收成功，實際的 API 執行結果狀態請參考 RtnCode。

TransMsg String(200)
回傳訊息

回傳訊息

Data String
加密資料

回傳相關資料，此為加密過JSON格式的資料。加密方法說明

回傳參數範例

				
					{
"MerchantID": "2000132",
    "RpHeader": {
        "Timestamp": "1525169058"
    },
    "TransCode": 1,
    "TransMsg": "",
    "Data": "加密資料"
}

回傳Data參數說明(Json格式)

RtnCode Int
回應代碼

1 代表 API 執行成功，其餘代碼均為失敗，失敗代碼請參考交易訊息代碼表。

RtnMsgString(200)
回應訊息

MerchantTradeNo String(20)
特店訂單編號

特店訂單編號均為唯一值，不可重複使用。
英數字大小寫混合

ShipmentNo String(20)
配送編號

LogisticsType String(20)
物流類型

CB：跨境

LogisticsSubType String(20)
物流子類型

UNIMARTCBCVS：統一跨境店取
UNIMARTCBHOME：統一跨境宅配

ReceiverCountry String(20)
收件人國家

SG：新加坡
MY：馬來西亞
HK：香港

GoodsName String(200)
商品名稱

GoodsAmount Int
商品金額

商品遺失賠償依據，僅可使用數字，上限為新台幣20,000元

HandlingCharge Int
物流費用

TradeDate String(20)
訂單成立時間

格式為 yyyy/MM/dd HH:mm:ss

LogisticsStatus String(8)
物流狀態

回傳代碼請參考物流狀態代碼一覽表

回傳Data參數範例

				
					{
    "RtnCode": "1",
    "RtnMsg": "成功",
    "MerchantTradeNo": " xxxxxxxxxxxxxxxxx ",
    "LogisticsType": "CB",
    "LogisticsSubType": "UNIMARTCBCVS",
    "ReceiverCountry": "SG",
    "GoodsAmount": 1,
    "HandlingCharge": "262,
    "TradeDate": "2020/04/30 11:00:42",
    "LogisticsStatus": "300",
    "GoodsName": "XXX",
    "ShipmentNo": " xxxxxxxxxxxxxxxxx "
}

綠界官方網站