AI+电商

首页接口

POST 首页配置 /api/index/get_index_config

获取首页配置数据

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必填	描述
project	string	否	项目,如:h5,occident,默认:h5
group	string	否	分组
force	boolean	否	是否强制刷新

正文

无

参数

追加

project

group

force

响应输出

返回参数

名称	类型	描述
code	integer
msg	string
data	array	数据列表

{
     *  "code": 1,
     *  "msg": "返回成功",
     *  "time": "1588888888",
     *  "data": {}
     * }

POST 顶部消息 /api/index/get_top_message

获首页取顶部消息滚动数据

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必填	描述
project	string	否	项目,如:h5,occident,默认:h5
force	boolean	否	是否强制刷新

正文

无

参数

追加

project

force

响应输出

返回参数

名称	类型	描述
code	integer
msg	string
data	array	数据列表

{
     *  "code": 1,
     *  "msg": "返回成功",
     *  "time": "1588888888",
     *  "data": {}
     * }

会员接口

POST 会员中心 /api/user/index

会员中心

权限

登录	是
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

名称	类型	描述
code	integer	返回操作编号，0：成功，大于0：警告信息，小于0：错误信息
msg	string	返回操作信息
data	object	返回数据

{
     *      'code':'0',
     *      'msg':'成功'
     *}

POST 会员登录 /api/user/login

会员登录

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必填	描述
account	string	是	账号
password	string	是	密码

正文

无

参数

追加

account

password

响应输出

返回参数

名称	类型	描述
code	integer	返回操作编号，0：成功，大于0：警告信息，小于0：错误信息
msg	string	返回操作信息
data	object	返回数据

{
     *      'code':'0',
     *      'msg':'登录成功'
     *}

POST 手机验证码登录 /api/user/mobilelogin

手机验证码登录

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必填	描述
mobile	string	是	手机号
captcha	string	是	验证码

正文

无

参数

追加

mobile

captcha

响应输出

返回参数

名称	类型	描述
code	integer	返回操作编号，0：成功，大于0：警告信息，小于0：错误信息
msg	string	返回操作信息
data	object	返回数据

{
     *      'code':'0',
     *      'msg':'登录成功'
     *}

POST 注册会员 /api/user/register

注册会员

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必填	描述
username	string	是	用户名
password	string	是	密码
email	string	是	邮箱
mobile	string	是	手机号
code	string	是	验证码

正文

无

参数

追加

username

password

mobile

code

响应输出

返回参数

名称	类型	描述
code	integer	返回操作编号，0：成功，大于0：警告信息，小于0：错误信息
msg	string	返回操作信息
data	object	返回数据

{
     *      'code':'0',
     *      'msg':'注册成功'
     *}

POST 退出登录 /api/user/logout

退出登录

权限

登录	是
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

名称	类型	描述
code	integer	返回操作编号，0：成功，大于0：警告信息，小于0：错误信息
msg	string	返回操作信息
data	object	返回数据

{
     *      'code':'0',
     *      'msg':'退出成功'
     *}

POST 注销账户 /api/user/writeoff

注销账户

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必填	描述
restore	int	是	是否恢复账号，默认0

正文

无

参数

追加

响应输出

返回参数

名称	类型	描述
code	integer	返回操作编号，0：成功，大于0：警告信息，小于0：错误信息
msg	string	返回操作信息
data	object	返回数据

{
     *      'code':'0',
     *      'msg':'退出成功'
     *}

POST 获取用户信息 /api/user/info

获取用户的简单信息

权限

登录	是
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

名称	类型	描述
code	integer	返回操作编号，0：成功，大于0：警告信息，小于0：错误信息
msg	string	返回操作信息
data	object	返回数据

{
     *      'code':'0',
     *      'msg':'获取成功'
     *}

POST 修改会员个人信息 /api/user/profile

修改会员个人信息

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必填	描述
avatar	string	是	头像地址
username	string	是	用户名
nickname	string	是	昵称
bio	string	是	个人简介

正文

无

参数

追加

avatar

username

nickname

bio

响应输出

返回参数

