應用場景
申請B2C物流的廠商,需要測標通過後才可建立B2C物流訂單,此API可以產生測標所需要的測試訂單資訊。
API介接網址
- 測試環境:https://logistics-stage.ecpay.com.tw/Express/v2/CreateTestData
- 正式環境:https://logistics.ecpay.com.tw/Express/v2/CreateTestData
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無法正常運作。
Data String
加密資料 必填
回傳相關資料,此為加密過JSON格式的資料。加密方法說明
特店傳入參數範例(Json格式)
{
"MerchantID": "2000132",
"RqHeader": {
"Timestamp": "1525168923"
},
"Data": "加密資料"
}
Data參數說明(Json格式)
MerchantID String(10)
特店編號 必填
PlatformID String(10)
特約合作平台商代號
- PlatformID為與綠界有合作專案的特約平台商身分使用。一般特店或賣家身分(Merchant),或平台商本身,此參數請帶放空值。
- 若隸屬於特約平台商的一般特店,此參數請帶放平台商的MerchantID。
LogisticsSubType String(20)
物流子類型 必填
- FAMI:全家物流(B2C)
- UNIMART:7-ELEVEN超商物流(B2C)
- UNIMARTFREEZE:7-ELEVEN冷凍店取(B2C)
注意事項:不同物流類型都需要分別測標,通過後才可建單。
Data參數範例(Json格式)
{
"MerchantID": "2000132",
"LogisticsSubType": "FAMI"
}
綠界回傳參數(Json格式)
PlatformID String(10)
特約合作平台商代號
- PlatformID為與綠界有合作專案的特約平台商身分使用。一般特店或賣家身分(Merchant),或平台商本身,此參數請帶放空值。
- 若隸屬於特約平台商的一般特店,此參數請帶放平台商的MerchantID。
RpHeader Object
回傳資料
Timestamp String(10)
回傳時間
請將傳輸時間轉換為時間戳(GMT+8),綠界會利用此參數將當下的時間轉為Unix TimeStamp來驗證此次介接的時間區間。
注意事項:
- 驗證時間區間為 10 分鐘內有效,若超過此驗證時間則此次訂單將無法建立,產生時間戳請參考相關資料。
- 合作特店須進行主機「時間校正」,避免主機產生時差,延伸API無法正常運作。
TransCode Int
回傳代碼
1 代表 API 傳輸資料(MerchantID, RqHeader, Data)接收成功,實際的 API 執行結果狀態請參考 RtnCode。
TransMsg String(200)
回傳訊息
Data String
加密資料
綠界回傳參數範例
{
"MerchantID": "2000132",
"RpHeader": {
"Timestamp": "1525169058"
},
"TransCode": 1,
"TransMsg": "",
"Data": "加密資料"
}
回傳Data參數說明(Json格式)
RtnCode Int
回應代碼
1 代表 API 執行成功,其餘代碼均為失敗,失敗代碼請參考交易訊息代碼表。
RtnMsg String(200)
回應訊息
MerchantID String(10)
特店編號
MerchantTradeNo String(20)
特店訂單編號
- 特店訂單編號均為唯一值,不可重複使用。
- 英數字大小寫混合
LogisticsID String(20)
綠界訂單編號
LogisticsStatus String(8)
貨態代碼
LogisticsStatusName String(100)
貨態代碼訊息
LogisticsType String(20)
物流類型
LogisticsSubType String(20)
物流子類型
- FAMI:全家物流(B2C)
- UNIMART:7-ELEVEN超商物流(B2C)
- UNIMARTFREEZE:7-ELEVEN冷凍店取(B2C)
GoodsAmount Int
商品金額
GoodsWeight Number
商品重量
UpdateStatusDate String(20)
物流狀態更新時間
ReceiverName String(100)
收件人姓名
ReceiverPhone String(20)
收件人電話
ReceiverCellPhone String(20)
收件人手機
ReceiverEmail String(50)
收件人Email
ReceiverAddress String(200)
收件地址
BookingNote String(50)
托運單號
CVSPaymentNo String(15)
寄貨編號
CVSValidationNo String(10)
驗證碼
回傳Data參數範例
{
"RtnCode": 1,
"RtnMsg": "成功",
"MerchantID": "2000132",
"MerchantTradeNo": "1234567890",
"LogisticsID": "1234567890",
"LogisitcsStatus": "300",
"LogisticsStatusName": “訂單處理中(已收到訂單資料)",
"LogisticsType": "CVS",
"LogisticsSubType": "FAMI",
"GoodsAmount": 1,
"UpdateStatusDate": "2020/05/09 10:36:04",
"ReceiverName": "Test receiver",
"ReceiverCellPhone": "0911xxxxxx",
"ReceiverEmail": "ReceiverTestMail@testmail.com.tw",
"ReceiverAddress": "Test receiver address",
"BookingNote": "",
"CVSPaymentNo": "",
"CVSValidationNo": ""
}
注意事項:
(1) 請務必使用雷射印表機列印標籤,並用”信封袋”寄送至各物流中心進行標籤刷讀,如不符合標準,日後出貨商品不予驗收,以退貨處理。以下地址僅供測標寄送
- 全家標籤寄送地址:335 桃園市大溪區新光東路76巷22-2號。日翊文化電子商務部- EC測標收。
- 7-ELEVEN 標籤寄送地址:238新北市樹林區佳園路二段70-1號。大智通文化行銷-EC驗收組收。
- 7-ELEVEN B2C冷凍店取標籤寄送地址:744 台南市新市區大營里7號。統昶物流中心–EC冷凍店取測標收。
(2) 7-ELEVEN 訂單測標資料後,請於D+5日 14:00 前列印,超過便無法列印
(3) 全家訂單建立後,請於6日內列印,超過便無法列印
(4) 測標結果查詢:
- 全家:測標結果請務必點擊「廠商管理後台」> 物流管理 > 對帳查詢 >【一段標查詢】,查詢按鈕後,若測標成功,方可正常建立訂單。
- 7-ELEVEN:測標結果由綠界科技客服通知,可在廠商管理後台 >廠商專區 >廠商基本資料 >物流資訊 >測標結果查詢,若測標成功,方可正常建立訂單 。