商城后臺(tái)接口說明文檔(App)V1.2

1、徐家匯商城后臺(tái)接口說明文檔V.1.02015/1/2版本歷史版本作者參與后日期描述1.0宋建華2015-3-30新增接口目錄接口描述:6二、注冊(cè)登錄相關(guān)接口7(1) 手機(jī)快速用戶注冊(cè)接口(register)7(2) 登錄接口(login)8(3) 第三方賬號(hào)登錄接口(thirdPartyLogin)8(4) 會(huì)員修改密碼接口(updatePwd)9(5) 推出登錄接口(logout)93、 商品接口10(1) 查詢商家接口(queryMerchant)10(2) 查詢商家下柜臺(tái)列表接口(queryMerchantCounterList)11(3) 查詢商品接口(queryProduct)11(

2、4) 查詢商品規(guī)格參數(shù)列表接口(queryProductSpecificationList)12(5) 查詢品牌介紹接口(queryBrandPresent)13(6) 查詢商品介紹接口(queryProductPresent)14(7) 查詢商品詳情接口(queryProductDetail)15(8) 查詢品牌分類列表接口(queryBrandSortList)16(9) 查詢品牌分類下屬品牌列表接口(queryBrandByMerchantList)17(10) 查詢品牌分類品牌歸屬商家列表接口(queryMallByMerchantList)18(11) 查詢品牌商家柜臺(tái)詳情接口(qu

3、eryMerchantDetail)18(12) 查詢柜臺(tái)下商品列表接口(queryCounterProductList)19(13) 二維碼識(shí)別接口接口(dimensionsCodeItendify)20(14) 查詢banner圖片列表接口(queryBannerImageList)21(15) 查tbbanner活動(dòng)商品列表接口(queryBannerActivityProductList)22(16) 查詢來此購活動(dòng)列表接口(letsGoActivity)22(17) 查詢來此購活動(dòng)詳情接口(letsGoActivityDetail)23(18) 查詢秒殺活動(dòng)列表接口(spikeAct

4、ivity)24(19) 查詢秒殺活動(dòng)詳情接口(spikeActivityDetail).254、 訂單接口26(1) 查詢可用優(yōu)惠券接口(queryUsableCoupon)26(2) 查詢購物車接口(queryMemberCart)27(3) 添加/刪除購物車接口(operateMemberCart)29(4) 編輯購物車接口(updateMemberCart)30(5) 購物車商品規(guī)格參數(shù)修改接口(updateMemberCartFormart)30(6) 一鍵領(lǐng)取優(yōu)惠券接口(receiveSpecials)31(7) 購物車預(yù)結(jié)算接口(cartPresettlement)32(8) 訂

5、單預(yù)覽接口(orderProview)34(9) 查詢訂單可適用優(yōu)惠券列表接口(queryOrderSpecialsList)36(10) 提交訂單接口(sumbitOrder)37(11) 創(chuàng)建繳費(fèi)充值接口(createPayRechargeOrder)39(12) 創(chuàng)建輕松購訂單接口(createEasyBuyOrder)39(13) 創(chuàng)建訂單接口(createOrder)40(14) 獲取可用支彳渠道接口(getPaymentChannel)41(15) 訂單支付接口(paymentOrder)41(16) 訂單詳T#接口(detailOrder)42(17) 訂單取7肖接口(cancl

6、eOrder)43(18) 訂單刪除接口(deleteOrder)445、 會(huì)員信息接口45(1) 查詢會(huì)員彳&息接口(queryMemberInfo)45(2) 修改會(huì)員彳&息接口(updateMemberInfo)46(3) 查詢會(huì)員可用積分接口(queryMemberUsablePoints)46(4) 查詢會(huì)員積分接口(queryMemberPoints)47(5) 查詢會(huì)員訂單接口(queryMemberOrder)48(6) 售后處理退貨詳情接口(returnsDetailOrder)49(7) 售后處理退貨tT單查詢接口(queryRefundOrder)50(8

7、) 售后處理退還貨物接口(refundsGoods)51(9) 查詢會(huì)員U攵藏接口(queryMemberIncome)52(10) 會(huì)員添加/取消收藏接口(memberOperateIncome)53(11) 會(huì)員批量添加收藏接口(memberAddBulkIncome)54(12) 查詢會(huì)員優(yōu)惠券接口(queryMemberCoupon)54(13) 會(huì)員投訴發(fā)送信息接口(sendComplaintMessage)55(14) 會(huì)員投訴獲取信息接口(getComplaintMessage)56(15) 查詢會(huì)員收貨地址接口(queryMemberConsignee)56(16) 增加/修改