名称	类型	描述
code	integer	返回操作编号，0：成功，大于0：警告信息，小于0：错误信息
msg	string	返回操作信息
data	object	返回数据

{
     *      'code':'0',
     *      'msg':'修改成功'
     *}

POST 修改邮箱 /api/user/changeemail

修改邮箱

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必填	描述
email	string	是	邮箱
captcha	string	是	验证码

正文

无

参数

追加

captcha

响应输出

返回参数

名称	类型	描述
code	integer	返回操作编号，0：成功，大于0：警告信息，小于0：错误信息
msg	string	返回操作信息
data	object	返回数据

{
     *      'code':'0',
     *      'msg':'修改成功'
     *}

POST 修改手机号 /api/user/changemobile

修改手机号

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必填	描述
mobile	string	是	手机号
captcha	string	是	验证码

正文

无

参数

追加

mobile

captcha

响应输出

返回参数

名称	类型	描述
code	integer	返回操作编号，0：成功，大于0：警告信息，小于0：错误信息
msg	string	返回操作信息
data	object	返回数据

{
     *      'code':'0',
     *      'msg':'修改成功'
     *}

POST 第三方登录 /api/user/third

第三方登录

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必填	描述
platform	string	是	平台名称
code	string	是	Code

正文

无

参数

追加

platform

code

响应输出

返回参数

名称	类型	描述
code	integer	返回操作编号，0：成功，大于0：警告信息，小于0：错误信息
msg	string	返回操作信息
data	object	返回数据

{
     *      'code':'0',
     *      'msg':'登录成功'
     *}

POST 重置密码 /api/user/resetpwd

重置密码

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必填	描述
mobile	string	是	手机号
newpassword	string	是	新密码
captcha	string	是	验证码

正文

无

参数

追加

mobile

newpassword

captcha

响应输出

返回参数

名称	类型	描述
code	integer	返回操作编号，0：成功，大于0：警告信息，小于0：错误信息
msg	string	返回操作信息
data	object	返回数据

{
     *      'code':'0',
     *      'msg':'重置密码成功'
     *}

POST 购物车列表 /api/user/cartlist

购物车列表

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必填	描述
cart_ids	string	否	购物车ID列表,多个ID用逗号隔开
product_name	string	否	产品名称
page	integer	否	页码
page_size	integer	否	每页数量,默认20条

正文

无

参数

追加

cart_ids

product_name

page

page_size

响应输出

返回参数

名称	类型	描述
code	integer	返回操作编号，0：成功，大于0：警告信息，小于0：错误信息
msg	string	返回操作信息
data	object	返回数据

{
     *      'code':'0',
     *      'msg':'获取成功'
     *}

POST 保存购物车 /api/user/cartsave

保存购物车

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必填	描述
id	integer	否	购物车ID，修改时传入
product_id	integer	是	产品ID
quantity	integer	是	购买数量
spec_id	string	否	规格编号

正文

无

参数

追加

product_id

quantity

spec_id

响应输出

返回参数

名称	类型	描述
code	integer	返回操作编号，0：成功，大于0：警告信息，小于0：错误信息
msg	string	返回操作信息
data	object	返回数据

{
     *      'code':'0',
     *      'msg':'保存成功'
     *}

POST 删除购物车 /api/user/cartremove

删除购物车

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必填	描述
cart_ids	string	是	购物车产品ID集合，逗号分隔

正文

无

参数

追加

响应输出

返回参数

名称	类型	描述
code	integer	返回操作编号，0：成功，大于0：警告信息，小于0：错误信息
msg	string	返回操作信息
data	object	返回数据

{
     *      'code':'0',
     *      'msg':'删除成功'
     *}

POST 产品收藏 /api/user/favorite

收藏或取消收藏产品

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必填	描述
product_id	integer	是	产品ID
spec_id	integer	否	规格ID，默认0
is_favorite	integer	是	1为收藏 0为取消收藏

正文

无

参数

追加

product_id

spec_id

is_favorite

响应输出

返回参数

名称	类型	描述
code	integer	0
msg	string	返回信息
data	null	null

