應用場景:
提供廠商修改物流訂單出貨日期、取貨門市資訊。
- 7-ELEVEN:更新門市
- 全家:更新門市
- OK:更新門市
- 萊爾富:更新門市
API介接網址:
- 測試環境:https://logistics-stage.ecpay.com.tw/Express/v2/UpdateStoreInfo
- 正式環境:https://logistics.ecpay.com.tw/Express/v2/UpdateStoreInfo
HTTPS 傳輸協定
- Content Type :application/json
- HTTP Method :POST
特店傳入參數(Json格式)
PlatformID String(10)
特約合作平台商代號
- PlatformID為與綠界有合作專案的特約平台商身分使用。一般特店或賣家身分(Merchant),或平台商本身,此參數請帶放空值。
- 若隸屬於特約平台商的一般特店,此參數請帶放平台商的MerchantID。
RqHeader Object
傳入資料 必填
Timestamp String(10)
傳入時間 必填
請將傳輸時間轉換為時間戳(GMT+8),綠界會利用此參數將當下的時間轉為Unix TimeStamp來驗證此次介接的時間區間。
注意事項:
- 驗證時間區間為 5 分鐘內有效,若超過此驗證時間則此次訂單將無法建立,產生時間戳請參考相關資料。
- 合作特店須進行主機「時間校正」,避免主機產生時差,延伸API無法正常運作。
Data String
加密資料 必填
回傳相關資料,此為加密過JSON格式的資料。加密方法說明
特店傳入參數範例(Json格式)
{
"MerchantID": "2000132",
"RqHeader": {
"Timestamp": "1525168923"
},
"Data": "加密資料"
}
Data參數說明(Json格式)
MerchantID String(10)
特店編號 必填
LogisticsID String(20)
綠界訂單編號 必填
CVSPaymentNo String(15)
寄貨編號 必填
CVSValidationNo String(10)
驗證碼 必填
若為OK或萊爾富,則此參數為非必填
StoreType String(2)
門市類型 必填
- 01:取件門市更新
- 02:退件門市更新
ReceiverStoreID String(6)
物流訂單取貨門市
注意事項:物流訂單取貨門市(ReceiverStoreID)、物流訂單退貨門市(ReturnStoreID)需擇一必填。
ReturnStoreID String(6)
物流訂單退貨門市
注意事項:
物流訂單取貨門市(ReceiverStoreID)、物流訂單退貨門市(ReturnStoreID)需擇一必填。
Data參數範例
{
"MerchantID": "2000132",
"LogisticsID": "1234567890",
"CVSPaymentNo":"144310142000",
"CVSValidationNo":"9926",
"StoreType":"01",
"ReceiverStoreID":"018527"
}
綠界Response參數說明(Json格式)
PlatformID String(10)
特約合作平台商代號
- PlatformID為與綠界有合作專案的特約平台商身分使用。一般特店或賣家身分(Merchant),或平台商本身,此參數請帶放空值。
- 若隸屬於特約平台商的一般特店,此參數請帶放平台商的MerchantID。
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格式的資料。加密方法說明
綠界Response參數範例
{
"MerchantID": "2000132",
"RpHeader": {
"Timestamp": "1525169058"
},
"TransCode": 1,
"TransMsg": "",
"Data": "加密資料"
}
Data參數範例
{
"RtnCode": 1,
"RtnMsg": "成功"
}