8、會(huì)員收貨地址接口(updateConsignee)57(17) 刪除會(huì)員收貨地址接口(deleteConsignee)58(18) 查詢我的虛才票券接口(queryMyVirtualTicket)58(19) 查詢我的預(yù)名列表接口(queryMyReserveList)59(20) 查詢我的輕松購接口(queryMyEasyPurchase)60(21) 查詢我的輕松購(柜臺(tái)詳情)接口(queryMyEasyPurchaseMerchantDetail).61(22)查詢消息列表接口(queryMessageList)62(23) 查詢消息詳情接口(queryMessageDetail)63(

9、24) 發(fā)送反饋問題接口(sendFeedbackProblems)64(25) 獲取反饋問題回復(fù)接口(getFeedbackProblems)65(26) 查詢我的e卡通接口(queryMyEcartoon)65(27) 修改e卡通密碼接口(updateEcartoonPwd)66(28) e卡通交易明細(xì)查詢接口(eCartoonTcansactionDetail)67(29) e卡通轉(zhuǎn)賬接口(eCartoonTransfers)67(30) e卡通常用卡綁定接口(commonCartBinding)686、 e卡通接口68(1) 繳費(fèi)充值水電燃?xì)饨涌?hydroGas)69(2) 繳費(fèi)充值

10、寬帶/固話(paymentKg)70(3) 繳費(fèi)充值手機(jī)賬單接口/有線電視接口(phoneBill)717、 預(yù)約柜臺(tái)接口72(1) 查詢預(yù)約柜臺(tái)列表接口(queryReserveCounterList)72(2) 查詢預(yù)約柜臺(tái)詳情接口(queryReserveCounterDetail)72(3) 查詢預(yù)約柜臺(tái)座位接口(queryReserveCounterSeat)738、 商場(chǎng)導(dǎo)航接口(二期)74(1) 獲取當(dāng)前位置接口(getCurrentPosition)(二期)74(2) 商家導(dǎo)航接口(merchantNavigation)(二期)二4.79、 分享接口75(1) 查詢分享渠道接口

11、(queryReserveMerchantList)75(2) 查詢預(yù)約商家詳情接口(queryReserveMerchantDetail)76(3) 查詢預(yù)約商家座位接口(queryReserveMerchantSeat)76十、版本升級(jí)接口77(1) 查詢新版本接口(queryVersion)77(2) 下載新版本接口(downloadNewVersion)78H一、附錄91一、接口描述：1. 接口連接：2. 參數(shù)傳遞方式：POST方式3. 簽名規(guī)則：sign字段采用MD5加密方式，sign的值是本次請(qǐng)求所有入?yún)⒌膋ey=value的疊加通過&連接4. 返回格式j(luò)son5. 編碼格

12、式utf86. 所有入?yún)⑴c返回參數(shù)均首字母為小寫，金額精確到分，時(shí)間14位，如201502131119007. 響應(yīng)請(qǐng)求狀態(tài)碼約定，成功響應(yīng)為:2008. 對(duì)于非法請(qǐng)求如：”增加需帶tokent的非法請(qǐng)求(未包含token或者token失效)”則響應(yīng)為:4039. 終端編碼規(guī)則：設(shè)備號(hào)|系統(tǒng)類型臊作系統(tǒng)版本號(hào)|安裝時(shí)間戳例如：設(shè)備號(hào)：android獲取ios生成uuid系統(tǒng)類型1android2ios操作系統(tǒng)版本號(hào)安裝時(shí)間戳2015010611200810. 接口描述接口鏈接:http:10002/xjhapp-openapi/appapi/參數(shù)傳遞方式：post入?yún)⒘斜?body="

13、;params":"version":"1","pageNumber":"1","pageSize":"2"返回格式：json"resData":"result":"1","errorCode":"","errorMsg":""result為0成功1失敗注冊(cè)登錄類接口(1)手機(jī)快速注冊(cè)接口(register)提交Url:入?yún)o

14、dy="params":"version":"","loginName":"","loginPwd":"","checkCode":"","terminalCode":""傳入變量變量名變量名稱類型描述是否為空version版本號(hào)String(8)版本號(hào)NloginName用戶名String(20)手機(jī)號(hào)碼NloginPwd登錄密碼String(100)登陸密碼NcheckCo

15、de驗(yàn)證碼String(8)驗(yàn)證碼時(shí)間60秒NterminalCode設(shè)備號(hào)String(50)終端編碼N返回參數(shù)參數(shù)名變量名稱類型描述是否為空result返回碼String(1)0失敗,1成功NuserId會(huì)員編號(hào)String(20)會(huì)員編號(hào)Ntoken會(huì)話tokenString(50)會(huì)話標(biāo)識(shí)NerrorCode錯(cuò)誤代碼String(4)錯(cuò)誤代碼1001短信驗(yàn)證碼錯(cuò)誤1002用戶名已存在YerrorMsg錯(cuò)誤信息String(200)錯(cuò)誤描述信息Y注：注冊(cè)后自動(dòng)登錄(2)登陸接口(login)提交Url:入?yún)ody="params":"version&quo