{"code":0,"msg":"收藏成功","data":null}

POST 收藏列表 /api/user/favorite_list

分页获取用户的收藏产品列表

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必填	描述
page	integer	否	页码
page_size	integer	否	每页数量，默认20
search	string	否	模糊搜索关键词

正文

无

参数

追加

page

page_size

响应输出

返回参数

名称	类型	描述
code	integer	0
msg	string	返回信息
data	object	包含分页信息的列表对象

{"code":0,"msg":"查询成功","data":{"total":1,"per_page":20,"current_page":1,"last_page":1,"data":[]}}

POST 浏览足迹 /api/user/browse

添加用户的产品浏览记录

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必填	描述
product_id	integer	是	产品ID

正文

无

参数

追加

响应输出

返回参数

名称	类型	描述
code	integer	0
msg	string	返回信息
data	null	null

{"code":0,"msg":"记录成功","data":null}

POST 浏览列表 /api/user/browse_list

分页获取用户的浏览产品记录

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必填	描述
page	integer	否	页码
page_size	integer	否	每页数量，默认20
search	string	否	模糊搜索关键词

正文

无

参数

追加

page

page_size

响应输出

返回参数

名称	类型	描述
code	integer	0
msg	string	返回信息
data	object	包含分页信息的列表对象

{"code":0,"msg":"查询成功","data":{"total":1,"per_page":20,"current_page":1,"last_page":1,"data":[]}}

POST 地址列表 /api/user/addresslist

获取用户收货地址列表

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必填	描述
select_id	integer	否	已选中地址ID，默认不传
page	integer	否	页码
page_size	integer	否	每页数量，默认20

正文

无

参数

追加

select_id

page

page_size

响应输出

返回参数

名称	类型	描述
code	integer	返回操作编号，0：成功，大于0：警告信息，小于0：错误信息
msg	string	返回操作信息
data	array	返回数据

{
     *      'code':'0',
     *      'msg':'获取成功'
     *}

POST 保存地址 /api/user/addresssave

新增或编辑收货地址

权限

登录	是
鉴权	否

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否

正文

无

参数

追加

name

mobile

province

city

region

town

address

default

响应输出

返回参数

名称	类型	描述
code	integer	返回操作编号，0：成功，大于0：警告信息，小于0：错误信息
msg	string	返回操作信息
data	object	返回数据

{
     *      'code':'0',
     *      'msg':'保存成功'
     *}

POST 获取默认地址 /api/user/getaddressdefault

获取默认收货地址

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必填	描述
id	integer	是	地址ID

正文

无

参数

追加

响应输出

返回参数

名称	类型	描述
code	integer	返回操作编号，0：成功，大于0：警告信息，小于0：错误信息
msg	string	返回操作信息
data	object	返回数据

{
     *      'code':'0',
     *      'msg':'删除成功'
     *}

POST 删除地址 /api/user/addressremove

删除收货地址

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必填	描述
id	integer	是	地址ID

正文

无

参数

追加

响应输出

返回参数

名称	类型	描述
code	integer	返回操作编号，0：成功，大于0：警告信息，小于0：错误信息
msg	string	返回操作信息
data	object	返回数据

{
     *      'code':'0',
     *      'msg':'删除成功'
     *}

Token接口

POST 检测Token /api/token/check

检测当前请求的Token是否过期

权限

登录	是
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

名称	类型	描述
code	integer	0
msg	string	返回信息
data	object	返回数据

{"code":0,"msg":"","data":{"token":"xxx","expires_in":2592000}}

POST 刷新Token /api/token/refresh

刷新当前请求的Token并返回新的Token信息

权限

登录	是
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

名称	类型	描述
code	integer	0
msg	string	返回信息
data	object	返回数据

{"code":0,"msg":"","data":{"token":"xxx","expires_in":2592000}}

手机短信接口

POST 发送短信验证码 /api/sms/send

向指定手机号发送短信验证码

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必填	描述
mobile	string	是	手机号
event	string	否	事件名称，默认register

正文

无

参数

追加

mobile

