應用場景
當物流狀態變更時,綠界server會主動傳送物流狀態通知(callback)至特店的server(ServerReplyURL)。
- Step1. 綠界科技:以 ServerPost 方式傳送物流狀態至合作特店設定的(ServerReplyURL) 網址
- Step2. 合作特店:收到綠界的通知(callback)需回傳RtnCode:1、RtnMsg:OK
注意事項:
- 若特店未正確回應(RtnCode:1、RtnMsg:OK),綠界server會隔60分鐘後重發通知給特店,當天重複發送三次。
- 若特店持續收到綠界回傳的通知,請檢查ServerReplyURL的接收程式是否未正確回應(RtnCode:1、RtnMsg:OK)給綠界。
HTTPS 傳輸協定
- Content Type :application/json
- HTTP Method :POST
綠界呼叫參數(Json格式)
PlatformID String(10)
特約合作平台商代號
- PlatformID為與綠界有合作專案的特約平台商身分使用。一般特店或賣家身分(Merchant),或平台商本身,此參數請帶放空值。
- 若隸屬於特約平台商的一般特店,此參數請帶放平台商的MerchantID。
RqHeader Object
傳入資料
Timestamp String(10)
傳入時間
請將傳輸時間轉換為時間戳(GMT+8),綠界會利用此參數將當下的時間轉為Unix TimeStamp來驗證此次介接的時間區間。
注意事項:
- 驗證時間區間為 10 分鐘內有效,若超過此驗證時間則此次API request將無法建立,參考資料:http://www.epochconverter.com/。
- 特店需進行主機「時間校正」,避免主機產生時差,造成API request失敗。
Revision String(10)
串接版號
特店傳入的傳輸編號
TransCode Int
回傳代碼
TransMsg String(200)
回傳訊息
Data String
加密資料
回傳相關資料,此為加密過JSON格式的資料。加密方法說明
綠界呼叫參數範例
{
"MerchantID": "2000132",
"RqHeader": {
"Timestamp": "1525169058"
},
"TransCode": 1,
"TransMsg": "",
"Data": "加密資料"
}
Data參數說明(Json格式)
RtnCode Int
回應代碼
1 代表 API 執行成功,其餘代碼均為失敗,失敗代碼請參考交易訊息代碼表。
RtnMsgString(200)
回應訊息
MerchantID String(10)
特店編號
MerchantTradeNo String(20)
特店訂單編號
- 特店訂單編號均為唯一值,不可重複使用。
- 英數字大小寫混合
LogisticsID String(20)
綠界訂單編號
ShipmentNo String(20)
配送編號
LogisticsType String(20)
物流類型
LogisticsSubType String(20)
物流子類型
- UNIMARTCBCVS:統一跨境店取
- UNIMARTCBHOME:統一跨境宅配
LogisticsStatus String(8)
貨態代碼
代碼請參考跨境物流貨態代碼表檔
LogisticsStatusName String(100)
貨態代碼訊息
GoodsAmount Int
商品金額
商品遺失賠償依據,僅可使用數字,上限為新台幣20,000元
UpdateStatusDate String(20)
物流狀態更新時間
ReceiverName String(100)
收件人姓名
ReceiverCellPhone String(20)
收件人手機
ReceiverCountry String(20)
收件人國家
ReceiverEmail String(50)
收件人Email
ReceiverAddress String(200)
收件地址
Data參數範例
{
"RtnCode": 1,
"RtnMsg": "",
"LogisticsType": "CB",
"LogisticsSubType": "UNIMARTCBCVS",
"MerchantID": "2000132",
"MerchantTradeNo": "1234567890",
"LogisticsID": "1234567890",
"ShipmentNo": "GMJI7110000000001",
"LogisticsStatus": "300",
"LogisticsStatusName": "訂單處理中(已收到訂單資料)",
"GoodsAmount": 1,
"UpdateStatusDate": "2020/05/09 10:36:04",
"ReceiverName": "Test receiver",
"ReceiverCellPhone": "85212345678",
"ReceiverCountry": "HK",
"ReceiverEmail": "xxx@xxx.com.tw",
"ReceiverAddress": "xxxx"
}
特店回傳參數(Json格式)
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 執行成功,其餘代碼均為失敗,失敗代碼請參考交易訊息代碼表。
RtnMsg String(200)
回應訊息 必填
OK 為成功,其餘為失敗。
Data參數範例
{
"RtnCode": 1,
"RtnMsg": "OK",
}