建立物流訂單 / 建立正式物流訂單

應用場景:

當廠商欲將暫存物流訂單建立為正式物流訂單時可呼叫此API。

❗ 注意事項

(1).全家7-ELEVEN 超商B2C大宗寄件,皆需先完成「測標」作業,若測標未通過而進行寄件將會被物流中心退回,運費須由特店(賣家會員)負擔。
(2).測標作業流程,請參考廠商管理後台=>物流管理=>對帳查詢=>一段標查詢。
(3).測試環境請使用以下門市進行測試

  • 7-ELEVEN 超商:131386
  • 7-ELEVEN 超商冷凍店取:896539
  • 全家:006598
  • OK:1328

(4).訂單產生成功後,請確認ServerReplyURL是否收到成功的物流狀態,確保後續能持續收到物流狀態通知。
(5).(B2C)訂單寄貨編號請使用物流訂單查詢API取得ShipmentNo
(6).建立訂單時,依其物流子類型有商品金額限制,如自行使用金流信用卡付款超過此金額上限,風險須自行承擔。
(7).如帳戶餘額過低,將無法建立物流單,建議留存一定金額於綠界帳戶或至廠商後台預存綠界帳戶餘額供物流費扣款使用
(8).使用中華郵政宅配服務時,於建立訂單後,請先確認訂單物流狀態為「郵局已確認資料」再至郵局交寄包裹。
(9).其餘出貨相關請參考出貨注意事項

API介接網址:

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

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來驗證此次介接的時間區間。

❗ 注意事項

  • 驗證時間區間為 5 分鐘內有效,若超過此驗證時間則此次訂單將無法建立,產生時間戳請參考相關資料
  • 合作特店須進行主機「時間校正」,避免主機產生時差,延伸API無法正常運作。

Data String
加密資料 必填

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

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

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

Data參數說明(Json格式)

TempLogisticsID String(20) 綠界暫存物流訂單編號 必填

MerchantTradeNo String(20)
廠商交易編號

  • 支援中文、數字、英文大小寫
  • 廠商交易編號均為唯一值,不可重複使用

Data參數範例

				
					{
    "TempLogisticsID ": "2000123",
    "MerchantTradeNo ": "abc1234567890"
}

				
			

綠界回傳參數(Json格式)

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

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

MerchantID String(10)
特店編號 

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
加密資料 

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

綠界回傳參數範例

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

				
			

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

RtnCode Int
回應代碼

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

RtnMsg String(200)
回應訊息

LogisticsID String(20)
綠界物流訂單編號

請保存廠商交易編號與LogisticsID的關連。

回傳Data參數範例

				
					{
    "RtnCode": 1,
    "RtnMsg": "成功",
    "LogisticsID": "10035"
}

				
			

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

綠界官方網站