event

响应输出

返回参数

名称	类型	描述
code	integer	0
msg	string	返回信息
data	object	返回数据

{
     *      'code':'0',
     *      'msg':'发送成功'
     *}

POST 检测短信验证码 /api/sms/check

检测指定的手机号和验证码是否匹配

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必填	描述
mobile	string	是	手机号
event	string	否	事件名称，默认register
captcha	string	是	验证码

正文

无

参数

追加

mobile

event

captcha

响应输出

返回参数

名称	类型	描述
code	integer	0
msg	string	返回信息
data	object	返回数据

{
     *      'code':'0',
     *      'msg':'登录成功'
     *}

公共接口

POST 加载初始化 /api/common/init

加载初始化相关配置数据

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必填	描述
version	string	是	版本号
lng	string	是	经度
lat	string	是	纬度

正文

无

参数

追加

version

lng

lat

响应输出

返回参数

名称	类型	描述
code	integer
msg	string
data	array	数据列表

{
     *  "code": 1,
     *  "msg": "返回成功",
     *  "time": "1588888888",
     *  "data": {}
     * }

POST 上传文件 /api/common/upload

上传文件到服务器或云存储

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必填	描述
file	file	是	文件

正文

无

参数

追加

响应输出

返回参数

名称	类型	描述
code	integer
msg	string
data	array	数据列表

{
     *  "code": 1,
     *  "msg": "返回成功",
     *  "time": "1588888888",
     *  "data": {}
     * }

POST 发送短信验证码 /api/sms/send

获取图形验证码

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必填	描述
id	string	是	要生成验证码的标识

正文

无

参数

追加

响应输出

返回参数

名称	类型	描述
code	integer
msg	string
data	array	数据列表

{
     *      'code':'0',
     *      'msg':'发送成功'
     *}

POST 检测短信验证码 /api/sms/check

