商城后台接口说明文档(App)V1.2

徐家汇商城后台接口说明文档

V.1.0

2015/1/2

版 本 历 史

版本 1.0 作者 宋建华 参与者 日期 2015-3-30 描述 新增接口

目录

一、 接口描述: ...................................................................................................................... 6

二、 注册登录相关接口 ....................................................................................................... 7 （1） 手机快速用户注册接口(register) ........................................................................ 7 （2） 登录接口(login) ...................................................................................................... 8 （3） 第三方账号登录接口(thirdPartyLogin) ............................................................. 8 （4） 会员修改密码接口(updatePwd) ............................................................................ 9 （5） 推出登录接口(logout) .......................................................................................... 9 三、 商品接口 ..................................................................................................................... 10 （1） 查询商家接口(queryMerchant) .......................................................................... 10 （2） 查询商家下柜台列表接口(queryMerchantCounterList) ................................. 11 （3） 查询商品接口(queryProduct)............................................................................. 11 （4） 查询商品规格参数列表接口(queryProductSpecificationList) ........................ 12 （5） 查询品牌介绍接口(queryBrandPresent) .......................................................... 13 （6） 查询商品介绍接口(queryProductPresent) ....................................................... 14 （7） 查询商品详情接口(queryProductDetail) .......................................................... 15 （8） 查询品牌分类列表接口(queryBrandSortList) .................................................. 16 （9） 查询品牌分类下属品牌列表接口(queryBrandByMerchantList) .................... 17 （10） 查询品牌分类品牌归属商家列表接口(queryMallByMerchantList) ................ 18 （11） 查询品牌商家柜台详情接口(queryMerchantDetail) ........................................ 18 （12） 查询柜台下商品列表接口(queryCounterProductList) .................................... 19 （13） 二维码识别接口接口(dimensionsCodeItendify) .............................................. 20 （14） 查询banner图片列表接口(queryBannerImageList) ....................................... 21 （15） 查询banner活动商品列表接口(queryBannerActivityProductList) ............... 22 （16） 查询来此购活动列表接口(letsGoActivity) ........................................................ 22 （17） 查询来此购活动详情接口(letsGoActivityDetail) .............................................. 23 （18） 查询秒杀活动列表接口(spikeActivity) .............................................................. 24 （19） 查询秒杀活动详情接口(spikeActivityDetail)......…………………………………………….25 四、 订单接口 ..................................................................................................................... 26 （1） 查询可用优惠券接口(queryUsableCoupon) .................................................... 26 （2） 查询购物车接口(queryMemberCart) .............................................................. 27 （3） 添加/删除购物车接口(operateMemberCart) ................................................... 29

（4） 编辑购物车接口(updateMemberCart) .............................................................. 30 （5） 购物车商品规格参数修改接口(updateMemberCartFormart) ........................ 30 （6） 一键领取优惠券接口(receiveSpecials) ............................................................ 31 （7） 购物车预结算接口(cartPresettlement) ............................................................. 32 （8） 订单预览接口(orderProview) ............................................................................. 34 （9） 查询订单可适用优惠券列表接口(queryOrderSpecialsList) ........................... 36 （10） 提交订单接口(sumbitOrder) .............................................................................. 37 （11） 创建缴费充值接口(createPayRechargeOrder) ............................................... 39 （12） 创建轻松购订单接口(createEasyBuyOrder) ................................................... 39 （13） 创建订单接口(createOrder) ............................................................................... 40 （14） 获取可用支付渠道接口(getPaymentChannel) ................................................ 41 （15） 订单支付接口(paymentOrder) ........................................................................... 41 （16） 订单详情接口(detailOrder)................................................................................. 42 （17） 订单取消接口(cancleOrder)............................................................................... 43 （18） 订单删除接口(deleteOrder) ............................................................................... 44 五、 会员信息接口 ............................................................................................................. 45 （1） 查询会员信息接口(queryMemberInfo) ............................................................. 45 （2） 修改会员信息接口(updateMemberInfo) ........................................................... 46 （3） 查询会员可用积分接口(queryMemberUsablePoints) .................................... 46 （4） 查询会员积分接口(queryMemberPoints) ......................................................... 47 （5） 查询会员订单接口(queryMemberOrder) ......................................................... 48 （6） 售后处理－退货详情接口(returnsDetailOrder)................................................ 49 （7） 售后处理－退货订单查询接口(queryRefundOrder) ....................................... 50 （8） 售后处理－退还货物接口(refundsGoods) ....................................................... 51 （9） 查询会员收藏接口(queryMemberIncome) ....................................................... 52 （10） 会员添加／取消收藏接口(memberOperateIncome) ...................................... 53 （11） 会员批量添加收藏接口(memberAddBulkIncome) .......................................... 54 （12） 查询会员优惠券接口(queryMemberCoupon) .................................................. 54 （13） 会员投诉发送信息接口(sendComplaintMessage) .......................................... 55 （14） 会员投诉获取信息接口(getComplaintMessage) ............................................. 56