16、t;:"","loginName":"","loginPwd":"","terminalCode":""傳入變量變量名變量名稱類型描述是否為空version版本號(hào)String(8)版本號(hào)NloginName登錄名String(20)登錄名NloginPwd登錄密碼String(100)登陸密碼NterminalCode設(shè)備號(hào)String(50)終端編碼N返回參數(shù)參數(shù)名變量名稱類型描述是否為空result返回碼String(1)返回值（暫定0失敗,1成功）N

17、token會(huì)話tokenString(50)會(huì)話標(biāo)識(shí)NuserId會(huì)員編號(hào)String(20)會(huì)員編號(hào)NerrorCode錯(cuò)誤代碼String(3)錯(cuò)誤代碼YerrorMsg錯(cuò)誤信息String(200)錯(cuò)誤描述信息Y(3)第三方賬號(hào)登陸接口(thirdPartyLogin)提交Url:入?yún)ody="params":"version":"","thirdPartyType":"","thirdPartySign":"","thirdPartyN

18、ick":"","imageUrl":"","thirdPartyToken":"","terminalCode":""傳入變量變量名變量名稱類型描述是否為空version版本號(hào)String(8)版本號(hào)NthirdPartyType第三方類型String(1)0QQ;1微彳2微博；3支付寶NthirdPartySign第三方標(biāo)識(shí)String(50)唯一標(biāo)識(shí)NthirdPartyNick第三方昵稱String(50)第三方昵稱YimageUrl圖片

19、url地址String(255)圖片url地址YthirdPartyToken第三方tokenString(50)預(yù)留字段（備用）YterminalCode設(shè)備號(hào)String(50)終端編碼N（備注：第三方登錄，新建用戶賬戶/密碼暫定,直接登錄）返回參數(shù)參數(shù)名變量名稱類型描述是否為空result返回碼String(1)返回值（0失敗,1成功）NerrorCode錯(cuò)誤代碼String(3)錯(cuò)誤代碼YerrorMsg錯(cuò)誤信息String(200)錯(cuò)誤描述信息Ytoken會(huì)話tokenString(50)會(huì)話標(biāo)識(shí)Nuserid會(huì)員編號(hào)String(20)會(huì)員編號(hào)Nstatus狀態(tài)String(1)第

20、一次登陸返回1,否則為0N(4)會(huì)員修改密碼(updatePwd)提交Url:入?yún)ody="params":"version":"","userId":"","token":"","loginPwd":"","newPwd":""傳入變量變量名變量名稱類型描述是否為空version版本號(hào)String(8)版本號(hào)Nuserid會(huì)員編號(hào)String(20)會(huì)員編號(hào)Ntoken會(huì)t

21、BtokenString(50)會(huì)話標(biāo)識(shí)NloginPwd原密碼String(100)原登錄密碼NnewPwd新密碼String(100)新密碼N返回參數(shù)參數(shù)名變量名稱類型描述是否為空result返回碼String(1)返回值（0失敗,1成功）NerrorCode錯(cuò)誤代碼String(3)錯(cuò)誤代碼YerrorMsg錯(cuò)誤信息String(200)錯(cuò)誤描述信息Ytoken會(huì)話tokenString(50)會(huì)話標(biāo)識(shí)如果修改密碼直接登錄需要返回token；反之則不返回tokenN(5)退由登陸(logout)提交Url:入?yún)ody="params":"version&q

22、uot;:"","userId":"","token":""傳入變量變量名變量名稱類型描述是否為空version版本號(hào)String(8)版本號(hào)Nuserid會(huì)員編號(hào)String(20)會(huì)員編號(hào)Ntoken會(huì)tBtokenString(50)會(huì)話標(biāo)識(shí)N返回參數(shù)參數(shù)名變量名稱類型描述是否為空result返回碼String(1)返回值（0失敗,1成功）NerrorCode錯(cuò)誤代碼String(3)錯(cuò)誤代碼YerrorMsg錯(cuò)誤信息String(200)錯(cuò)誤描述信息Y商品接口(1) 查詢商家接口(get

23、Merchant)提交Url:入?yún)ody="params":"version":"","positionInfo":"","searchType":"","terminalCode":""傳入變量變量名變量名稱類型描述是否為空version版本號(hào)String(8)版本號(hào)Npositioninfo位置信息String(50)經(jīng)緯度YsearchType搜索類型String(2)商家類型1定位2推薦YterminalC