根据父级ID获取地区列表

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必填	描述
pid	integer	否	父级ID
ids	string	否	地区ID集合(逗号分隔

正文

无

参数

追加

pid

ids

响应输出

返回参数

名称	类型	描述
code	integer
msg	string
data	array	数据列表

{
     *      'code':'0',
     *      'msg':'登录成功'
     *}

邮箱验证码接口

POST 发送邮箱验证码 /api/ems/send

向指定邮箱发送验证码

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必填	描述
email	string	是	邮箱
event	string	否	事件名称，默认register

正文

无

参数

追加

event

响应输出

返回参数

名称	类型	描述
code	integer	0
msg	string	返回信息
data	object	返回数据

{"code":0,"msg":"发送成功","data":null}

POST 检测邮箱验证码 /api/ems/check

检测指定的邮箱和验证码是否匹配

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必填	描述
email	string	是	邮箱
event	string	否	事件名称，默认register
captcha	string	是	验证码

正文

无

参数

追加

event

captcha

响应输出

返回参数

名称	类型	描述
code	integer	0
msg	string	返回信息
data	object	返回数据

{
     *      'code':'0',
     *      'msg':'成功'
     *}

产品接口

POST 产品分类 /api/product/categorys

获取产品分类列表

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必填	描述
recommend	integer	否	是否推荐 1是 0否

正文

无

参数

追加

响应输出

返回参数

名称	类型	描述
code	integer	0
msg	string	返回成功信息
data	array	分类列表

{"code":0,"msg":"获取成功","data":[]}

POST 产品列表 /api/product/lists

获取产品数据列表

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必填	描述
page	integer	否	页码
page_size	integer	否	每页数量，默认20
category_id	integer	否	产品分类ID
category_key	string	否	产品分类英文key，多个用英文逗号分隔，如 clothing、shoes,bag
is_hot	integer	否	是否热门 1是 0否
is_recommend	integer	否	是否推荐 1是 0否
search	string	否	模糊搜索关键词
price	string	否	价格范围，如:10-20,表示价格在10-20之间,横杠前后为0时表示不限制价格范围
orders	array	否	排序参数，如orders[sale]=desc

正文

无

参数

追加

page

page_size

category_id

category_key

is_hot

is_recommend

price

orders

响应输出

返回参数

名称	类型	描述
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":[]}}

POST 产品详情 /api/product/info

根据产品ID获取产品信息

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必填	描述
product_id	integer	是	产品ID
hot_data_id	integer	是	选品数据ID

正文

无

参数

追加

product_id

hot_data_id

响应输出

返回参数

名称	类型	描述
code	integer	0
msg	string	返回信息
data	object	产品详情数据

{"code":0,"msg":"获取成功","data":{"id":1,"name":"产品名称","attrs":[],"specs":[]}}

POST 产品规格 /api/product/get_specs

根据用户选择的属性集合获取对应的规格集合

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必填	描述
product_id	integer	是	产品ID
attr_ids	string	否	属性ID集合，逗号分隔
buy_num	integer	否	购买数量，默认1
date	string	否	日期

正文

无

参数

追加

product_id

attr_ids

buy_num

date

响应输出

返回参数

名称	类型	描述
code	integer	0
msg	string	返回信息
data	array	匹配到的规格列表

{"code":0,"msg":"获取成功","data":[]}

POST 计算价格 /api/product/calc_price

根据用户选择产品规格等计算价格

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必填	描述
product_id	integer	是	产品ID
spec_id	integer	是	规格ID
date	string	否	日期
quantity	integer	否	购买数量，默认1

正文

无

参数

追加

product_id

spec_id

date

quantity

响应输出

返回参数

名称	类型	描述
code	integer	0
msg	string	返回信息
data	string	计算后的价格

{"code":0,"msg":"","data":"100.00"}

POST 随机产品 /api/product/randoms

分页获取随机产品列表

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必填	描述
category_id	string	否	分类ID，逗号分隔
except_product_ids	string	否	排除的产品ID，逗号分隔
request_session	string	否	请求会话ID
page	integer	否	页码
page_size	integer	否	每页数量，默认20

正文

无

参数

追加

category_id

except_product_ids

request_session

page

page_size

响应输出

返回参数

名称	类型	描述
code	integer	0
msg	string	返回信息
data	object	包含分页信息的列表对象

{"code":0,"msg":"查询成功","data":{"total":1,"per_page":20,"current_page":1,"last_page":1,"data":[]}}

POST 产品推荐 /api/product/recommends

分页获取推荐产品列表，依据今日爆款分类与产品推荐

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必填	描述
request_session	string	否	请求会话ID
except_product_ids	string	否	排除的产品ID，逗号分隔
page	integer	否	页码
page_size	integer	否	每页数量，默认20

正文

无

参数

追加

request_session

except_product_ids

page

page_size

响应输出

返回参数

名称	类型	描述
code	integer	0
msg	string	返回信息
data	object	包含分页信息的列表对象

{"code":0,"msg":"查询成功","data":{"total":1,"per_page":20,"current_page":1,"last_page":1,"data":[]}}

POST 猜你喜欢 /api/product/likes

分页获取猜你喜欢产品列表，依据用户习惯以及收藏、浏览足迹等进行推荐

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必填	描述
request_session	string	否	请求会话ID
except_product_ids	string	否	排除的产品ID，逗号分隔
page	integer	否	页码
page_size	integer	否	每页数量，默认20

正文

无

参数

追加

request_session

except_product_ids

page

page_size

响应输出

返回参数

名称	类型	描述
code	integer	0
msg	string	返回信息
data	object	包含分页信息的列表对象

{"code":0,"msg":"查询成功","data":{"total":1,"per_page":20,"current_page":1,"last_page":1,"data":[]}}

POST AI选品 /api/product/requirements

根据获取AI选品信息

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必填	描述
requirements	string	是	需求描述

正文

无

参数

追加

响应输出

返回参数

名称	类型	描述
code	integer	0
msg	string	返回信息
data	object	AI选品信息对象

{"code":0,"msg":"获取成功","data":{}}

POST 选品结果 /api/product/get_requirements_products

根据获取AI选品信息获取对应产品结果

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必填	描述
page	integer	否	页码
page_size	integer	否	每页数量，默认20

正文

无

参数

追加

page

page_size

响应输出

返回参数

名称	类型	描述
code	integer	0
msg	string	返回信息
data	object	选品产品列表数据

{"code":0,"msg":"获取成功","data":[]}

POST 选品历史 /api/product/get_requirements_history

根据获取AI选品信息获取对应历史需求

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必填	描述
page	integer	否	页码
page_size	integer	否	每页数量，默认20

正文

无

参数

追加

page

page_size

响应输出

返回参数

名称	类型	描述
code	integer	0
msg	string	返回信息
data	object	选品产品列表数据

{"code":0,"msg":"获取成功","data":[]}

POST 产品转换 /api/product/change_requirements_product

根据获取AI选品信息转换对应产品

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必填	描述
hot_data_id	integer	是	选品数据ID

正文

无

参数

追加

响应输出

返回参数

名称	类型	描述
code	integer	0
msg	string	返回信息
data	object	选品产品列表数据

{"code":0,"msg":"获取成功","data":[]}

订单接口

POST 订单预算 /api/order/budget

创建订单预算

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必填	描述
cart_ids	string	是	购物车ID列表,英文逗号分类的ID字符串

正文

无

参数

追加

响应输出

返回参数

名称	类型	描述
code	integer	0
msg	string	返回成功信息
data	array	订单预算信息

{"code":0,"msg":"创建成功","data":{}}

POST 创建订单 /api/order/create

创建新订单

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必填	描述
cart_ids	string	是	购物车ID列表,英文逗号分类的ID字符串
receiver_id	string	是	收件人ID
pay_type	string	是	支付类型

正文

无

参数

追加

cart_ids

receiver_id

pay_type

响应输出

返回参数

名称	类型	描述
code	integer	0
msg	string	返回成功信息
data	array	订单信息

{"code":0,"msg":"创建成功","data":{}}

POST 支付类型 /api/order/paytype

获取支付类型列表

权限

登录	是
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

名称	类型	描述
code	integer	0
msg	string	返回成功信息
data	array	支付类型列表

{"code":0,"msg":"成功","data":{}}

POST 订单支付 /api/order/pay

发起订单支付

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必填	描述
order_id	string	是	订单ID

正文

无

参数

追加

响应输出

返回参数

名称	类型	描述
code	integer	0
msg	string	返回成功信息
data	array	支付参数

{"code":0,"msg":"成功","data":{}}

POST 微信支付回调 /api/order/wxpay_notify

微信支付异步通知

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

POST 支付宝回调 /api/order/alipay_notify

支付宝异步通知

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

POST 状态统计 /api/order/stats

获取用户订单状态统计

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必填	描述
group	string	否	订单分组
search	string	否	搜索订单
page	string	否	页码
page_size	string	否	每页数量

正文

无

参数

追加

group

page

page_size

响应输出

返回参数

名称	类型	描述
code	integer	0
msg	string	返回成功信息
data	array	订单列表数据

{"code":0,"msg":"成功","data":{}}

POST 订单列表 /api/order/lists

获取用户订单列表

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必填	描述
group	string	否	订单分组
search	string	否	搜索订单
page	string	否	页码
page_size	string	否	每页数量

正文

无

参数

追加

group

page

page_size

响应输出

返回参数

名称	类型	描述
code	integer	0
msg	string	返回成功信息
data	array	订单列表数据

{"code":0,"msg":"成功","data":{}}

POST 订单详情 /api/order/detail

获取订单详细信息

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必填	描述
order_id	string	是	订单ID

正文

无

参数

追加

响应输出

返回参数

名称	类型	描述
code	integer	0
msg	string	返回成功信息
data	array	订单详情数据

{"code":0,"msg":"成功","data":{}}

POST 取消订单 /api/order/cancel

用户主动取消订单

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必填	描述
order_id	string	是	订单ID

正文

无

参数

追加

响应输出

返回参数

名称	类型	描述
code	integer	0
msg	string	返回成功信息
data	array	返回数据

{"code":0,"msg":"取消成功","data":{}}

POST 删除订单 /api/order/delete

用户主动删除订单

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必填	描述
order_id	string	是	订单ID

正文

无

参数

追加

响应输出

返回参数

名称	类型	描述
code	integer	0
msg	string	返回成功信息
data	array	返回数据

{"code":0,"msg":"取消成功","data":{}}

POST 订单退款 /api/order/refund

用户申请订单退款

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必填	描述
order_id	string	是	订单ID
order_items	string	是	订单商品列表,格式为JSON字符串,例如: [{'id':1,'quantity':1,'remark':'退款原因'}]

正文

无

参数

追加

order_id

order_items

响应输出

返回参数

名称	类型	描述
code	integer	0
msg	string	返回成功信息
data	array	返回数据

{"code":0,"msg":"申请退款成功","data":{}}

POST 微信退款回调 /api/order/wxpay_refund_notify

微信退款异步通知

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

POST 支付宝退款回调 /api/order/alipay_refund_notify

支付宝退款异步通知

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

微信接口

GET 获取微信授权链接 /api/wxchat/oauth

获取微信OAuth2.0授权链接，用于在微信浏览器中获取openId

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必填	描述
redirect_uri	string	否	授权成功后的回调地址
scope	string	否	授权类型，snsapi_base或snsapi_userinfo，默认snsapi_base

正文

无

参数

追加

redirect_uri

scope

响应输出

返回参数

名称	类型	描述
code	integer	返回操作编号，0：成功，大于0：警告信息，小于0：错误信息
msg	string	返回操作信息
data	object	返回数据

{
     *      'code':'0',
     *      'msg':'成功',
     *      'data':{'auth_url':'https://open.weixin.qq.com/connect/oauth2/authorize?...'}
     * }

GET 微信OAuth回调 /api/wxchat/callback

微信OAuth2.0授权回调接口，支持 snsapi_base 和 snsapi_userinfo

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必填	描述
code	string	是	微信返回的授权码
state	string	是	状态码

正文

无

参数

追加

code

state

响应输出

返回参数

名称	类型	描述
code	integer	返回操作编号，0：成功，大于0：警告信息，小于0：错误信息
msg	string	返回操作信息
data	object	返回数据

{
     *      'code':'0',
     *      'msg':'成功',
     *      'data':{'openid':'xxx','access_token':'xxx','scope':'snsapi_base'}
     * }

POST 获取当前用户openId /api/wxchat/get_openid

获取当前用户的微信openId

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

名称	类型	描述
code	integer	返回操作编号，0：成功，大于0：警告信息，小于0：错误信息
msg	string	返回操作信息
data	object	返回数据

{
     *      'code':'0',
     *      'msg':'成功',
     *      'data':{'openid':'xxx'}
     * }

POST 获取微信绑定信息 /api/wxchat/get_user_wxchat

获取当前登录用户的微信绑定信息，用于前端判断是否已绑定

权限

登录	是
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

名称	类型	描述
code	integer	返回操作编号，0：成功，大于0：警告信息，小于0：错误信息
msg	string	返回操作信息
data	object	返回数据，未绑定时为null

{
     *      'code':'0',
     *      'msg':'成功',
     *      'data':{'openid':'xxx','nickname':'微信昵称','headimgurl':'https://xxx','unionid':'xxx'}
     * }

POST 绑定微信用户信息 /api/wxchat/bind_userinfo

将微信用户信息绑定到当前登录账号，已绑定则更新

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必填	描述
openid	string	是	微信openid
nickname	string	是	微信昵称
headimgurl	string	是	微信头像链接
unionid	string	否	微信unionid

正文

无

参数

追加

openid

nickname

headimgurl

unionid

响应输出

返回参数

名称	类型	描述
code	integer	返回操作编号，0：成功，大于0：警告信息，小于0：错误信息
msg	string	返回操作信息
data	object	返回数据

{
     *      'code':'0',
     *      'msg':'绑定成功',
     *      'data':{'id':1,'user_id':100,'openid':'xxx','nickname':'微信昵称','headimgurl':'https://xxx'}
     * }