产品接口


获取产品分类列表
权限
登录
鉴权
Headers
参数
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 0
msg string 返回成功信息
data array 分类列表
{"code":0,"msg":"获取成功","data":[]}
获取产品数据列表
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
page integer 页码
page_size integer 每页数量,默认20
category_id integer 产品分类
is_hot integer 是否热门 1是 0否
is_recommend integer 是否推荐 1是 0否
search string 模糊搜索关键词
orders array 排序参数,如orders[sale]=desc
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 0
msg string 返回成功信息
data object 包含total, per_page, current_page, last_page, data的列表对象
{"code":0,"msg":"","data":{"total":1,"per_page":20,"current_page":1,"last_page":1,"data":[]}}
根据产品ID获取产品信息
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
product_id integer 产品ID
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 0
msg string 返回信息
data object 产品详情数据
{"code":0,"msg":"获取成功","data":{"id":1,"name":"产品名称","attrs":[],"specs":[]}}
根据用户选择产品规格等计算价格
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
product_id integer 产品ID
spec_id integer 规格ID
date string 日期
quantity integer 购买数量,默认1
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 0
msg string 返回信息
data string 计算后的价格
{"code":0,"msg":"","data":"100.00"}
根据用户选择的属性集合获取对应的规格集合
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
product_id integer 产品ID
attr_ids string 属性ID集合,逗号分隔
buy_num integer 购买数量,默认1
date string 日期
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 0
msg string 返回信息
data array 匹配到的规格列表
{"code":0,"msg":"获取成功","data":[]}
分页获取推荐产品列表,依据今日爆款分类与产品推荐
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
request_session string 请求会话ID
page integer 页码
page_size integer 每页数量,默认20
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 0
msg string 返回信息
data object 包含分页信息的列表对象
{"code":0,"msg":"查询成功","data":{"total":1,"per_page":20,"current_page":1,"last_page":1,"data":[]}}
分页获取猜你喜欢产品列表,依据用户习惯以及收藏、浏览足迹等进行推荐
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
request_session string 请求会话ID
page integer 页码
page_size integer 每页数量,默认20
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 0
msg string 返回信息
data object 包含分页信息的列表对象
{"code":0,"msg":"查询成功","data":{"total":1,"per_page":20,"current_page":1,"last_page":1,"data":[]}}
根据获取AI选品信息
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
requirements string 需求描述
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 0
msg string 返回信息
data object AI选品信息对象
{"code":0,"msg":"获取成功","data":{}}
根据获取AI选品信息获取对应产品结果
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
page integer 页码
page_size integer 每页数量,默认20
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 0
msg string 返回信息
data object 选品产品列表数据
{"code":0,"msg":"获取成功","data":[]}

订单接口


创建订单预算
权限
登录
鉴权
Headers
参数
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 0
msg string 返回成功信息
data array 订单预算信息
{"code":0,"msg":"创建成功","data":{}}
创建新订单
权限
登录
鉴权
Headers
参数
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 0
msg string 返回成功信息
data array 订单信息
{"code":0,"msg":"创建成功","data":{}}
发起订单支付
权限
登录
鉴权
Headers
参数
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 0
msg string 返回成功信息
data array 支付参数
{"code":0,"msg":"成功","data":{}}
获取用户订单列表
权限
登录
鉴权
Headers
参数
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 0
msg string 返回成功信息
data array 订单列表数据
{"code":0,"msg":"成功","data":{}}
获取订单详细信息
权限
登录
鉴权
Headers
参数
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 0
msg string 返回成功信息
data array 订单详情数据
{"code":0,"msg":"成功","data":{}}
用户主动取消订单
权限
登录
鉴权
Headers
参数
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 0
msg string 返回成功信息
data array 返回数据
{"code":0,"msg":"取消成功","data":{}}
用户申请订单退款
权限
登录
鉴权
Headers
参数
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 0
msg string 返回成功信息
data array 返回数据
{"code":0,"msg":"申请退款成功","data":{}}

公共接口


加载初始化相关配置数据
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
version string 版本号
lng string 经度
lat string 纬度
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer
msg string
data array 数据列表
{
     *  "code": 1,
     *  "msg": "返回成功",
     *  "time": "1588888888",
     *  "data": {}
     * }
获取首页配置数据
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
group string 分组
force boolean 是否强制刷新
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer
msg string
data array 数据列表
{
     *  "code": 1,
     *  "msg": "返回成功",
     *  "time": "1588888888",
     *  "data": {}
     * }
上传文件到服务器或云存储
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
file file 文件
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer
msg string
data array 数据列表
{
     *  "code": 1,
     *  "msg": "返回成功",
     *  "time": "1588888888",
     *  "data": {}
     * }
