應用場景
提供平台或特店可直接取得所有合作超商的門市清單。
取得門市清單後,開店平台可以在購物頁面設置下拉式選單或篩選選項,讓消費者根據縣市或區域找到合適的取貨門市。可節省跳轉至超商電子地圖頁步驟,使選擇門市流程更為流暢,提升消費者使用體驗。
注意事項:
綠界每日配合各超商的更新時間進行門市資料的更新,具體時間為:每日更新一次,於20:00進行更新。
API介接網址
- 測試環境:https://logistics-stage.ecpay.com.tw/Helper/GetStoreList
- 正式環境:https://logistics.ecpay.com.tw/Helper/GetStoreList
HTTPS傳輸協定
- Accept:text/html
- Content Type:application/x-www-form-urlencoded
- HTTP Method:POST
特店Request參數說明
PlatformID String(10)
特約合作平台商代號
- 由綠界科技提供,此參數為專案合作的平台商使用,一般廠商介接請放空值。
- 若為專案合作的平台商使用時,請帶賣家所綁定的MerchantID。
MerchantID String(10)
廠商編號 必填
由綠界科技提供
CvsType String(20)
超商類別 必填
- All
- FAMI: 全家
- UNIMART: 7-ELEVEN超商(常溫)
- HILIFE: 萊爾富
- OKMART: OK超商
- UNIMARTFREEZE: 7-ELEVEN超商(冷鏈)
CheckMacValue String
檢查碼 必填
請參考附錄檢查碼機制
綠界Response參數說明
RtnCode Int
回應代碼
1 代表 API 執行成功,其餘代碼均為失敗,失敗代碼請參考交易訊息代碼表。
RtnMsg String(200)
回應訊息
StoreList Array[Object]
商店清單
CvsType String(20)
超商類別
StoreInfo Array[Object]
門市資訊
回傳StoreInfo參數說明(Json格式)
StoreId String(10)
門市代碼
StoreName String(40)
門市名稱
StoreAddr String(100)
門市地址
StorePhone String(20)
門市電話
回應訊息範例:
{
"RtnCode": 1,
"RtnMsg": "成功",
"StoreList": [
{
"CvsType": "FAMI",
"StoreInfo": [
{
"StoreId": "01XXXX",
"StoreName": "新營國XX店",
"StoreAddr": "臺南市後壁區竹新里XX號",
"StorePhone": "066XXXXX"
}
]
},
{
"CvsType": "UNIMART",
"StoreInfo": [
{
"StoreId": "02XXXX",
"StoreName": "台南XX店",
"StoreAddr": "臺南市永康區竹新里XX號",
"StorePhone": "066XXXXX"
}
]
}
]
}