24、ode設(shè)備號(hào)String(50)終端編碼N返回參數(shù)參數(shù)名參數(shù)名稱類型描述是否為空result返回碼String(1)返回值（0失敗,1成功）NerrorCode錯(cuò)誤代碼String(3)錯(cuò)誤代碼YerrorMsg錯(cuò)誤信息String(200)錯(cuò)誤信息描述YmerchantListmerchantCode商家代碼String(20)商家代碼NmerchantName商家名稱String(200)商家名稱NisDefaults是否默認(rèn)值String(1)是否優(yōu)先，是否默認(rèn)，是否置頂Y備注：小商家不顯示在首頁(2) 查詢商家下柜臺(tái)列表接口(getMerchantCounterList)提交Url:入

25、參body="params":"version":"","merchantCode":"","pageSize":"","pageNumber":"","terminalCode":""傳入變量變量名變量名稱類型描述是否為空version版本號(hào)String(8)版本號(hào)NmerchantCode商家代碼String(20)商家代碼NpageSize一頁條數(shù)String(2)一頁條

26、數(shù)YpageNumber頁碼String(2)頁碼YterminalCode設(shè)備號(hào)String(50)終端編碼N返回參數(shù)參數(shù)名參數(shù)名稱類型描述是否為空result返回碼String(1)返回值（0失敗,1成功）NerrorCode錯(cuò)誤代碼String(3)錯(cuò)誤代碼YerrorMsg錯(cuò)誤信息String(200)錯(cuò)誤信息描述YpageSize一頁條數(shù)String(2)一頁條數(shù)YpageNo頁碼String(2)頁碼YtotalPage總頁數(shù)String(20)總頁數(shù)YtotalCount總條數(shù)String(20)總條數(shù)YcounterList（首頁最佳柜臺(tái)，最少顯示一個(gè)，最多顯示10個(gè)）merc

27、hantCode商家代碼String(20)商家代碼NcounterCode柜臺(tái)代碼String(20)柜臺(tái)代碼NcounterName柜臺(tái)名稱String(50)柜臺(tái)名稱NcounterAddress柜臺(tái)地址String(200)柜臺(tái)地址NcounterImage柜臺(tái)圖片String(255)柜臺(tái)圖片NcounterTel柜臺(tái)電話String(20)柜臺(tái)電話N(3)查詢商品接口(getProduct)提交Url:入?yún)ody="params":"version":"","merchantCode":"&

28、quot;,"keywordsType":"","keywords":"","filters":"","pageSize":"","pageNumber":"","terminalCode":""傳入變量變量名變量名稱類型描述是否為空version版本號(hào)String(8)版本號(hào)NmerchantCode商家代碼String(20)商家代碼NkeywordsT

29、ype關(guān)鍵字類型String(1)0根據(jù)柜臺(tái)搜索，keywords按柜臺(tái)號(hào)搜索；1根據(jù)商品搜索keywords按商品名搜索。Nkeywords關(guān)鍵字String(50)關(guān)鍵字Yfilters過濾條件String(8)按柜臺(tái)，時(shí)間搜索缺詳細(xì)對(duì)象描述YpageSize一頁條數(shù)String(2)一頁條數(shù)YpageNumber頁碼String(2)頁碼YterminalCode設(shè)備號(hào)String(50)終端編碼N返回參數(shù)參數(shù)名參數(shù)名稱類型描述是否為空result返回碼String(1)返回值（0失敗,1成功）NerrorCode錯(cuò)誤代碼String(3)錯(cuò)誤代碼YerrorMsg錯(cuò)誤信息String(

30、200)錯(cuò)誤信息描述YpageSize一頁條數(shù)String(2)一頁條數(shù)YpageNo頁碼String(2)頁碼YtotalPage總頁數(shù)String(20)總頁數(shù)YtotalCount總條數(shù)String(20)總條數(shù)YproductListmerchantCode商家代碼String(20)商家代碼NproductCode商品代碼String(20)商品代碼NproductName商品名稱String(50)商品名稱Nproductimage商品圖片String(255)商品圖片NlistPrice徐家匯價(jià)String(19)徐家匯價(jià)NsalePrice活動(dòng)價(jià)String(19)活動(dòng)價(jià)N(4

31、)查詢商品規(guī)格參數(shù)列表接口(getProductSpecificationsList)提交Url:入?yún)ody="params":"version":"","merchantCode":"","productCode":"","terminalCode":""傳入變量變量名變量名稱類型描述是否為空version版本號(hào)String(8)版本號(hào)NmerchantCode商家代碼String(20)商家代碼NproductCode商品代碼String(20)商品代碼（SKU）NterminalCode設(shè)備號(hào)String(50)終端編碼N返回參數(shù)參數(shù)名參數(shù)名稱類型描述是否為空result返回碼String(1)返回值（0失敗,1成功）NerrorCode錯(cuò)誤代碼String(3)錯(cuò)誤代碼YerrorMsg錯(cuò)誤信息String(200)錯(cuò)誤信息描述YspecificationsListparamCode參數(shù)代碼String(20)參數(shù)代碼NparamName參數(shù)名稱String(50)參數(shù)名