获取图形验证码
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
id string 要生成验证码的标识
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer
msg string
data array 数据列表
{
     *  "code": 1,
     *  "msg": "返回成功",
     *  "time": "1588888888",
     *  "data": {}
     * }
根据父级ID获取地区列表
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
pid integer 父级ID
ids string 地区ID集合(逗号分隔
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer
msg string
data array 数据列表
{
     *  "code": 1,
     *  "msg": "返回成功",
     *  "time": "1588888888",
     *  "data": {}
     * }

会员接口


会员中心
权限
登录
鉴权
Headers
参数
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 返回操作编号,0:成功,大于0:警告信息,小于0:错误信息
msg string 返回操作信息
data object 返回数据
{
     *      'code':'0',
     *      'msg':'成功'
     *}
会员登录
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
account string 账号
password string 密码
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 返回操作编号,0:成功,大于0:警告信息,小于0:错误信息
msg string 返回操作信息
data object 返回数据
{
     *      'code':'0',
     *      'msg':'登录成功'
     *}
手机验证码登录
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
mobile string 手机号
captcha string 验证码
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 返回操作编号,0:成功,大于0:警告信息,小于0:错误信息
msg string 返回操作信息
data object 返回数据
{
     *      'code':'0',
     *      'msg':'登录成功'
     *}
注册会员
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
username string 用户名
password string 密码
email string 邮箱
mobile string 手机号
code string 验证码
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 返回操作编号,0:成功,大于0:警告信息,小于0:错误信息
msg string 返回操作信息
data object 返回数据
{
     *      'code':'0',
     *      'msg':'注册成功'
     *}
退出登录
权限
登录
鉴权
Headers
参数
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 返回操作编号,0:成功,大于0:警告信息,小于0:错误信息
msg string 返回操作信息
data object 返回数据
{
     *      'code':'0',
     *      'msg':'退出成功'
     *}
注销账户
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
restore int 是否恢复账号,默认0
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 返回操作编号,0:成功,大于0:警告信息,小于0:错误信息
msg string 返回操作信息
data object 返回数据
{
     *      'code':'0',
     *      'msg':'退出成功'
     *}
获取用户的简单信息
权限
登录
鉴权
Headers
参数
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 返回操作编号,0:成功,大于0:警告信息,小于0:错误信息
msg string 返回操作信息
data object 返回数据
{
     *      'code':'0',
     *      'msg':'获取成功'
     *}
修改会员个人信息
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
avatar string 头像地址
username string 用户名
nickname string 昵称
bio string 个人简介
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 返回操作编号,0:成功,大于0:警告信息,小于0:错误信息
msg string 返回操作信息
data object 返回数据
{
     *      'code':'0',
     *      'msg':'修改成功'
     *}
修改邮箱
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
email string 邮箱
captcha string 验证码
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 返回操作编号,0:成功,大于0:警告信息,小于0:错误信息
msg string 返回操作信息
data object 返回数据
{
     *      'code':'0',
     *      'msg':'修改成功'
     *}
修改手机号
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
mobile string 手机号
captcha string 验证码
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 返回操作编号,0:成功,大于0:警告信息,小于0:错误信息
msg string 返回操作信息
data object 返回数据
{
     *      'code':'0',
     *      'msg':'修改成功'
     *}
第三方登录
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
platform string 平台名称
code string Code
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 返回操作编号,0:成功,大于0:警告信息,小于0:错误信息
msg string 返回操作信息
data object 返回数据
{
     *      'code':'0',
     *      'msg':'登录成功'
     *}
重置密码
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
mobile string 手机号
newpassword string 新密码
captcha string 验证码
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 返回操作编号,0:成功,大于0:警告信息,小于0:错误信息
msg string 返回操作信息
data object 返回数据
{
     *      'code':'0',
     *      'msg':'重置密码成功'
     *}
购物车列表
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
page integer 页码
page_size integer 每页数量,默认20条
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 返回操作编号,0:成功,大于0:警告信息,小于0:错误信息
msg string 返回操作信息
data object 返回数据
{
     *      'code':'0',
     *      'msg':'获取成功'
     *}
保存购物车
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
id integer 购物车ID,修改时传入
product_id integer 产品ID
quantity integer 购买数量
spec_id string 规格编号
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 返回操作编号,0:成功,大于0:警告信息,小于0:错误信息
msg string 返回操作信息
data object 返回数据
{
     *      'code':'0',
     *      'msg':'保存成功'
     *}
删除购物车
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
cart_ids string 购物车产品ID集合,逗号分隔
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 返回操作编号,0:成功,大于0:警告信息,小于0:错误信息
msg string 返回操作信息
data object 返回数据
{
     *      'code':'0',
     *      'msg':'删除成功'
     *}
收藏或取消收藏产品
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
product_id integer 产品ID
spec_id integer 规格ID,默认0
is_favorite integer 1为收藏 0为取消收藏
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 0
msg string 返回信息
data null null
{"code":0,"msg":"收藏成功","data":null}
分页获取用户的收藏产品列表
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
page integer 页码
page_size integer 每页数量,默认20
search string 模糊搜索关键词
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 0
msg string 返回信息
data object 包含分页信息的列表对象
{"code":0,"msg":"查询成功","data":{"total":1,"per_page":20,"current_page":1,"last_page":1,"data":[]}}
添加用户的产品浏览记录
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
product_id integer 产品ID
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 0
msg string 返回信息
data null null
{"code":0,"msg":"记录成功","data":null}
分页获取用户的浏览产品记录
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
page integer 页码
page_size integer 每页数量,默认20
search string 模糊搜索关键词
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 0
msg string 返回信息
data object 包含分页信息的列表对象
{"code":0,"msg":"查询成功","data":{"total":1,"per_page":20,"current_page":1,"last_page":1,"data":[]}}
获取用户收货地址列表
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
select_id integer 已选中地址ID,默认不传
page integer 页码
page_size integer 每页数量,默认20
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 返回操作编号,0:成功,大于0:警告信息,小于0:错误信息
msg string 返回操作信息
data array 返回数据
{
     *      'code':'0',
     *      'msg':'获取成功'
     *}
新增或编辑收货地址
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
id integer 地址ID(传则编辑,不传则新增
name string 姓名
mobile string 手机号
province integer 省份ID
city integer 城市ID
region integer 区县ID
town integer 镇/街道ID
address string 详细地址
default integer 是否默认(1是0否
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 返回操作编号,0:成功,大于0:警告信息,小于0:错误信息
msg string 返回操作信息
data object 返回数据
{
     *      'code':'0',
     *      'msg':'保存成功'
     *}
获取默认收货地址
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
id integer 地址ID
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 返回操作编号,0:成功,大于0:警告信息,小于0:错误信息
msg string 返回操作信息
data object 返回数据
{
     *      'code':'0',
     *      'msg':'删除成功'
     *}
删除收货地址
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
id integer 地址ID
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 返回操作编号,0:成功,大于0:警告信息,小于0:错误信息
msg string 返回操作信息
data object 返回数据
{
     *      'code':'0',
     *      'msg':'删除成功'
     *}

邮箱验证码接口


发送验证码
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
email string 邮箱
event string 事件名称
正文
参数
响应输出

                                                            

                                                        
返回参数
检测验证码
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
email string 邮箱
event string 事件名称
captcha string 验证码
正文
参数
响应输出

                                                            

                                                        
返回参数

首页接口


首页
权限
登录
鉴权
Headers
参数
正文
参数
响应输出

                                                            

                                                        
返回参数

手机短信接口


发送验证码
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
mobile string 手机号
event string 事件名称
正文
参数
响应输出

                                                            

                                                        
返回参数
检测验证码
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
mobile string 手机号
event string 事件名称
captcha string 验证码
正文
参数
响应输出

                                                            

                                                        
返回参数

Token接口


检测Token是否过期
权限
登录
鉴权
Headers
参数
正文
参数
响应输出

                                                            

                                                        
返回参数
刷新Token
权限
登录
鉴权
Headers
参数
正文
参数
响应输出

                                                            

                                                        
返回参数

验证接口


检测邮箱
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
email string 邮箱
id string 排除会员ID
正文
参数
响应输出

                                                            

                                                        
返回参数
检测用户名
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
username string 用户名
id string 排除会员ID
正文
参数
响应输出

                                                            

                                                        
返回参数
检测昵称
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
nickname string 昵称
id string 排除会员ID
正文
参数
响应输出

                                                            

                                                        
返回参数
检测手机
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
mobile string 手机号
id string 排除会员ID
正文
参数
响应输出

                                                            

                                                        
返回参数
检测手机
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
mobile string 手机号
正文
参数
响应输出

                                                            

                                                        
返回参数
检测邮箱
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
mobile string 邮箱
正文
参数
响应输出

                                                            

                                                        
返回参数
检测手机验证码
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
mobile string 手机号
captcha string 验证码
event string 事件
正文
参数
响应输出

                                                            

                                                        
返回参数
检测邮箱验证码
权限
登录
鉴权
Headers
参数
名称 类型 必填 描述
email string 邮箱
captcha string 验证码
event string 事件
正文
参数
响应输出

                                                            

                                                        
返回参数