建立物流訂單 / 更新暫存物流訂單

應用場景

當廠商欲更新暫存物流訂單時,可透過此 API 執行更新暫存物流訂單之動作。

API介接網址

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

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)
綠界暫存物流訂單編號 必填

GoodsAmount Int
商品金額

商品金額範圍為1~20000
訂單的商品金額如果超出範圍,會更新訂單失敗

GoodsName String(50)
商品名稱

❗ 注意事項:不得輸入^ ‘ ` ! @ # % & * + \ ” < >| _ [ ]等特殊符號。

SenderName String(10)
寄件人姓名

❗ 注意事項

  1. 字元限制為4~10個字元(例:半形英文可支援4~10個字,中文可支援2~5個字)
  2. 不可帶入不符合姓名規則的文字如表情圖示(emoji符號)

❗ 注意事項:不可帶入數字和特殊符號(禁用特殊符號如下所示)

SenderZipCode String(6)
寄件人郵遞區號

SenderAddressString(60)
寄件人地址

Remark String(60)
備註

ReturnStoreID String(6)
退貨門市代號

若沒有設定ReturnStoreID,當貨品退貨時,會返回原寄件門市,若有設定則會送至指定的退貨門市。
❗ 注意事項:僅7-11 C2C適用,其他超商C2C帶此參數仍會退回原寄件門市。

ServerReplyURL String(200)
Server端回覆網址

物流狀態都會透過此URL通知。

Specification String(4)
規格

宅配專用參數
  • 0001: 60cm (預設值)
  • 0002: 90cm
  • 0003: 120cm
  • 0004: 150cm

ReceiverAddress String(60)
收件人地址

❗ 注意事項:字元限制需大於6個字元,且不可超過60個字元。

ReceiverZipCode String(6)
收件人郵遞區號

ReceiverCellPhone String(20)
收件人手機

❗ 注意事項:只允許數字、10碼且09開頭

ReceiverPhone String(20)
收件人電話

❗ 注意事項:允許數字+特殊符號;特殊符號僅限()-#

ReceiverName String(10)
收件人姓名

❗ 注意事項

  1. 字元限制為4~10個字元(例:半形英文可支援4~10個字,中文可支援2~5個字)
  2. 不可帶入不符合姓名規則的文字如表情圖示(emoji符號)

❗ 注意事項:不可帶入數字和特殊符號(禁用特殊符號如下所示)

Data參數範例

				
					{
    "TempLogisticsID": "2000132",
    "GoodsAmount": 1000,
    "GoodsName": "筆記型電腦",
    "SenderName": "張無忌",
    "SenderZipCode": "200",
}

				
			

綠界回傳參數(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)
回應訊息

回傳Data參數範例

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

				
			

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

綠界官方網站