（15） 查询会员收货地址接口(queryMemberConsignee) ............................................ 56 （16） 增加/修改会员收货地址接口(updateConsignee)............................................ 57 （17） 删除会员收货地址接口(deleteConsignee) ...................................................... 58 （18） 查询我的虚拟票券接口(queryMyVirtualTicket) ............................................... 58 （19） 查询我的预约列表接口(queryMyReserveList) ................................................ 59 （20） 查询我的轻松购接口(queryMyEasyPurchase) ............................................... 60 （21） 查询我的轻松购(柜台详情)接口(queryMyEasyPurchaseMerchantDetail) .. 61 （22） 查询消息列表接口(queryMessageList) ............................................................ 62 （23） 查询消息详情接口(queryMessageDetail) ........................................................ 63 （24） 发送反馈问题接口(sendFeedbackProblems) ................................................. 64 （25） 获取反馈问题回复接口(getFeedbackProblems) ............................................ 65 （26） 查询我的e卡通接口(queryMyEcartoon) ......................................................... 65 （27） 修改e卡通密码接口(updateEcartoonPwd) .................................................... 66 （28） e卡通交易明细查询接口(eCartoonTcansactionDetail) ................................. 67 （29） e卡通转账接口(eCartoonTransfers) ................................................................ 67 （30） e卡通常用卡绑定接口(commonCartBinding) ................................................. 68 六、 e卡通接口 .................................................................................................................. 68 （1） 缴费充值－水电燃气接口(hydroGas) ............................................................... 69 （2） 缴费充值－宽带/固话(paymentKg) ................................................................... 70 （3） 缴费充值－手机账单接口/有线电视接口(phoneBill) ...................................... 71 七、 预约柜台接口 ............................................................................................................. 72 （1） 查询预约柜台列表接口(queryReserveCounterList) ....................................... 72 （2） 查询预约柜台详情接口(queryReserveCounterDetail) ................................... 72 （3） 查询预约柜台座位接口(queryReserveCounterSeat) ..................................... 73 八、 商场导航接口（二期） ............................................................................................. 74 （1） 获取当前位置接口(getCurrentPosition)（二期） ........................................... 74 （2） 商家导航接口(merchantNavigation)（二期）……..………………………………………....74 九、 分享接口 ..................................................................................................................... 75 （1） 查询分享渠道接口(queryReserveMerchantList) ............................................. 75 （2） 查询预约商家详情接口(queryReserveMerchantDetail) ................................. 76

（3） 查询预约商家座位接口(queryReserveMerchantSeat) ................................... 76 十、 版本升级接口 ............................................................................................................. 77 （1） 查询新版本接口(queryVersion) ......................................................................... 77 （2） 下载新版本接口(downloadNewVersion) .......................................................... 78 十一、 附录 ............................................................................................................................. 91

一、 接口描述:

1. 2.

3.

4. 5. 6. 7. 8. 9.

接口连接：https://www.xjh.com/api/接口名称 参数传递方式：POST方式

签名规则:sign字段采用MD5加密方式,sign的值是本次请求所有入参的key=value的叠加通过&连接 返回格式 json 编码格式 utf8

所有入参与返回参数均首字母为小写，金额精确到分，时间14位，如20150213111900 响应请求状态码约定,成功响应为:200

对于非法请求如:”增加需带tokent的非法请求(未包含token或者token失效)”则响应为:403

终端编码规则：

设备号|系统类型|操作系统版本号|安装时间戳 例如：设备号：android获取 ios 生成uuid 系统类型 1 android 2 ios 操作系统版本号

安装时间戳 20150106112008

