
<用户模块>
    <接口 name="获取用户信息" address="/user/getUserDetail.do">
        <请求报文>
            <必填参数>
                <param name="th3rd_session">会话ID</param>
            </必填参数>
        </请求报文>
        <响应报文>
            <json>{"status":"响应状态码", "message":"响应状态码说明", "data":{"user":{用户信息}, "roleType":"角色类型（0普通1管家2厂长3渠道合作商4渠道物流）"}}</json>
            <data>
                <param name="roleType">角色类型（0普通1管家2厂长3渠道合作商4渠道物流）</param>
                <user remark="用户信息(必有值)">
                    <attr name="id">用户编号</attr>
                    <attr name="storeId">所属门店ID</attr>
                    <attr name="comityId">团体客户ID</attr>
                    <attr name="telephone">用户手机号</attr>
                    <attr name="cardNum">会员卡号</attr>
                    <attr name="unionid">微信UniodId</attr>
                    <attr name="openid">公众号openid</attr>
                    <attr name="mpOpenid">小程序openid</attr>
                    <attr name="avatarUrl">用户头像图片的URL</attr>
                    <attr name="realName">真实姓名</attr>
                    <attr name="nickName">用户昵称</attr>
                    <attr name="country">用户所在国家</attr>
                    <attr name="province">用户所在省份</attr>
                    <attr name="city">用户所在城市</attr>
                    <attr name="language">语言</attr>
                    <attr name="userType">用户类型（1微信用户2电话用户）</attr>
                    <attr name="levelId">用户级别（0为普通用户）</attr>
                    <attr name="birthday">出生日期</attr>
                    <attr name="gender">性别</attr>
                    <attr name="pwd">登录密码</attr>
                    <attr name="balance">账户余额</attr>
                    <attr name="points">用户积分</attr>
                    <attr name="qq">用户QQ</attr>
                    <attr name="email">电子邮箱</attr>
                    <attr name="areaId">用户所在区县编号</attr>
                    <attr name="address">用户地址</attr>
                    <attr name="longitude">用户所在位置-经度</attr>
                    <attr name="latitude">用户所在位置-纬度</attr>
                    <attr name="remark">备注信息</attr>
                    <attr name="createTime">用户信息创建时间</attr>
                    <attr name="updateTime">最近更新时间</attr>
                    <attr name="state">用户状态：-2已删除，-1已注销，0已禁用（黑名单），1正常</attr>
                    <attr name="levelName">用户级别名称</attr>
                    <attr name="userGroupName">客户所属分组名称</attr>
                    <attr name="comityName">团体客户名称</attr>
                    <attr name="couponsNum">优惠券数量</attr>
                </user>
                <staff remark="员工信息(roleType=1或roleType=2时有值)">
                    <attr name="id">编号</attr>
                    <attr name="storeId">所属门店ID</attr>
                    <attr name="roleId">角色ID</attr>
                    <attr name="staffName">员工姓名</attr>
                    <attr name="jobNo">工号</attr>
                    <attr name="telephone">手机号</attr>
                    <attr name="unionid">微信UniodId</attr>
                    <attr name="openid">公众号openid</attr>
                    <attr name="mpOpenid">小程序openid</attr>
                    <attr name="pwd">登录密码</attr>
                    <attr name="pwdSalt">密码加密盐值</attr>
                    <attr name="addTime">账号创建时间</attr>
                    <attr name="state">账号状态 1可用，0禁用</attr>
                    <attr name="pickupProp">取件提成比例(单位%)</attr>
                    <attr name="deliveryProp">送件提成比例(单位%)</attr>
                    <attr name="sellCardProp">售卡提成比例(单位%)</attr>
                    <attr name="distributeProp">推广提成比例(单位%)</attr>
                    <attr name="rechargeProp">充值提成比例(单位%)</attr>
                    <attr name="imgUrl">员工图片URL</attr>
                    <attr name="avatarUrl">微信头像URL</attr>
                    <attr name="balance">员工账户余额</attr>
                    <attr name="areaId">员工所属地区ID</attr>
                    <attr name="areaName">员工所属地区名称</attr>
                    <attr name="roleType">角色类型（0普通1管家2厂长3渠道合作商4渠道物流）</attr>
                    <attr name="roleName">员工角色名称</attr>
                    <attr name="storeName">员工角门店名称色名称</attr>
                    <attr name="storeAddr">门店详细地址</attr>
                    <attr name="wxQrcodeUrl">员工专属分销二维码地址</attr>
                </staff>
            </data>
        </响应报文>
    </接口>
    <接口 name="更新用户个人信息" address="user/updateUser.do" method="get|post">
        <请求报文>
            <必填参数>
                <param name="th3rd_session" type="string">会话ID</param>
            </必填参数>
            <可选参数>
                <param name="areaId">用户选择的地区ID</param>
                <param name="nickName">用户昵称</param>
                <param name="avatarUrl">用户微信头像</param>
                <param name="gender">用户性别 0未知1男2女</param>
                <param name="country">用户所在国家</param>
                <param name="province">用户所在省份</param>
                <param name="city">用户所在城市</param>
                <param name="language">语言</param>
            </可选参数>
        </请求报文>
        <响应报文>
            <json>{"status":"响应状态码", "message":"响应状态码说明", "data":{"user":{用户信息}}}</json>
            <data>
                <user remark="用户信息">
                    <attr name="id">用户编号</attr>
                    <attr name="storeId">所属门店ID</attr>
                    <attr name="comityId">团体客户ID</attr>
                    <attr name="telephone">用户手机号</attr>
                    <attr name="cardNum">会员卡号</attr>
                    <attr name="unionid">微信UniodId</attr>
                    <attr name="openid">公众号openid</attr>
                    <attr name="mpOpenid">小程序openid</attr>
                    <attr name="avatarUrl">用户头像图片的URL</attr>
                    <attr name="realName">真实姓名</attr>
                    <attr name="nickName">用户昵称</attr>
                    <attr name="country">用户所在国家</attr>
                    <attr name="province">用户所在省份</attr>
                    <attr name="city">用户所在城市</attr>
                    <attr name="language">语言</attr>
                    <attr name="userType">用户类型（1微信用户2电话用户）</attr>
                    <attr name="levelId">用户级别（0为普通用户）</attr>
                    <attr name="birthday">出生日期</attr>
                    <attr name="gender">性别</attr>
                    <attr name="pwd">登录密码</attr>
                    <attr name="balance">账户余额</attr>
                    <attr name="points">用户积分</attr>
                    <attr name="qq">用户QQ</attr>
                    <attr name="email">电子邮箱</attr>
                    <attr name="areaId">用户所在区县编号</attr>
                    <attr name="address">用户地址</attr>
                    <attr name="longitude">用户所在位置-经度</attr>
                    <attr name="latitude">用户所在位置-纬度</attr>
                    <attr name="remark">备注信息</attr>
                    <attr name="createTime">用户信息创建时间</attr>
                    <attr name="updateTime">最近更新时间</attr>
                    <attr name="state">用户状态：-2已删除，-1已注销，0已禁用（黑名单），1正常</attr>
                    <attr name="levelName">用户级别名称</attr>
                    <attr name="userGroupName">客户所属分组名称</attr>
                    <attr name="comityName">团体客户名称</attr>
                    <attr name="couponsNum">优惠券数量</attr>
                </user>
            </data>
        </响应报文>
    </接口>
    <接口 name="根据手机号查询用户信息" address="/user/getUserByTelephone.do">
        <请求报文>
            <必填参数>
                <param name="th3rd_session">会话ID</param>
                <param name="telephone">手机号</param>
            </必填参数>
        </请求报文>
        <响应报文>
            <json>{"status":"响应状态码", "message":"响应状态码说明", "data":{"user":{用户信息}}}</json>
            <data>
                <user remark="用户信息">
                    <attr name="id">用户编号</attr>
                    <attr name="storeId">所属门店ID</attr>
                    <attr name="comityId">团体客户ID</attr>
                    <attr name="telephone">用户手机号</attr>
                    <attr name="cardNum">会员卡号</attr>
                    <attr name="unionid">微信UniodId</attr>
                    <attr name="openid">公众号openid</attr>
                    <attr name="mpOpenid">小程序openid</attr>
                    <attr name="avatarUrl">用户头像图片的URL</attr>
                    <attr name="realName">真实姓名</attr>
                    <attr name="nickName">用户昵称</attr>
                    <attr name="country">用户所在国家</attr>
                    <attr name="province">用户所在省份</attr>
                    <attr name="city">用户所在城市</attr>
                    <attr name="language">语言</attr>
                    <attr name="userType">用户类型（1微信用户2电话用户）</attr>
                    <attr name="levelId">用户级别（0为普通用户）</attr>
                    <attr name="birthday">出生日期</attr>
                    <attr name="gender">性别</attr>
                    <attr name="pwd">登录密码</attr>
                    <attr name="balance">账户余额</attr>
                    <attr name="points">用户积分</attr>
                    <attr name="qq">用户QQ</attr>
                    <attr name="email">电子邮箱</attr>
                    <attr name="areaId">用户所在区县编号</attr>
                    <attr name="address">用户地址</attr>
                    <attr name="longitude">用户所在位置-经度</attr>
                    <attr name="latitude">用户所在位置-纬度</attr>
                    <attr name="remark">备注信息</attr>
                    <attr name="createTime">用户信息创建时间</attr>
                    <attr name="updateTime">最近更新时间</attr>
                    <attr name="state">用户状态：-2已删除，-1已注销，0已禁用（黑名单），1正常</attr>
                    <attr name="levelName">用户级别名称</attr>
                    <attr name="userGroupName">客户所属分组名称</attr>
                    <attr name="comityName">团体客户名称</attr>
                    <attr name="couponsNum">优惠券数量</attr>
                </user>
            </data>
        </响应报文>
    </接口>
    <接口 name="获取充值优惠政策" address="/user/rechargeDiscount.do">
        <请求报文>
            <必填参数>
                <param name="th3rd_session">会话ID</param>
            </必填参数>
        </请求报文>
        <响应报文>
            <json>{"status":"响应状态码", "message":"响应状态码说明", "data":{"rechargeDiscounts":[{充值优惠政策信息}...]}}</json>
            <data>
                <rechargeDiscounts remark="充值优惠政策信息">
                    <attr name="id">编号</attr>
                    <attr name="minMoney">充值最低金额</attr>
                    <attr name="maxMoney">充值最高金额</attr>
                    <attr name="giftMoney">赠送金额</attr>
                    <attr name="descn">优惠基础信息描述</attr>
                    <attr name="state">可用状态(1可用，0不可用)</attr>
                    <attr name="specialOffer">是否特惠(1特惠0普通)</attr>
                </rechargeDiscounts>
            </data>
        </响应报文>
    </接口>
    <接口 name="获取充值订单微信预支付信息" address="/user/rechargeWxPay.do">
        <请求报文>
            <必填参数>
                <param name="th3rd_session">会话ID</param>
                <param name="money">充值金额</param>
            </必填参数>
        </请求报文>
        <响应报文>
            <json>{"status":"响应状态码", "message":"响应状态码说明", "data":{微信支付订单预支付信息}}</json>
            <data remark="微信支付订单预支付信息">
                <attr name="appId">公众号id</attr>
                <attr name="timeStamp">时间戳</attr>
                <attr name="nonceStr">随机字符串</attr>
                <attr name="package">订单详情扩展字符串</attr>
                <attr name="signType">签名方式</attr>
                <attr name="paySign">签名</attr>
            </data>
        </响应报文>
    </接口>
    <接口 name="查询充值卡信息" address="/user/getRechargeCard.do">
        <请求报文>
            <必填参数>
                <param name="th3rd_session">会话ID</param>
                <param name="cardNo">卡号</param>
            </必填参数>
        </请求报文>
        <响应报文>
            <json>{"status":"响应状态码", "message":"响应状态码说明", "data":{"rechargeCard":{充值卡信息}}}</json>
            <data>
                <rechargeCard remark="充值卡信息">
                    <attr name="id">编号</attr>
                    <attr name="cardNo">卡号</attr>
                    <attr name="salePrice">销售价格</attr>
                    <attr name="facePrice">卡面值</attr>
                    <attr name="state">状态(-1已注销0待销售1待激活2已激活)</attr>
                </rechargeCard>
            </data>
        </响应报文>
    </接口>
    <接口 name="充值卡充值" address="/user/rechargeByCard.do">
        <请求报文>
            <必填参数>
                <param name="th3rd_session">会话ID</param>
                <param name="userId">用户ID</param>
                <param name="cardNo">卡号</param>
                <param name="cardPwd">卡密码</param>
            </必填参数>
        </请求报文>
        <响应报文>
            <json>{"status":"响应状态码", "message":"响应状态码说明", "data":{"recharge":{充值记录}}}</json>
            <data>
                <recharge remark="充值记录">
                    <attr name="id">编号</attr>
                    <attr name="storeId">所属门店ID</attr>
                    <attr name="userId">用户ID</attr>
                    <attr name="flowNo">充值流水号</attr>
                    <attr name="rechargeMoney">充值金额</attr>
                    <attr name="giveMoney">充值赠送金额</attr>
                    <attr name="totalMoney">到账总金额 到账总金额=充值金额+赠送金额</attr>
                    <attr name="accountMoney">充值后账户余额</attr>
                    <attr name="descn">描述</attr>
                    <attr name="rechargeFrom">充值来源(1微信充值，2平台现金充值、3聚合支付充值、4银联支付充值、5充值卡充值)</attr>
                    <attr name="rechargeTime">充值时间</attr>
                    <attr name="rechargeStaffId">充值操作员工ID</attr>
                    <attr name="rechargeUserId">充值操作用户ID</attr>
                    <attr name="operatorName">操作人名</attr>
                    <attr name="state">充值状态 0充值失败，1充值成功</attr>
                </recharge>
            </data>
        </响应报文>
    </接口>
    <接口 name="账户充值" address="/user/recharge.do">
        <请求报文>
            <必填参数>
                <param name="th3rd_session">会话ID</param>
                <param name="userId">用户ID</param>
                <param name="rechargeFrom">充值来源(1微信充值，2平台现金充值，3聚合支付充值，4银联支付充值)</param>
                <param name="rechargeMoney">充值金额(单位：元)</param>
            </必填参数>
            <可选参数>
                <param name="discountUser">是否折扣用户（1是0否，默认0）</param>
                <param name="giveMoney">充值赠送金额（若传入该值，则以赠送金额为准，否则，以平台充值优惠政策为准）</param>
                <param name="flowNo">若为微信支付，则需要传入微信支付时生成的流水号</param>
            </可选参数>
        </请求报文>
        <响应报文>
            <json>{"status":"响应状态码", "message":"响应状态码说明", "data":{"recharge":{充值记录}}}</json>
            <data>
                <recharge remark="充值记录">
                    <attr name="id">编号</attr>
                    <attr name="storeId">所属门店ID</attr>
                    <attr name="userId">用户ID</attr>
                    <attr name="flowNo">充值流水号</attr>
                    <attr name="rechargeMoney">充值金额</attr>
                    <attr name="giveMoney">充值赠送金额</attr>
                    <attr name="totalMoney">到账总金额 到账总金额=充值金额+赠送金额</attr>
                    <attr name="accountMoney">充值后账户余额</attr>
                    <attr name="descn">描述</attr>
                    <attr name="rechargeFrom">充值来源(1微信充值，2平台现金充值、3聚合支付充值、4银联支付充值，5充值卡充值)</attr>
                    <attr name="rechargeTime">充值时间</attr>
                    <attr name="rechargeStaffId">充值操作员工ID 当充值来源为2平台现金充值、3聚合支付充值、4银联支付充值时不为空</attr>
                    <attr name="rechargeUserId">充值操作用户ID 当充值来源为1微信充值时不为空</attr>
                    <attr name="operatorName">操作人名</attr>
                    <attr name="state">充值状态 0充值失败，1充值成功</attr>
                </recharge>
            </data>
        </响应报文>
    </接口>
    <接口 name="获取用户余额变动记录" address="/user/getBalanceLog.do">
        <请求报文>
            <必填参数>
                <param name="th3rd_session">会话ID</param>
            </必填参数>
        </请求报文>
        <响应报文>
            <json>{"status":"响应状态码", "message":"响应状态码说明", "data":{"balanceLogs":[{余额变动记录}]}}</json>
            <data>
                <balanceLogs remark="余额变动记录">
                    <attr name="id">编号</attr>
                    <attr name="userId">用户ID</attr>
                    <attr name="changeMoney">余额增量(余额增加时为正数，余额减少时为负数)</attr>
                    <attr name="curBalance">当前账户总余额</attr>
                    <attr name="briefInfo">余额变动简述</attr>
                    <attr name="descn">余额变动描述</attr>
                    <attr name="logTime">记录时间</attr>
                </balanceLogs>
            </data>
        </响应报文>
    </接口>
    <接口 name="领取优惠券" address="/user/pickupCoupons.do">
        <请求报文>
            <必填参数>
                <param name="th3rd_session">会话ID</param>
                <param name="couponsId">优惠券ID</param>
            </必填参数>
        </请求报文>
        <响应报文>
            <json>{"status":"响应状态码", "message":"响应状态码说明"}</json>
        </响应报文>
    </接口>
    <接口 name="获取用户领取的优惠券列表" address="/user/getCoupons.do">
        <请求报文>
            <必填参数>
                <param name="th3rd_session">会话ID</param>
                <param name="couponsState">优惠券状态（-1已过期 1待使用 2已使用）</param>
            </必填参数>
        </请求报文>
        <响应报文>
            <json>{"status":"响应状态码", "message":"响应状态码说明", "data":{"couponsList":[{优惠券信息}]}}</json>
            <data>
                <couponsList remark="优惠券信息">
                    <attr name="id">编号</attr>
                    <attr name="usrLevelId">会员等级ID</attr>
                    <attr name="couponName">优惠券名称</attr>
                    <attr name="descn">优惠券描述</attr>
                    <attr name="money">优惠券金额</attr>
                    <attr name="minCosumeMoney">最低消费额</attr>
                    <attr name="startTime">有效期起始时间</attr>
                    <attr name="endTime">有效期失效时间</attr>
                    <attr name="pickupLimit">领取限制 每人最多领几张，0表示不限制</attr>
                    <attr name="storeNum">库存量</attr>
                    <attr name="createTime">优惠券创建时间</attr>
                    <attr name="userId">用户ID</attr>
                    <attr name="pickupTime">领取时间</attr>
                    <attr name="useState">优惠券使用状态（-1已过期 0未生效 1已生效 2已使用）</attr>
                    <attr name="useTime">优惠券使用时间</attr>
                    <attr name="state">优惠券状态（-1已过期 0未生效 1已生效）</attr>
                </couponsList>
            </data>
        </响应报文>
    </接口>
    <接口 name="获取符合订单使用的优惠券列表" address="/user/getOrderCoupons.do">
        <请求报文>
            <必填参数>
                <param name="th3rd_session">会话ID</param>
                <param name="orderId">订单ID</param>
            </必填参数>
        </请求报文>
        <响应报文>
            <json>{"status":"响应状态码", "message":"响应状态码说明", "data":{"couponsList":[{优惠券信息}]}}</json>
            <data>
                <couponsList remark="优惠券信息">
                    <attr name="id">编号</attr>
                    <attr name="usrLevelId">会员等级ID</attr>
                    <attr name="couponName">优惠券名称</attr>
                    <attr name="descn">优惠券描述</attr>
                    <attr name="money">优惠券金额</attr>
                    <attr name="minCosumeMoney">最低消费额</attr>
                    <attr name="startTime">有效期起始时间</attr>
                    <attr name="endTime">有效期失效时间</attr>
                    <attr name="pickupLimit">领取限制 每人最多领几张，0表示不限制</attr>
                    <attr name="storeNum">库存量</attr>
                    <attr name="createTime">优惠券创建时间</attr>
                    <attr name="userId">用户ID</attr>
                    <attr name="pickupTime">领取时间</attr>
                    <attr name="useState">优惠券使用状态（-1已过期 0未生效 1已生效 2已使用）</attr>
                    <attr name="useTime">优惠券使用时间</attr>
                    <attr name="state">优惠券状态（-1已过期 0未生效 1已生效）</attr>
                </couponsList>
            </data>
        </响应报文>
    </接口>
</用户模块>