10. 接口描述

接口链接: http://admore.cn:10002/xjh_app-openapi/appapi/

参数传递方式: post

入参列表: body={\返回格式: json

{\result 为0成功 1失败

二、 注册登录类接口

（1）手机快速注册接口(register)

提交Url:https://www.xjh.com/api/register 入参

body={\alCode\

传入变量

变量名 version loginName loginPwd checkCode terminalCode

返回参数

参数名 result userId token 变量名称 返回码 会员编号 会话token 错误代码 errorCode String(4) 类型 String(1) String(20) String(50) 描述 0失败,1成功 会员编号 会话标识 错误代码 1001 短信验证码错误 1002 用户名已存在 errorMsg 错误信息 String(200) 错误描述信息 Y 是否为空 N N N Y 变量名称 版本号 用户名 登录密码 验证码 类型 String(8) String(20) String(100) String(8) String(50) 描述 版本号 手机号码 登陆密码 验证码 时间60秒 终端编码 N 是否为空 N N N N 设备号 注：注册后自动登录

（2）登陆接口(login)

提交Url:https://www.xjh.com/api/login 入参

body={\

传入变量

变量名 version loginName loginPwd terminalCode

返回参数

参数名 result token userId errorCode errorMsg 变量名称 返回码 会话token 会员编号 错误代码 错误信息 类型 String(1) String(50) String(20) String(3) String(200) 描述 返回值(暂定0失败,1成功) 会话标识 会员编号 错误代码 错误描述信息 是否为空 N N N Y Y 变量名称 版本号 登录名 登录密码 设备号 类型 String(8) String(20) String(100) String(50) 描述 版本号 登录名 登陆密码 终端编码 是否为空 N N N N

（3）第三方账号登陆接口(thirdPartyLogin)

提交Url:https://www.xjh.com/api/thirdPartyLogin 入参

body={\k\

传入变量

变量名 version thirdPartyType thirdPartySign thirdPartyNick imageUrl thirdPartyToken terminalCode 变量名称 版本号 第三方类型 第三方标识 第三方昵称 图片url地址 第三方token 设备号 类型 String(8) String(1) String(50) String(50) String(255) String(50) String(50) 描述 版本号 0 QQ；1 微信；2 微博；3支付宝 唯一标识 第三方昵称 图片url地址 预留字段(备用) 终端编码 是否为空 N N N Y Y Y N （备注：第三方登录，新建用户账户／密码［暂定］，直接登录） 返回参数

参数名 result errorCode errorMsg token userId status 变量名称 返回码 错误代码 错误信息 会话token 会员编号 状态 类型 String(1) String(3) String(200) String(50) String(20) String(1) 描述 返回值(0失败,1成功) 错误代码 错误描述信息 会话标识 会员编号 第一次登陆返回1，否则为0 是否为空 N Y Y N N N

（4）会员修改密码(updatePwd)

提交Url:https://www.xjh.com/api/updatePwd 入参

body={\

传入变量

变量名 version userId token loginPwd newPwd

返回参数

参数名 result errorCode errorMsg 变量名称 返回码 错误代码 错误信息 类型 String(1) String(3) String(200) 描述 返回值(0失败,1成功) 错误代码 错误描述信息 会话标识 如果修改密码直接token 会话token String(50) 登录需要返回token；反之则不返回token N 是否为空 N Y Y 变量名称 版本号 会员编号 会话token 原密码 新密码 类型 String(8) String(20) String(50) String(100) String(100) 描述 版本号 会员编号 会话标识 原登录密码 新密码 是否为空 N N N N N （5）退出登陆(logout)

提交Url:https://www.xjh.com/api/logout 入参

body={\

传入变量

变量名 version userId token

返回参数

参数名 result errorCode errorMsg 变量名称 返回码 错误代码 错误信息 类型 String(1) String(3) String(200) 描述 返回值(0失败,1成功) 错误代码 错误描述信息 是否为空 N Y Y 变量名称 版本号 会员编号 会话token 类型 String(8) String(20) String(50) 描述 版本号 会员编号 会话标识 是否为空 N N N 三、 商品接口

（1） 查询商家接口(getMerchant)

提交Url:https://www. xjh.com/api/ getMerchant 入参

body={\

传入变量

变量名 version positionInfo 变量名称 版本号 位置信息 搜索类型 searchType 设备号 String(2) 类型 String(8) String(50) 描述 版本号 经纬度 商家类型 1 定位 2 推荐 terminalCode String(50) 终端编码 N 是否为空 N Y Y

返回参数

参数名 result errorCode errorMsg 参数名称 返回码 类型 String(1) String(3) String(200) 描述 返回值(0失败,1成功) 错误代码 错误信息描述 Y Y 是否为空 N 错误代码 错误信息 merchantList

valueCode 值 String(20) 例，值 白色 Y 返回参数

参数名 result errorCode errorMsg merchantCode productCode productName productDes listPrice salePrice cartNumber isIncone counterCode counterName counterAddress counterTel openStartDate openEndDate counterImage belongsBrandCode useStock promotionsList promotionsCode promotionsType promotionsDes 促销类型代码 促销类型 促销内容 String(20) String(1) String(200) 促销类型代码 促销类型 0 活动；1 优惠券 促销内容 是否已领取（促销类型为优惠券展isReceived 是否已领取 String(1) 示） 0 未领取 1 已领取 N Y N N 参数名称 返回码 类型 String(1) String(3) String(200) String(20) String(20) String(50) String(200) String(19) String(19) String(19) String(1) String(20) String(50) String(200) String(19) String(19) String(19) String(255) String(20) String(19) 描述 返回值(0失败,1成功) 错误代码 错误信息描述 商家代码 商品代码 商品名称 商品描述 徐家汇价 活动价 大于0件显示在购物车图标上 0 未收藏 1 已收藏 柜台代码 柜台名称 柜台地址 柜台电话 营业开始时间 营业结束时间 柜台图片 所属品牌代码 剩余可使用库存 Y Y N N N N N N Y N N N N N N N N N N 是否为空 N 错误代码 错误信息 商家代码 商品sku 商品名称 商品描述 徐家汇价 活动价 购物车商品已有数量 商品是否已收藏 柜台代码 柜台名称 柜台地址 柜台电话 营业开始时间 营业结束时间 柜台图片 所属品牌代码 剩余可使用库存

productDetailsImageList bigImage smallImage streamList streamName streamCode formartInfoList keyCode valueCode keyDes valueDes 类型 值 类型描述 值的描述 是否选中规格 isCheckFormart String(1) String(20) String(20) String(200) String(200) 例，类型 颜色 例，值 白色 类型描述 值的描述 是否选中规格 0 未选中 1 已选中 N N N N N 物流名称 物流代码 String(50) String(20) 物流名称 物流代码 N N 大图 小图 String(255) String(255) 大图 小图 N N （8） 查询品牌分类列表接口(getBrandSortList)

提交Url:https://www.xjh.com/api/getBrandSortList 入参

body={\

传入变量

变量名 version merchantCode terminalCode

返回参数

参数名 result errorCode errorMsg brandSortList brandSortCode brandSortName 品牌分类编码 品牌分类名称 String(20) String(50) 品牌分类编码 品牌分类名称 N N 参数名称 返回码 类型 String(1) String(3) String(200) 描述 返回值(0失败,1成功) 错误代码 错误信息描述 Y Y 是否为空 N 变量名称 版本号 商家代码 设备号 类型 String(8) String(20) String(50) 描述 版本号 商家代码 终端编码 是否为空 N N N 错误代码 错误信息 （9） 查询品牌分类下属品牌列表接口

(getBrandByMerchantList)

提交Url:https://www.xjh.com/api/getBrandByMerchantList 入参

body={\\

传入变量

变量名 version merchantCode brandName brandSortCode terminalCode

返回参数

参数名 result errorCode errorMsg brandSortCode brandList brandCode brandName brandImage 品牌编码 品牌名称 品牌图片 String(20) String(50) String(255) 品牌编码 品牌名称 品牌图片 N N N 参数名称 返回码 类型 String(1) String(3) String(200) String(20) 描述 返回值(0失败,1成功) 错误代码 错误信息描述 品牌分类编码 Y Y N 是否为空 N 变量名称 版本号 商家代码 品牌名称 品牌分类编码 设备号 类型 String(8) String(20) String(50) String(20) String(50) 描述 版本号 商家代码 品牌名称 品牌分类编码 终端编码 是否为空 N N Y N N 错误代码 错误信息 品牌分类编码 counterList 出售该品牌柜台列表 counterName counterCode counterAddress counterImage isDefaultDisplay 柜台名称 柜台代码 柜台地址 柜台图片url 是否默认显示 String(50) String(20) String(200) String(255) String(1) 柜台名称 柜台代码 柜台地址 柜台图片url 0 否；1是 N N N N N （10） 查询品牌分类品牌归属柜台列表接口

(getBrandByCounterList)

提交Url:https://www.xjh.com/api/getBrandByCounterList 入参

body={\}}

传入变量

变量名 version merchantCode brandCode terminalCode

返回参数

参数名 result errorCode errorMsg counterList merchantCode counterCode counterName counterAddress counterImage 商家代码 柜台代码 柜台名称 柜台地址 柜台图片 String(20) String(20) String(50) String(200) String(255) 商家代码 柜台代码 柜台名称 柜台地址 柜台图片 N N N N N 参数名称 返回码 类型 String(1) String(3) String(200) 描述 返回值(0失败,1成功) 错误代码 错误信息描述 Y Y 是否为空 N 变量名称 版本号 商家代码 品牌编码 设备号 类型 String(8) String(20) String(20) String(50) 描述 版本号 商家代码 品牌编码 终端编码 是否为空 N N N N 错误代码 错误信息 （11） 查询品牌商家柜台详情接口

(getBrandMerchantCounterDetail)

提交Url:https://www.xjh.com/api/getBrandMerchantCounterDetail 入参

body={\\

传入变量

变量名 version merchantCode counterCode terminalCode 变量名称 版本号 商家代码 柜台代码 设备号 类型 String(8) String(20) String(20) String(50) 描述 版本号 商家代码 柜台代码 是否为空 N N N N 终端编码

返回参数

参数名 result errorCode errorMsg merchantCode counterCode counterName counterAddress counterImage counterTel openDate counterSummary specialsInfoList specialsStartDate specialsEndDate specialsDes newAddedProductlist productCode productImage 商品代码 商品图片 String(20) String(255) 商品代码（item） 商品图片 N N 优惠开始时间 优惠结束时间 优惠描述 String(30) String(30) String(200) 优惠开始时间 优惠结束时间 优惠描述 N N N 参数名称 返回码 类型 String(1) String(3) String(200) String(20) String(20) String(50) String(200) String(255) String(20) String(255) String(200) 描述 返回值(0失败,1成功) 错误代码 错误信息描述 商家代码 柜台代码 柜台名称 柜台地址 柜台图片 柜台电话 营业时间 柜台简介 Y Y N N N N N N N N 是否为空 N 错误代码 错误信息 商家代码 柜台代码 柜台名称 柜台地址 柜台图片 柜台电话 营业时间 柜台简介 （12） 查询柜台下商品列表接口(getCounterProductList)

提交Url: https://www. xjh.com/api/getMerchantProductList 入参

body={\\

传入变量

变量名 version merchantCode counterCode terminalCode 变量名称 版本号 商家代码 柜台代码 设备号 类型 String(8) String(20) String(20) String(50) 描述 版本号 商家代码 商品代码 终端编码 是否为空 N N N N 返回参数

errorCode errorMsg spikeList merchantCode activityCode 错误代码 错误信息 String(3) String(200) 错误代码 错误信息描述 Y Y 商家代码 活动代码 活动类型 String(20) String(20) 商家代码 活动代码 活动类型 N N N activityType 商品代码 商品名称 图片 秒杀价 徐家汇价 活动时间 String(1) 0 秒杀；1 团购；2 爆款 N N N N N N productCode productName productImage salePrice listPrice activityDate String(20) String(50) String(255) String(19) String(19) String(8) 商品代码 商品名称 图片 秒杀价 徐家汇价 活动时间 （19） 查询秒杀活动详情接口(getSpikeActivityDetail)

提交Url: https://www.xjh.com/api/ getSpikeActivityDetail 入参

body={\\传入变量(暂不做,放二期) 变量名 version merchantCode activityCode 变量名称 版本号 商家代码 活动代码 活动类型 activityType 设备号 String(1) 类型 String(8) String(20) String(20) 描述 版本号 商家代码 活动代码 活动类型 0 秒杀；1 团购；2 爆款 terminalCode

返回参数

参数名 result errorCode errorMsg activityCode 参数名称 返回码 类型 String(1) String(3) String(200) String(20) 描述 返回值(0失败,1成功) 错误代码 错误信息描述 活动代码 Y Y N 是否为空 N String(50) 终端编码 N 是否为空 N N N N 错误代码 错误信息 活动代码

merchantCode productCode productName productDes productImage salePrice listPrice deliveryMode spikeDate 商家代码 商品代码 商品名称 商品描述 图片 秒杀价 徐家汇价 配送方式 秒杀时间 String(20) String(20) String(50) String(200) String(255) String(19) String(19) String(30) String(19) 商家代码 商品代码 商品名称 商品描述 图片 秒杀价 徐家汇价 配送方式 秒杀时间 N N N N N N N N N （20） 查询扫码惠购说明(getScanExplain)(App内部接口)

提交Url: https://www.xjh.com/api/getScanExplain 入参

body={\

传入变量

变量名 version scanExplainId terminalCode

返回参数

参数名 result errorCode errorMsg ScanExplainT scanExplainId scanContent isDel versionNum createUserId createTime updateUserId updateTime 参数名称 返回码 类型 String(1) String(3) String(200) String(20) String(20) String(20) String(50) String(200) String(255) String(19) String(19) 描述 返回值(0失败,1成功) 错误代码 错误信息描述 扫码惠购说明Id 扫码惠购说明 0 正常;1删除 版本号 创建人 创建时间 修改人 修改时间 Y Y N N N N N N N N 是否为空 N 变量名称 版本号 扫码惠购说明Id 设备号 类型 String(8) String(20) String(50) 描述 版本号 扫码惠购说明Id 终端编码 是否为空 N N N 错误代码 错误信息 扫码惠购说明Id 扫码惠购说明 删除标识 版本号 创建人 创建时间 修改人 修改时间

（21） 查询App商家(getMerchantList)(App内部接口)

提交Url: https://www.xjh.com/api/getMerchantList 入参

body={\\

传入变量

变量名 version status isDel effectiveAfter terminalCode

返回参数

参数名 result errorCode errorMsg merchantList merchantId merchantName sort status effectiveTime isDel versionNum createUserId createTime updateUserId updateTime 参数名称 返回码 类型 String(1) String(3) String(200) String(20) String(20) String(20) String(50) String(200) String(255) String(19) String(19) String(19) String(19) String(19) 描述 返回值(0失败,1成功) 错误代码 错误信息描述 商家Id 商家名称 排序 0:有效;1:无效 生效时间 0:正常;1:删除 版本号 创建人 创建时间 修改人 修改时间 Y Y N N N N N N N N N N N 是否为空 N 变量名称 版本号 状态 删除标识 生效时间 设备号 类型 String(8) String(20) String(20) Date String(50) 描述 版本号 0:有效;1:无效 0 正常;1删除 大于生效时间 终端编码 是否为空 N Y Y Y N 错误代码 错误信息 商家Id 商家名称 排序 状态 生效时间 删除标识 版本号 创建人 创建时间 修改人 修改时间 （22） 查询商家首页楼层(getHomePageList)(App内部接

口)

提交Url: https://www.xjh.com/api/getHomePageList 入参

body={\

传入变量

变量名 version merchantId terminalCode

返回参数

参数名 result errorCode errorMsg homePageTList floorId category merchantId floorType isName name isFloor floorName floorNum floorLogo floorLogoUrl sort isDel versionNum createUserId createTime updateUserId updateTime 参数名称 返回码 类型 String(1) String(3) String(200) String(20) String(20) String(20) String(50) String(200) String(255) String(19) String(19) String(19) String(19) String(19) String(200) String(255) String(19) String(19) String(19) String(19) String(19) 描述 返回值(0失败,1成功) 错误代码 错误信息描述 楼层Id 1:主站;2:商家 商家Id 楼层类型 是否显示名称 名称 是否显示楼层 楼层名称 楼层数 楼层Logo 楼层Logo地址 排序 0:正常;1:删除 版本号 创建人 创建时间 修改人 修改时间 Y Y N N N N N N N N N N N N N N N N N N 是否为空 N 变量名称 版本号 商家Id 设备号 类型 String(8) String(20) String(50) 描述 版本号 商家Id 终端编码 是否为空 N N N 错误代码 错误信息 楼层Id 楼层类别 商家Id 楼层类型 是否显示名称 名称 是否显示楼层 楼层名称 楼层数 楼层Logo 楼层Logo地址 排序 删除标识 版本号 创建人 创建时间 修改人 修改时间

（23） 查询活动Banner(getActivityBannerList)(App内部

接口)

提交Url: https://www.xjh.com/api/getActivityBannerList 入参

body={\}}

传入变量

变量名 version adConfigureId merchantId terminalCode

返回参数

参数名 result errorCode errorMsg activityBannerTList activityBannerId adConfigureId bannerImage bannerAdressUrl merchantId isDel versionNum createUserId createTime updateUserId updateTime 参数名称 返回码 类型 String(1) String(3) String(200) String(20) String(20) String(20) String(50) String(200) String(255) String(19) String(19) String(19) String(19) String(19) 描述 返回值(0失败,1成功) 错误代码 错误信息描述 活动BannerId 广告配置Id Banner图片 Banner地址URL 商户Id 0:正常;1:删除 版本号 创建人 创建时间 修改人 修改时间 Y Y N N N N N N N N N N N 是否为空 N 变量名称 版本号 广告配置Id 商户Id 设备号 类型 String(8) String(20) String(20) String(50) 描述 版本号 广告配置Id 商户Id 终端编码 是否为空 N N N N 错误代码 错误信息 活动BannerId 广告配置Id Banner图片 Banner地址URL 商户Id 删除标识 版本号 创建人 创建时间 修改人 修改时间 （24） 查询活动广告配置(getAdConfigureList)(App内部

接口)

提交Url: https://www.xjh.com/api/getAdConfigureList 入参

body={\

传入变量

变量名 version merchantId floorId terminalCode

返回参数

参数名 result errorCode errorMsg adConfigureList adConfigureId floorId merchantId image sort status addedTime seat linkAddress linkObject adDes isDel versionNum createUserId createTime updateUserId updateTime 参数名称 返回码 类型 String(1) String(3) String(200) String(20) String(20) String(20) String(50) String(200) String(255) String(19) String(19) String(19) String(19) String(19) String(255) String(19) String(19) String(19) String(19) String(19) 描述 返回值(0失败,1成功) 错误代码 错误信息描述 广告配置Id 楼层Id 商户Id 图片 排序 0:有效;1:无效 上架时间 位置 链接地址 链接对象 广告说明 0:正常;1:删除 版本号 创建人 创建时间 修改人 修改时间 Y Y N N N N N N N N N N N N N N N N N 是否为空 N 变量名称 版本号 商户Id 楼层Id 设备号 类型 String(8) String(20) String(20) String(50) 描述 版本号 商户Id 楼层Id 终端编码 是否为空 N N N N 错误代码 错误信息 广告配置Id 楼层Id 商户Id 图片 排序 状态 上架时间 位置 链接地址 链接对象 广告说明 删除标识 版本号 创建人 创建时间 修改人 修改时间

（25） 查询有效的精选好货(getValidPicksGoods)(App内部

接口)

提交Url: https://www.xjh.com/api/getValidPicksGoods 入参

body={\rminalCode\

传入变量

变量名 version merchantId floorId status isDel terminalCode

返回参数

参数名 result errorCode errorMsg pickGoodsT picksGoodsId merchantId floorId image urlAddress status isDel versionNum createUserId createTime updateUserId updateTime 参数名称 返回码 类型 String(1) String(3) String(200) String(20) String(20) String(20) String(50) String(200) String(255) String(255) String(19) String(19) String(19) String(19) String(19) 描述 返回值(0失败,1成功) 错误代码 错误信息描述 精选好货Id 商家Id 楼层Id 图片 URL地址 0:有效;1:无效 0:正常;1:删除 版本号 创建人 创建时间 修改人 修改时间 Y Y N N N N N N N N N N N N 是否为空 N 变量名称 版本号 商户Id 楼层Id 状态 删除标识 设备号 类型 String(8) String(20) String(20) String(20) String(20) String(50) 描述 版本号 商户Id floorId 0:有效、1:无效 0:正常、1:删除 终端编码 是否为空 N N N N N N 错误代码 错误信息 精选好货Id 商家Id 楼层Id 图片 URL地址 状态 删除标识 版本号 创建人 创建时间 修改人 修改时间

（26） 查询热门品牌(getTopBrandsList)(App内部接口)

提交Url: https://www.xjh.com/api/getTopBrandsList 入参

body={\rminalCode\

传入变量

变量名 version merchantId floorId status isDel terminalCode

返回参数

参数名 result errorCode errorMsg topBrandsTList topBrandsId merchantId floorId classifyId classifyName image urlAddress mappedClassify classifySort classifyExplain status isDel versionNum createUserId 参数名称 返回码 类型 String(1) String(3) String(200) String(20) String(20) String(20) String(20) String(50) String(50) String(200) String(50) String(50) String(50) String(255) String(255) String(19) String(19) 描述 返回值(0失败,1成功) 错误代码 错误信息描述 广告配置Id 商家Id 楼层Id 分类Id 分类名称 图片 URL地址 映射分类 分类排序 分类说明 0:有效;1:无效 0:正常;1:删除 版本号 创建人 Y Y N N N N N N N N N 是否为空 N 变量名称 版本号 商户Id 楼层Id 状态 删除标识 设备号 类型 String(8) String(20) String(20) String(20) String(20) String(50) 描述 版本号 商户Id 楼层Id 0:有效、1:无效 0:正常、1:删除 终端编码 是否为空 N N N N N N 错误代码 错误信息 广告配置Id 商家Id 楼层Id 分类Id 分类名称 图片 URL地址 映射分类 分类排序 分类说明 状态 删除标识 版本号 创建人

createTime updateUserId updateTime 创建时间 修改人 修改时间 String(19) String(19) String(19) 创建时间 修改人 修改时间 N N N （27） 查询推荐门店(getRecommendStoresList)(App内

部接口)

提交Url: https://www.xjh.com/api/getRecommendStoresList 入参

body={\rminalCode\

传入变量

变量名 version merchantId floorId status isDel terminalCode

返回参数

参数名 result errorCode errorMsg topBrandsTList recommendStoresId merchantId floorId storeId storeName image urlAddress sort status 参数名称 返回码 类型 String(1) String(3) String(200) String(20) String(20) String(20) String(20) String(50) String(50) String(200) String(50) String(255) 描述 返回值(0失败,1成功) 错误代码 错误信息描述 推荐门店Id 商家Id 楼层Id 门店Id 门店名称 图片 URL地址 排序 0:有效;1:无效 Y Y N N N N N N 是否为空 N 变量名称 版本号 商户Id 楼层Id 状态 删除标识 设备号 类型 String(8) String(20) String(20) String(20) String(20) String(50) 描述 版本号 商户Id 楼层Id 0:有效、1:无效 0:正常、1:删除 终端编码 是否为空 N N N N N N 错误代码 错误信息 推荐门店Id 商家Id 楼层Id 门店Id 门店名称 图片 URL地址 排序 状态

isDel versionNum createUserId createTime updateUserId updateTime 删除标识 版本号 创建人 创建时间 修改人 修改时间 String(255) String(19) String(19) String(19) String(19) String(19) 0:正常;1:删除 版本号 创建人 创建时间 修改人 修改时间 N N N N N N （28） 查询楼层扩展模块(getModelList)(App内部接口)

提交Url: https://www.xjh.com/api/getModelList 入参

body={\

传入变量

变量名 version floorId status isDel terminalCode

返回参数

参数名 result errorCode errorMsg modelTList modelId floorId modelName modelSeq modelConnectionObject modelImg imageUrl imageConnectionObject 模块图片 图片URL 图片链接对象 参数名称 返回码 类型 String(1) String(3) String(200) String(20) String(20) String(20) String(50) String(50) String(200) String(50) String(200) 描述 返回值(0失败,1成功) 错误代码 错误信息描述 模块Id 楼层Id 模块名称 模块URL 模块链接对象 Y Y N N N Y N 是否为空 N 变量名称 版本号 楼层Id 状态 删除标识 设备号 类型 String(8) String(20) String(20) String(20) String(50) 描述 版本号 楼层Id 0:有效、1:无效 0:正常、1:删除 终端编码 是否为空 N N N N N 错误代码 错误信息 模块Id 楼层Id 模块名称 模块URL 模块链接对象 模块图片 图片URL 图片链接对象 N N N

本文来源：https://www.bwwdw.com/article/s90d.html