[bhpyg] Thinkphp5 品优购商城后台Restful接口文档

1. 域名

http://adminapi.xxx.com

其中，子域名必须为adminapi, xxx为自己配置的主域名

2.请求参数

请求参数 请以 “接口地址?参数名=参数值&参数名=参数值” 方式传递。

3.返回格式

所有 response 都固定的格式：{code: 200, msg: "success", data: []}

必有 code, msg, data 三个字段

code: 状态码。 200表示成功，3xx表示重定向，4xx表示请求错误，5xx表示服务器内部错误.

msg: 错误信息

data: 返回的具体数据。

下面所列出的接口 response 指 data 字段

4.列表数据

1.后端分页

返回数据中包含以下字段，表示支持后端分页功能

“total”: “总记录数”,
“per_page”: “每页显示数”,
“current_page”: “当前页码”,
“last_page”: “最大页码”,

请求参数中 传递page参数 获取指定页码数据，如page=2 获取第2页数据

2.列表数据结构

数据涉及到上下级关系的，分为以下三种数据结构：

普通列表结构list

[
	{"id":1,"pid":0, ...},
	{"id":2,"pid":0, ...},
	{"id":3,"pid":1, ...},
	{"id":4,"pid":2, ...},
]

无限级分类列表结构tree_list

[
	{"id":1,"pid":0, ...},//第一个一级
	{"id":3,"pid":1, ...},//第一个一级下的二级
	{"id":2,"pid":0, ...},//第二个一级
	{"id":4,"pid":2, ...},//第二个一级下的二级
]

父子级树状结构tree

[
	//第一个一级
	{"id":1,"pid":0, ... , "son":[ 
		//son字段下 是当前数据下的所有子级列表
		{"id":3,"pid":1, ... , "son":[]}
	] },
	//第二个一级
	{"id":2,"pid":0, ... , "son":[
		{"id":4,"pid":2, ..., "son":[]},
	]}
]

5.登录token认证

所有接口中，请求地址下方，若注明 “需进行token认证”，则需要在请求头信息中设置：
Authorization: 登录token值

其中，登录token值，由登录接口获取

接口目录

1.图片验证码接口

2.登录接口

3.退出接口

4.管理员 列表、详情、新增、修改、删除接口

5.角色 列表、详情、新增、修改、删除接口

6.权限 列表、详情、新增、修改、删除接口

7.菜单权限接口

8.商品分类 列表、详情、新增、修改、删除接口

9.logo图片上传接口

10.商品品牌 列表、详情、新增、修改、删除接口

11.商品模型 列表、详情、新增、修改、删除接口

12.多图上传接口

13.商品列表、详情、新增、修改、删除接口

14.商品修改页面 业务接口

15.相册图片删除接口

16.订单 列表、详情接口

一、登录相关

1.1、图片验证码接口

1、请求地址

GET /captcha

获取图片验证码图片地址

示例： http://adminapi.tbyue.com/captcha

2、请求参数

无

3、返回数据

返回数据

名称	备注
url	图片地址
uniqid	验证码编号

4、返回示例

{
	"url":"http:\/\/adminapi.tbyue.com\/captcha\/captcha_5cf48283ef31d.html",
    "uniqid":"captcha_5cf48283ef31d"
}

1.2、登录接口

1、请求地址

POST /login

用于根据用户名、密码进行登录

示例： http://api.tbyue.com/login

2、请求参数

名称	类型	必填	备注
username	string	是	用户名:admin
password	string	是	密码:123456
code	string	是	验证码
uniqid	string	是	验证码标识

3、返回数据

名称	备注
token	token令牌
user_id	用户id
username	用户名
nickname	用户昵称
email	用户邮箱

4、返回示例

{
        "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImp0aSI6IjNmMmc1N2E5MmFhIn0.eyJpYXQiOjE1NTk1Mjk1MjksImlzcyI6Imh0dHA6XC9cL3d3dy5weWcuY29tIiwiYXVkIjoiaHR0cDpcL1wvd3d3LnB5Zy5jb20iLCJuYmYiOjE1NTk1Mjk1MjgsImV4cCI6MTU1OTUzMzEyOSwianRpIjoiM2YyZzU3YTkyYWEiLCJ1c2VyX2lkIjoxfQ.4BaThL6_TbIMBGLIWZgpnoDQ-JlAjzbiK3y3BcvNiGI",
        "user_id": 1,
        "username": "admin",
        "nickname": "admin",
        "email": "[email protected]"
    }

1.3、退出接口

1、请求地址

GET /logout

需进行token认证

示例： http://adminapi.tbyue.com/logout

2、请求参数

无

3、返回数据

无

4、返回示例

无

二、管理员

2.1、管理员列表

1、请求地址

GET /admins

需进行token认证

示例： http://adminapi.tbyue.com/admins

2、请求参数

名称	类型	必填	备注
keyword	string	否	搜索关键字
page	int	否	页码，默认1

3、返回数据

名称	备注
total	总数量
per_page	每页显示数
current_page	当前页码
last_page	总页数
data	数据集

–其中：data数据集

名称	备注
id	用户id
username	用户名
email	邮箱
nickname	昵称
last_login_time	上次登录时间
status	是否可用 1 可用；2 禁用
role_name	所属角色名称

4、返回示例

{
        "total": 7,
        "per_page": 10,
        "current_page": 1,
        "last_page": 1,
        "data": [
            {
                "id": 1,
                "username": "admin",
                "email": "[email protected]",
                "nickname": "admin",
                "last_login_time": "2018-03-07 15:42:27",
                "status": 1,
                "role_name": "超级管理员"
            },
            {
                "id": 2,
                "username": "sunquan",
                "email": "[email protected]",
                "nickname": "骑鱼的猫",
                "last_login_time": "1970-01-01 08:00:00",
                "status": 1,
                "role_name": "主管"
            }
        ]
}

2.2、管理员详情

1、请求地址

GET /admins/[:id]

需进行token认证

[:id] 为管理员用户id

示例： http://adminapi.tbyue.com/admins/1

2、请求参数

无

3、返回数据

名称	备注
id	用户id
username	用户名
email	邮箱
nickname	昵称
last_login_time	上次登录时间
status	是否可用 1 可用；2 禁用
role_id	所属角色id

4、返回示例

{
        "id": 1,
        "username": "admin",
        "email": "[email protected]",
        "nickname": "admin",
        "last_login_time": "2018-03-07 15:42:27",
        "status": 1,
        "role_id": 1
    }

2.3、管理员新增

1、请求地址

POST /admins

需进行token认证

示例： http://adminapi.tbyue.com/admins

2、请求参数

名称	类型	必填	备注
username	string	是	用户名
email	string	是	邮箱
role_id	string	是	所属角色id
password	string	否	密码，初始密码123456

3、返回数据

名称	备注
id	用户id
username	用户名
email	邮箱
nickname	昵称
last_login_time	上次登录时间
status	是否可用 1 可用；2 禁用
role_id	所属角色id

4、返回示例

{
        "id": 1,
        "username": "admin",
        "email": "[email protected]",
        "nickname": "admin",
        "last_login_time": "2018-03-07 15:42:27",
        "status": 1,
        "role_id": 1
    }

2.4、管理员修改

1、请求地址

PUT /admins/[:id]

需进行token认证

[:id] 为管理员id

示例： http://adminapi.tbyue.com/admins/2

2、请求参数

重置密码：

名称	类型	必填	备注
type	string	是	reset_pwd 重置密码

修改其他信息

名称	类型	必填	备注
nickname	string	否	昵称
email	string	否	邮箱
role_id	string	否	所属角色id

3、返回数据

名称	备注
id	用户id
username	用户名
email	邮箱
nickname	昵称
last_login_time	上次登录时间
status	是否可用 1 可用；2 禁用
role_id	所属角色id

4、返回示例

	{
        "id": 1,
        "username": "admin",
        "email": "[email protected]",
        "nickname": "admin",
        "last_login_time": "2018-03-07 15:42:27",
        "status": 1,
        "role_id": 1
    }

2.5、管理员删除

1、请求地址

DELETE /admins/[:id]

需进行token认证

[:id] 为管理员id

示例： http://adminapi.tbyue.com/admins/2

2、请求参数

无

3、返回数据

无

4、返回示例

无

三、角色

3.1、角色列表

1、请求地址

GET /roles

需进行token认证

示例： http://adminapi.tbyue.com/roles

2、请求参数

无

3、返回数据

返回数据集[{},{},…]

名称	备注
id	角色id
role_name	角色名称
desc	描述
role_auths	角色下的权限集合，父子级树状列表

4、返回示例

[
        {
            "id": 1,
            "role_name": "超级管理员",
            "desc": null,
            "role_auths":[
                {id: 1, auth_name: "首页", pid: 0, pid_path: "0", son: [...]},
                ...
            ]
        },
        {
            "id": 2,
            "role_name": "主管",
            "desc": null,
            "role_auths":[
                {id: 1, auth_name: "首页", pid: 0, pid_path: "0", son: [...]},
                ...
            ]
        },
]

3.2、角色详情

1、请求地址

GET /roles/[:id]

需进行token认证

[:id] 为角色id

示例： http://adminapi.tbyue.com/roles/1

2、请求参数

无

3、返回数据

名称	备注
id	角色id
role_name	角色名称
desc	描述
role_auth_ids	拥有的权限ids

4、返回示例

{
    "id": 2,
    "role_name": "主管",
    "desc": null,
    "role_auth_ids":"1,2,3,4,5,8"
}

3.3、角色新增

1、请求地址

POST /roles

需进行token认证

示例： http://adminapi.tbyue.com/roles

2、请求参数

名称	类型	必填	备注
role_name	string	是	角色名
desc	string	否	描述
auth_ids	string	是	拥有的权限ids，示例：’1,3,4‘

3、返回数据

名称	备注
id	角色id
role_name	角色名称
desc	描述
role_auth_ids	拥有的权限ids

4、返回示例

{
    "id": 2,
    "role_name": "主管",
    "desc": null,
    "role_auth_ids":"1,2,3,4,5,8"
}

3.4、角色修改

1、请求地址

PUT /roles/[:id]

需进行token认证

[:id] 为角色id

示例： http://adminapi.tbyue.com/roles/2

2、请求参数

名称	类型	必填	备注
role_name	string	是	角色名
desc	string	否	描述
auth_ids	string	是	拥有的权限ids，示例：’1,3,4‘

3、返回数据

名称	备注
id	角色id
role_name	角色名称
desc	描述
role_auth_ids	拥有的权限ids

4、返回示例

{
    "id": 2,
    "role_name": "主管",
    "desc": null,
    "role_auth_ids":"1,2,3,4,5,8"
}

3.5、角色删除

1、请求地址

DELETE /roles/[:id]

需进行token认证

[:id] 为角色id

示例： http://adminapi.tbyue.com/roles/2

2、请求参数

无

3、返回数据

无

4、返回示例

无

四、权限

4.1、权限列表1

1、请求地址

GET /auths

需进行token认证

用于列表页、新增页、修改页展示，返回 无限级分类 列表结构数据

示例： http://adminapi.tbyue.com/auths

2、请求参数

无

3、返回数据

返回数据集[{},{},…]

名称	备注
id	权限id
auth_name	权限名称
pid	父id
pid_path	家族图谱（祖先id_父id）,示例：0_1_2
auth_c	控制器名称
auth_a	方法名称
is_nav	是否菜单权限 1是 0否
level	级别 0 1 2 3 ， 0为最顶级

4、返回示例

[
        {
            "id": 10,
            "auth_name": "菜单管理",
            "pid": 5,
            "pid_path": "0_2_5",
            "auth_c": "auth",
            "auth_a": "index",
            "is_nav": "1",
            "level": 2
        },
        {
            "id": 65,
            "auth_name": "添加权限",
            "pid": 10,
            "pid_path": "0_2_5_10",
            "auth_c": "auth",
            "auth_a": "create",
            "is_nav": "0",
            "level": 3
        }
]

4.2、权限列表2

1、请求地址

GET /auths

需进行token认证

用于给角色分配权限，返回 父子级 树状结构数据

示例： http://adminapi.tbyue.com/auths

2、请求参数

名称	类型	必填	备注
type	string	是	tree

3、返回数据

返回数据集[{},{},…]

树状结构，每个权限中有son字段，包含其所有子权限

名称	备注
id	权限id
auth_name	权限名称
pid	父id
pid_path	家族图谱（祖先id_父id）,示例：0_1_2
auth_c	控制器名称
auth_a	方法名称
is_nav	是否菜单权限 1是 0否
level	级别 0 1 2 3 ， 0为最顶级
son	子权限数据集

4、返回示例

[
        {
            "id": 1,
            "auth_name": "首页",
            "pid": 0,
            "pid_path": "0",
            "auth_c": "",
            "auth_a": "",
            "is_nav": "是",
            "level": 0,
            "son": [
                {
                    "id": 90,
                    "auth_name": "首页",
                    "pid": 1,
                    "pid_path": "0_1",
                    "auth_c": "",
                    "auth_a": "",
                    "is_nav": "是",
                    "level": 1,
                    "son": [
                        {
                            "id": 91,
                            "auth_name": "首页",
                            "pid": 90,
                            "pid_path": "0_1_90",
                            "auth_c": "index",
                            "auth_a": "index",
                            "is_nav": "是",
                            "level": 2,
                            "son": []
                        }
                    ]
                }
            ]
        },
        {
            "id": 2,
            "auth_name": "平台",
            "pid": 0,
            "pid_path": "0",
            "auth_c": "",
            "auth_a": "",
            "is_nav": "是",
            "level": 0,
            "son": [
                {
                    "id": 5,
                    "auth_name": "系统配置",
                    "pid": 2,
                    "pid_path": "0_2",
                    "auth_c": "",
                    "auth_a": "",
                    "is_nav": "是",
                    "level": 1,
                    "son": [
                        {
                            "id": 9,
                            "auth_name": "附件管理",
                            "pid": 5,
                            "pid_path": "0_2_5",
                            "auth_c": "",
                            "auth_a": "",
                            "is_nav": "是",
                            "level": 2,
                            "son": []
                        },
                        {
                            "id": 10,
                            "auth_name": "菜单管理",
                            "pid": 5,
                            "pid_path": "0_2_5",
                            "auth_c": "auth",
                            "auth_a": "index",
                            "is_nav": "是",
                            "level": 2,
                            "son": []
                        }
                    ]
                },
                {
                    "id": 6,
                    "auth_name": "权限管理",
                    "pid": 2,
                    "pid_path": "0_2",
                    "auth_c": "",
                    "auth_a": "",
                    "is_nav": "是",
                    "level": 1,
                    "son": [
                        {
                            "id": 11,
                            "auth_name": "管理员管理",
                            "pid": 6,
                            "pid_path": "0_2_6",
                            "auth_c": "admin",
                            "auth_a": "index",
                            "is_nav": "是",
                            "level": 2,
                            "son": []
                        },
                        {
                            "id": 12,
                            "auth_name": "角色管理",
                            "pid": 6,
                            "pid_path": "0_2_6",
                            "auth_c": "role",
                            "auth_a": "index",
                            "is_nav": "是",
                            "level": 2,
                            "son": []
                        }
                    ]
                }
            ]
        },
]

4.3、权限详情

1、请求地址

GET /auths/[:id]

需进行token认证

[:id] 为权限id

示例： http://adminapi.tbyue.com/auths/1

2、请求参数

无

3、返回数据

名称	备注
id	权限id
auth_name	权限名称
pid	父id
pid_path	家族图谱（祖先id_父id）,示例：0_1_2
auth_c	控制器名称
auth_a	方法名称
is_nav	是否菜单权限 1是 0否
level	级别 0 1 2 3 ， 0为最顶级

4、返回示例

{
    "id": 65,
    "auth_name": "添加权限",
    "pid": 10,
    "pid_path": "0_2_5_10",
    "auth_c": "auth",
    "auth_a": "create",
    "is_nav": 0,
    "level": 3
}

4.4、权限新增

1、请求地址

POST /auths

需进行token认证

示例： http://adminapi.tbyue.com/auths

2、请求参数

名称	类型	必填	备注
auth_name	string	是	权限名
pid	int	是	父级权限id
auth_c	string	否	控制器名
auth_a	string	否	方法名
is_nav	int	是	是否菜单权限 1是 0否

3、返回数据

名称	备注
id	权限id
auth_name	权限名称
pid	父id
pid_path	家族图谱（祖先id_父id）,示例：0_1_2
auth_c	控制器名称
auth_a	方法名称
is_nav	是否菜单权限 1是 0否
level	级别 0 1 2 3 ， 0为最顶级

4、返回示例

{
    "id": 65,
    "auth_name": "添加权限",
    "pid": 10,
    "pid_path": "0_2_5_10",
    "auth_c": "auth",
    "auth_a": "create",
    "is_nav": 0,
    "level": 3
}

4.5、权限修改

1、请求地址

PUT /auths/[:id]

需进行token认证

[:id] 为权限id

示例： http://adminapi.tbyue.com/auths/2

2、请求参数

名称	类型	必填	备注
auth_name	string	是	权限名
pid	int	是	父级权限id
auth_c	string	否	控制器名
auth_a	string	否	方法名
is_nav	int	是	是否菜单权限 1是 0否

3、返回数据

名称	备注
id	权限id
auth_name	权限名称
pid	父id
pid_path	家族图谱（祖先id_父id）,示例：0_1_2
auth_c	控制器名称
auth_a	方法名称
is_nav	是否菜单权限 1是 0否
level	级别 0 1 2 3 ， 0为最顶级

4、返回示例

{
    "id": 65,
    "auth_name": "添加权限",
    "pid": 10,
    "pid_path": "0_2_5_10",
    "auth_c": "auth",
    "auth_a": "create",
    "is_nav": 0,
    "level": 3
}

4.6、权限删除

1、请求地址

DELETE /auths/[:id]

需进行token认证

[:id] 为权限id

示例： http://adminapi.tbyue.com/auths/2

2、请求参数

无

3、返回数据

无

4、返回示例

无

4.7 获取菜单权限

1、请求地址

GET /nav

需进行token认证

示例： http://adminapi.tbyue.com/nav

2、请求参数

无

3、返回数据

返回父子级树状结构 数据集[{},{},…]

名称	备注
id	权限id
auth_name	权限名称
pid	父id
pid_path	家族图谱（祖先id_父id）,示例：0_1_2
auth_c	控制器名称
auth_a	方法名称
is_nav	是否菜单权限 1是 0否
level	级别 0 1 2 3 ， 0为最顶级
son	子权限数据集

4、返回示例

[
        {
            "id": 1,
            "auth_name": "首页",
            "pid": 0,
            "pid_path": "0",
            "auth_c": "",
            "auth_a": "",
            "is_nav": "是",
            "level": 0,
            "son": [
                {
                    "id": 90,
                    "auth_name": "首页",
                    "pid": 1,
                    "pid_path": "0_1",
                    "auth_c": "",
                    "auth_a": "",
                    "is_nav": "是",
                    "level": 1,
                    "son": [
                        {
                            "id": 91,
                            "auth_name": "首页",
                            "pid": 90,
                            "pid_path": "0_1_90",
                            "auth_c": "index",
                            "auth_a": "index",
                            "is_nav": "是",
                            "level": 2,
                            "son": []
                        }
                    ]
                }
            ]
        },
        {
            "id": 2,
            "auth_name": "平台",
            "pid": 0,
            "pid_path": "0",
            "auth_c": "",
            "auth_a": "",
            "is_nav": "是",
            "level": 0,
            "son": [
                {
                    "id": 5,
                    "auth_name": "系统配置",
                    "pid": 2,
                    "pid_path": "0_2",
                    "auth_c": "",
                    "auth_a": "",
                    "is_nav": "是",
                    "level": 1,
                    "son": [
                        {
                            "id": 9,
                            "auth_name": "附件管理",
                            "pid": 5,
                            "pid_path": "0_2_5",
                            "auth_c": "",
                            "auth_a": "",
                            "is_nav": "是",
                            "level": 2,
                            "son": []
                        },
                        {
                            "id": 10,
                            "auth_name": "菜单管理",
                            "pid": 5,
                            "pid_path": "0_2_5",
                            "auth_c": "auth",
                            "auth_a": "index",
                            "is_nav": "是",
                            "level": 2,
                            "son": []
                        }
                    ]
                },
                {
                    "id": 6,
                    "auth_name": "权限管理",
                    "pid": 2,
                    "pid_path": "0_2",
                    "auth_c": "",
                    "auth_a": "",
                    "is_nav": "是",
                    "level": 1,
                    "son": [
                        {
                            "id": 11,
                            "auth_name": "管理员管理",
                            "pid": 6,
                            "pid_path": "0_2_6",
                            "auth_c": "admin",
                            "auth_a": "index",
                            "is_nav": "是",
                            "level": 2,
                            "son": []
                        },
                        {
                            "id": 12,
                            "auth_name": "角色管理",
                            "pid": 6,
                            "pid_path": "0_2_6",
                            "auth_c": "role",
                            "auth_a": "index",
                            "is_nav": "是",
                            "level": 2,
                            "son": []
                        }
                    ]
                }
            ]
        },
]

五、商品分类

5.1、分类列表1

1、请求地址

GET /categorys

需进行token认证

用于列表页、新增页、修改页展示，返回 无限级分类 列表结构数据

示例： http://adminapi.tbyue.com/categorys

2、请求参数

无

3、返回数据

返回数据集[{},{},…]

名称	备注
id	分类id
cate_name	分类名称
pid	父id
pid_path_name	家族图谱名称(祖先名/父级名)
level	级别 0 1 2 ， 0为最顶级
is_show	是否显示
is_hot	是否热门
image_url	分类logo图片

4、返回示例

[
        {
            "id": 1,
            "cate_name": "家用电器",
            "pid": 0,
            "pid_path_name": "",
            "level": 0,
            "is_show": "是",
            "image_url": "",
            "is_hot": "否"
        },
        {
            "id": 16,
            "cate_name": "电视",
            "pid": 1,
            "pid_path_name": "家用电器",
            "level": 1,
            "is_show": "是",
            "image_url": "",
            "is_hot": "否"
        }
]

5.2、分类列表2

1、请求地址

GET /categorys

需进行token认证

用于三级联动 获取子分类

示例： http://adminapi.tbyue.com/categorys

2、请求参数

名称	类型	必填	备注
pid	int	是	顶级：0，子级：父级id
type	string	是	“list”

3、返回数据

返回数据集[{},{},…]

名称	备注
id	分类id
cate_name	分类名称
pid	父id

4、返回示例

[
        {
            "id": 1,
            "cate_name": "家用电器",
            "pid": 0
        },
        {
            "id": 2,
            "cate_name": "手机/运营商/数码",
            "pid": 0
        }
]

5.3、分类详情

1、请求地址

GET /categorys/[:id]

需进行token认证

[:id] 为分类id

示例： http://adminapi.tbyue.com/categorys/1

2、请求参数

无

3、返回数据

名称	备注
id	分类id
cate_name	分类名称
pid	父id
pid_path_name	家族图谱名称(祖先名/父级名)
level	级别 0 1 2 ， 0为最顶级
is_show	是否显示
is_hot	是否热门
image_url	分类logo图片

4、返回示例

{
    "id": 1,
    "cate_name": "家用电器",
    "pid": 0,
    "pid_path_name": "",
    "level": 0,
    "is_show": "是",
    "image_url": "",
    "is_hot": "否"
}

5.4、分类新增

1、请求地址

POST /categorys

需进行token认证

示例： http://adminapi.tbyue.com/categorys

2、请求参数

名称	类型	必填	备注
cate_name	string	是	分类名
pid	int	是	父级id
is_show	int	是	是否显示 1是 0否
is_hot	int	是	是否热门 1是 0否
sort	int	是	排序
logo	string	否	logo图片地址

3、返回数据

名称	备注
id	分类id
cate_name	分类名称
pid	父id
pid_path_name	家族图谱名称(祖先名/父级名)
level	级别 0 1 2 ， 0为最顶级
is_show	是否显示
is_hot	是否热门
image_url	分类logo图片

4、返回示例

{
    "id": 1,
    "cate_name": "家用电器",
    "pid": 0,
    "pid_path_name": "",
    "level": 0,
    "is_show": "是",
    "image_url": "",
    "is_hot": "否"
}

5.5、分类修改

1、请求地址

PUT /categorys/[:id]

需进行token认证

[:id] 为分类id

示例： http://adminapi.tbyue.com/categorys/2

2、请求参数

名称	类型	必填	备注
cate_name	string	是	分类名
pid	int	是	父级id
is_show	int	是	是否显示 1是 0否
is_hot	int	是	是否热门 1是 0否
sort	int	是	排序
logo	string	否	logo图片地址

3、返回数据

名称	备注
id	分类id
cate_name	分类名称
pid	父id
pid_path_name	家族图谱名称(祖先名/父级名)
level	级别 0 1 2 ， 0为最顶级
is_show	是否显示
is_hot	是否热门
image_url	分类logo图片

4、返回示例

{
    "id": 1,
    "cate_name": "家用电器",
    "pid": 0,
    "pid_path_name": "",
    "level": 0,
    "is_show": "是",
    "image_url": "",
    "is_hot": "否"
}

5.6、分类删除

1、请求地址

DELETE /categorys/[:id]

需进行token认证

[:id] 为分类id

示例： http://adminapi.tbyue.com/categorys/2

2、请求参数

无

3、返回数据

无

4、返回示例

无

六、商品品牌

6.1、品牌列表

1、请求地址

GET /brands

需进行token认证

示例： http://adminapi.tbyue.com/brands

2、请求参数

名称	类型	必填	备注
keyword	string	否	搜索关键字，按品牌名称搜索
page	int	否	页码，默认1

3、返回数据

名称	备注
total	总数量
per_page	每页显示数
current_page	当前页码
last_page	总页数
data	数据集

–其中：data数据集

名称	备注
id	品牌id
name	品牌名
logo	品牌logo
desc	品牌描述
sort	排序
is_hot	是否热门 1 是；0 否
cate_name	所属分类名称

4、返回示例

{
        "total": 18,
        "per_page": 20,
        "current_page": 1,
        "last_page": 1,
        "data": [
            {
                "id": 1,
                "name": "华为（HUAWEI）",
                "logo": "/uploads/brand/0bedaba1e05119ac.jpg",
                "desc": "",
                "url": "",
                "sort": 50,
                "cate_id": 72,
                "is_hot": 1,
                "cate_name": "手机",
            },
            {
                "id": 2,
                "name": "小米（MI）",
                "logo": "/uploads/brand/600c61f344607414.jpg",
                "desc": "",
                "url": "",
                "sort": 50,
                "cate_id": 72,
                "is_hot": 1,
                "cate_name": "手机"
            }
        ]
}

6.2、品牌列表2

1、请求地址

GET /brands

需进行token认证

用于获取分类下的品牌（比如商品添加页面选择品牌）

示例： http://adminapi.tbyue.com/brands

2、请求参数

名称	类型	必填	备注
cate_id	int	是	分类id: 72

3、返回数据

返回数据集[{},{},…]

名称	备注
id	品牌id
name	品牌名称

4、返回示例

[
        {
            "id": 1,
            "name": "华为（HUAWEI）",
        },
        {
            "id": 2,
            "name": "小米（MI）"
        }
]

6.3、品牌详情

1、请求地址

GET /brands/[:id]

需进行token认证

[:id] 为品牌id

示例： http://adminapi.tbyue.com/brands/1

2、请求参数

无

3、返回数据

名称	备注
id	品牌id
name	品牌名
logo	品牌logo
desc	品牌描述
sort	排序
is_hot	是否热门 1 是；0 否
cate_id	所属分类id
url	品牌地址

4、返回示例

{
        "id": 1,
        "name": "华为（HUAWEI）",
        "logo": "/uploads/brand/0bedaba1e05119ac.jpg",
        "desc": "",
        "url": "",
        "sort": 50,
        "cate_id": 72,
        "is_hot": 1
}

6.4、品牌新增

1、请求地址

POST /brands

需进行token认证

示例： http://adminapi.tbyue.com/brands

2、请求参数

名称	类型	必填	备注
name	string	是	品牌名
cate_id	int	是	所属分类id
desc	int	否	描述
is_hot	int	是	是否热门 1是 0否
sort	int	是	排序
logo	string	否	logo图片地址
url	string	否	品牌地址

3、返回数据

名称	备注
id	品牌id
name	品牌名
logo	品牌logo
desc	品牌描述
sort	排序
is_hot	是否热门 1 是；0 否
cate_id	所属分类id
url	品牌地址

4、返回示例

{
        "id": 1,
        "name": "华为（HUAWEI）",
        "logo": "/uploads/brand/0bedaba1e05119ac.jpg",
        "desc": "",
        "url": "",
        "sort": 50,
        "cate_id": 72,
        "is_hot": 1
}

6.5、品牌修改

1、请求地址

PUT /brands/[:id]

需进行token认证

[:id] 为品牌id

示例： http://adminapi.tbyue.com/brands/2

2、请求参数

名称	类型	必填	备注
name	string	是	品牌名
cate_id	int	是	所属分类id
desc	int	否	描述
is_hot	int	是	是否热门 1是 0否
sort	int	是	排序
logo	string	否	logo图片地址
url	string	否	品牌地址

3、返回数据

名称	备注
id	品牌id
name	品牌名
logo	品牌logo
desc	品牌描述
sort	排序
is_hot	是否热门 1 是；0 否
cate_id	所属分类id
url	品牌地址

4、返回示例

{
        "id": 1,
        "name": "华为（HUAWEI）",
        "logo": "/uploads/brand/0bedaba1e05119ac.jpg",
        "desc": "",
        "url": "",
        "sort": 50,
        "cate_id": 72,
        "is_hot": 1
}

6.6、品牌删除

1、请求地址

DELETE /brands/[:id]

需进行token认证

[:id] 为品牌id

示例： http://adminapi.tbyue.com/brands/2

2、请求参数

无

3、返回数据

无

4、返回示例

无

七、文件上传

7.1、单图片上传

1、请求地址

POST /logo

需进行token认证

示例： http://adminapi.tbyue.com/logo

2、请求参数

名称	类型	必填	备注
type	string	是	图片类型。商品：goods；分类：category；品牌：brand
logo	file	是	logo文件

3、返回数据

logo文件访问路径

4、返回示例

"/uploads/goods/20190530/adsdsfsgsds.png"

7.2、多图片上传

1、请求地址

POST /images

需进行token认证

示例： http://adminapi.tbyue.com/images

2、请求参数

名称	类型	必填	备注
type	string	否	图片类型。默认为商品：goods
images	array	是	文件数组

3、返回数据

名称	备注
success	上传成功的图片地址集合
error	上传失败的图片名称和错误信息集合

4、返回示例

{
	“success”:[
		"/uploads/goods/20190530/dsgdsafdsfds.png",
		"/uploads/goods/20190530/dsfdsdgfdasd.png",
	],
	"error":[
		{
			"name":"1.png",
			"msg":"图片尺寸错误"
		},
		{
			"name":"2.png",
			"msg":"图片类型错误"
		}
	]
}

八、商品模型

8.1、模型列表

1、请求地址

GET /types

需进行token认证

示例： http://adminapi.tbyue.com/types

2、请求参数

无

3、返回数据

返回数据集[{},{}]

名称	备注
id	模型id
type_name	模型名

4、返回示例

[
		{
            "id": 16,
            "type_name": "手机"
        },
        {
            "id": 17,
            "type_name": "坚果"
        }
]

8.2、模型详情

1、请求地址

GET /types/[:id]

需进行token认证

[:id] 为模型id

示例： http://adminapi.tbyue.com/types/16

2、请求参数

无

3、返回数据

名称	备注
id	模型id
type_name	模型名
specs	规格数据集
attrs	属性数据集

–specs规格数据集

名称	备注
id	规格id
type_id	所属模型id
spec_name	规格名称
sort	排序
spec_values	规格值数据集

----specs.spec_values规格值数据集

名称	备注
id	规格值id
spec_id	所属规格id
spec_value	规格值
type_id	所属模型id

–attrs属性数据集

名称	备注
id	属性id
attr_name	属性名称
type_id	所属模型id
attr_values	可选值数组（可能为空）
sort	排序

4、返回示例

{
        "id": 16,
        "type_name": "手机",
        "specs": [
            {
                "id": 19,
                "type_id": 16,
                "spec_name": "颜色",
                "sort": 0,
                "spec_values": [
                    {
                        "id": 18,
                        "spec_id": 19,
                        "spec_value": "黑色",
                        "type_id": 16
                    },
                    {
                        "id": 19,
                        "spec_id": 19,
                        "spec_value": "白色",
                        "type_id": 16
                    },
                    {
                        "id": 20,
                        "spec_id": 19,
                        "spec_value": "红色",
                        "type_id": 16
                    }
                ]
            },
            {
                "id": 20,
                "type_id": 16,
                "spec_name": "版本",
                "sort": 0,
                "spec_values": [
                    {
                        "id": 21,
                        "spec_id": 20,
                        "spec_value": "全网通（4G+64G）",
                        "type_id": 16
                    },
                    {
                        "id": 22,
                        "spec_id": 20,
                        "spec_value": "全网通（6G+64G）",
                        "type_id": 16
                    }
                ]
            }
        ],
        "attrs": [
            {
                "id": 7,
                "attr_name": "毛重",
                "type_id": 16,
                "attr_values": [],
                "sort": 0
            },
            {
                "id": 8,
                "attr_name": "产地",
                "type_id": 16,
                "attr_values": [],
                "sort": 0
            }
        ]
}

8.3、模型新增

1、请求地址

POST /types

需进行token认证

示例： http://adminapi.tbyue.com/types

2、请求参数

名称	类型	必填	备注
type_name	string	是	模型名
spec	int	是	规格数组
attr	int	是	属性数组

参数示例：

type_name: 手机
spec[0][name]: 颜色
spec[0][sort]: 50
spec[0][value][]: 白色
spec[0][value][]: 黑色
spec[1][name]: 内存
spec[1][sort]: 50
spec[1][value][]: 64G
spec[1][value][]: 128G
attr[0][name]: 毛重
attr[0][sort]: 50
attr[0][value][]: 
attr[1][name]: 产地
attr[1][sort]: 50
attr[1][value][]: 进口
attr[1][value][]: 国产

3、返回数据

名称	备注
id	模型id
type_name	模型名

4、返回示例

{
    "id": 16,
    "type_name": "手机"
}

8.4、模型修改

1、请求地址

PUT /types/[:id]

需进行token认证

[:id] 为模型id

示例： http://adminapi.tbyue.com/types/16

2、请求参数

名称	类型	必填	备注
type_name	string	是	模型名
spec	int	是	规格数组
attr	int	是	属性数组

参数示例：

type_name: 手机
spec[0][name]: 颜色
spec[0][sort]: 50
spec[0][value][]: 白色
spec[0][value][]: 黑色
spec[1][name]: 内存
spec[1][sort]: 50
spec[1][value][]: 64G
spec[1][value][]: 128G
attr[0][name]: 毛重
attr[0][sort]: 50
attr[0][value][]: 
attr[1][name]: 产地
attr[1][sort]: 50
attr[1][value][]: 进口
attr[1][value][]: 国产

3、返回数据

名称	备注
id	模型id
type_name	模型名

4、返回示例

{
    "id": 16,
    "type_name": "手机"
}

8.5、模型删除

1、请求地址

DELETE /types/[:id]

需进行token认证

[:id] 为模型id

示例： http://adminapi.tbyue.com/types/17

2、请求参数

无

3、返回数据

无

4、返回示例

无

九、商品

9.1、商品列表

1、请求地址

GET /goods

需进行token认证

示例： http://adminapi.tbyue.com/goods

2、请求参数

名称	类型	必填	备注
keyword	string	否	搜索关键字
page	int	否	页码，默认1

3、返回数据

名称	备注
total	总数量
per_page	每页显示数
current_page	当前页码
last_page	总页数
data	数据集

–其中：data数据集

名称	备注
id	商品id
goods_name	商品名
goods_logo	商品logo
goods_price	商品价格
goods_number	总库存
is_hot	是否热卖 1 是；0 否
is_on_sale	是否上架 1 是；0 否
is_free_shipping	是否包邮 1 是；0 否
is_recommend	是否推荐 1 是；0 否
is_new	是否新品 1 是；0 否
sales_num	销量
sort	排序
market_price	市场价
cost_price	成本价
goods_remark	商品简介
goods_desc	商品详情
weight	商品重量
volume	商品体积
keywords	商品关键字
comments_num	评论数
collect_num	收藏数
mould_id	运费模板id
type_name	所属模型名
brand_name	所属品牌名
cate_name	所属分类名
goods_attr	商品属性值集合

4、返回示例

{
        "total": 61,
        "per_page": 2,
        "current_page": 1,
        "last_page": 31,
        "data": [
            {
                "id": 61,
                "goods_name": "iphone xr 没朋友啊",
                "goods_price": "1000.00",
                "market_price": "0.00",
                "cost_price": "0.00",
                "goods_number": 100,
                "frozen_number": 0,
                "goods_remark": "11111111",
                "goods_desc": "
test
",
                "goods_logo": "/uploads/goods/20190528/a3fe2eccd3a90a71.jpg",
                "type_id": 16,
                "brand_id": 3,
                "cate_id": 72,
                "mould_id": 0,
                "weight": 0,
                "volume": 0,
                "keywords": "",
                "comments_num": 0,
                "collect_num": "0",
                "sales_num": 0,
                "is_on_sale": 1,
                "is_free_shipping": 1,
                "is_recommend": 1,
                "is_new": 1,
                "is_hot": 1,
                "sort": 50,
                "suppliers_id": 0,
                "goods_attr": [
                    {
                        "id": "7",
                        "attr_name": "毛重",
                        "attr_value": "180g"
                    },
                    {
                        "id": "8",
                        "attr_name": "产地",
                        "attr_value": "中国"
                    }
                ],
                "cate_name": "手机",
                "type_name": "手机",
                "brand_name": "Apple"
            },
            {
                "id": 60,
                "goods_name": "vivo U1 水滴全面屏 AI智慧拍照手机 3GB+32GB 极光色 移动联通电信全网通4G手机",
                "goods_price": "4099.00",
                "market_price": "4099.00",
                "cost_price": "4099.00",
                "goods_number": 100,
                "frozen_number": 0,
                "goods_remark": "",
                "goods_desc": null,
                "goods_logo": "/uploads/goods/20190528/3ec982e47f5256f1.jpg",
                "type_id": 0,
                "brand_id": 8,
                "cate_id": 72,
                "mould_id": 0,
                "weight": null,
                "volume": null,
                "keywords": "",
                "comments_num": 0,
                "collect_num": "0",
                "sales_num": 0,
                "is_on_sale": 1,
                "is_free_shipping": 1,
                "is_recommend": 1,
                "is_new": 1,
                "is_hot": 1,
                "sort": 50,
                "suppliers_id": 0,
                "goods_attr": [
                    {
                        "id": "7",
                        "attr_name": "毛重",
                        "attr_value": "180g"
                    },
                    {
                        "id": "8",
                        "attr_name": "产地",
                        "attr_value": "中国"
                    }
                ],
                "cate_name": "手机",
                "type_name": null,
                "brand_name": "vivo"
            }
        ]

}

9.2、商品详情

1、请求地址

GET /goods/[:id]

需进行token认证

[:id] 为商品id

示例： http://adminapi.tbyue.com/goods/16

2、请求参数

无

3、返回数据

名称	备注
id	商品id
goods_name	商品名
goods_logo	商品logo
goods_price	商品价格
goods_number	总库存
is_hot	是否热卖 1 是；0 否
is_on_sale	是否上架 1 是；0 否
is_free_shipping	是否包邮 1 是；0 否
is_recommend	是否推荐 1 是；0 否
is_new	是否新品 1 是；0 否
sales_num	销量
sort	排序
market_price	市场价
cost_price	成本价
goods_remark	商品简介
goods_desc	商品详情
weight	商品重量
volume	商品体积
keywords	商品关键字
comments_num	评论数
collect_num	收藏数
mould_id	运费模板id
goods_attr	商品属性值集合
category	所属分类信息对象
type	所属模型信息对象
goods_images	相册图片集合
spec_goods	规格商品集合（SKU）

–category对象

名称	备注
id	分类id
cate_name	分类名称
pid_path_name	家族图谱名称

–goods_images集合

名称	备注
id	相册图片id
goods_id	商品id
pics_big	大图地址
pics_sma	小图地址

–spec_goods集合

名称	备注
id	规格商品id
goods_id	商品id
value_ids	规格值ids
value_names	规格值名
price	商品价格
cost_price	成本价格
store_count	库存
store_frozen	冻结库存

–type对象

名称	备注
id	模型id
type_name	模型名称
attrs	属性信息集合
specs	规格信息集合

–type–attrs集合

名称	备注
id	属性id
attr_name	属性名称
type_id	所属模型id
attr_values	属性可选值数组
sort	排序

–type–specs集合

名称	备注
id	规格id
spec_name	规格名称
type_id	所属模型id
sort	排序
spec_values	规格值集合

–type–specs–spec_values集合

名称	备注
id	规格值id
spec_id	所属规格id
spec_value	规格值
type_id	所属模型id

4、返回示例

{
    "code": 200,
    "msg": "success",
    "data": {
        "id": 61,
        "goods_name": "iphone xr 没朋友啊",
        "goods_price": "1000.00",
        "market_price": "0.00",
        "cost_price": "0.00",
        "goods_number": 100,
        "frozen_number": 0,
        "goods_remark": "11111111",
        "goods_desc": "
test
",
        "goods_logo": "/uploads/goods/20190528/a3fe2eccd3a90a71.jpg",
        "type_id": 16,
        "brand_id": 3,
        "cate_id": 72,
        "mould_id": 0,
        "weight": 0,
        "volume": 0,
        "keywords": "",
        "comments_num": 0,
        "collect_num": "0",
        "sales_num": 0,
        "is_on_sale": 1,
        "is_free_shipping": 1,
        "is_recommend": 1,
        "is_new": 1,
        "is_hot": 1,
        "sort": 50,
        "suppliers_id": 0,
        "goods_attr": [
            {
                "id": "7",
                "attr_name": "毛重",
                "attr_value": "180g"
            },
            {
                "id": "8",
                "attr_name": "产地",
                "attr_value": "中国"
            }
        ],
        "category": {
            "id": 72,
            "cate_name": "手机",
            "pid": 71,
            "pid_path": [
                "0",
                "2",
                "71"
            ],
            "pid_path_name": "手机/运营商/数码_手机通讯",
            "level": 2,
            "sort": 50,
            "is_show": "是",
            "image_url": "",
            "is_hot": "否"
        },
        "brand": {
            "id": 3,
            "name": "Apple",
            "logo": "/uploads/brand/574d36dbN262ef26d.jpg",
            "desc": "",
            "url": "",
            "sort": 50,
            "cate_id": 72,
            "is_hot": 1
        },
        "type": {
            "id": 16,
            "type_name": "手机",
            "attrs": [
                {
                    "id": 7,
                    "attr_name": "毛重",
                    "type_id": 16,
                    "attr_values": [],
                    "sort": 0
                },
                {
                    "id": 8,
                    "attr_name": "产地",
                    "type_id": 16,
                    "attr_values": [],
                    "sort": 0
                }
            ],
            "specs": [
                {
                    "id": 19,
                    "type_id": 16,
                    "spec_name": "颜色",
                    "sort": 0,
                    "spec_values": [
                        {
                            "id": 18,
                            "spec_id": 19,
                            "spec_value": "黑色",
                            "type_id": 16
                        },
                        {
                            "id": 19,
                            "spec_id": 19,
                            "spec_value": "白色",
                            "type_id": 16
                        },
                        {
                            "id": 20,
                            "spec_id": 19,
                            "spec_value": "红色",
                            "type_id": 16
                        }
                    ]
                },
                {
                    "id": 20,
                    "type_id": 16,
                    "spec_name": "版本",
                    "sort": 0,
                    "spec_values": [
                        {
                            "id": 21,
                            "spec_id": 20,
                            "spec_value": "全网通（4G+64G）",
                            "type_id": 16
                        },
                        {
                            "id": 22,
                            "spec_id": 20,
                            "spec_value": "全网通（6G+64G）",
                            "type_id": 16
                        }
                    ]
                }
            ]
        },
        "goods_images": [],
        "spec_goods": [
            {
                "id": 801,
                "goods_id": 61,
                "value_ids": "18_21",
                "value_names": "颜色:黑色 版本:全网通（4G+64G）",
                "price": "1000.00",
                "cost_price": "1000.00",
                "store_count": 100,
                "store_frozen": 0
            },
            {
                "id": 802,
                "goods_id": 61,
                "value_ids": "18_22",
                "value_names": "颜色:黑色 版本:全网通（6G+64G）",
                "price": "1100.00",
                "cost_price": "1000.00",
                "store_count": 100,
                "store_frozen": 0
            },
            {
                "id": 803,
                "goods_id": 61,
                "value_ids": "19_21",
                "value_names": "颜色:白色 版本:全网通（4G+64G）",
                "price": "1200.00",
                "cost_price": "1100.00",
                "store_count": 100,
                "store_frozen": 0
            },
            {
                "id": 804,
                "goods_id": 61,
                "value_ids": "19_22",
                "value_names": "颜色:白色 版本:全网通（6G+64G）",
                "price": "1200.00",
                "cost_price": "1100.00",
                "store_count": 96,
                "store_frozen": 4
            }
        ]
    }
}

9.3、商品新增

1、请求地址

POST /goods

需进行token认证

示例： http://adminapi.tbyue.com/goods

2、请求参数

名称	类型	必填	备注
goods_name	string	是	商品名
goods_remark	string	是	商品简介
cate_id	int	是	商品分类id
brand_id	int	是	商品品牌id
goods_price	string	是	商品价格
market_price	string	是	市场价格
cost_price	string	是	成本价格
goods_logo	string	是	商品logo
is_free_shipping	int	是	是否包邮 1 是；0 否
mould_id	int	否	运费模板id
weight	string	否	商品重量
volume	string	否	商品体积
goods_number	string	否	总库存
keywords	string	否	商品关键字
goods_desc	string	否	商品详情
is_hot	int	否	是否热卖 1 是；0 否
is_on_sale	int	否	是否上架 1 是；0 否
is_recommend	int	否	是否推荐 1 是；0 否
is_new	int	否	是否新品 1 是；0 否
sort	int	否	排序
goods_images	array	是	相册图片集合
type_id	int	是	商品模型id
item	array	是	商品规格值集合
attr	array	是	商品属性值集合

规格值和属性值参数示例：

item[规格id1_规格id2]

attr[属性id]

item[18_21][price]: 0
item[18_21][value_names]: 颜色:黑色 版本:全网通（4G+64G）
item[18_21][value_ids]: 18_21
item[18_21][cost_price]: 0
item[18_21][store_count]: 0
item[18_22][price]: 0
item[18_22][value_names]: 颜色:黑色 版本:全网通（6G+64G）
item[18_22][value_ids]: 18_22
item[18_22][cost_price]: 0
item[18_22][store_count]: 0
item[19_21][price]: 0
item[19_21][value_names]: 颜色:白色 版本:全网通（4G+64G）
item[19_21][value_ids]: 19_21
item[19_21][cost_price]: 0
item[19_21][store_count]: 0
item[19_22][price]: 0
item[19_22][value_names]: 颜色:白色 版本:全网通（6G+64G）
item[19_22][value_ids]: 19_22
item[19_22][cost_price]: 0
item[19_22][store_count]: 0
attr[7][attr_name]: 毛重
attr[7][id]: 7
attr[7][attr_value]: 100g
attr[8][attr_name]: 产地
attr[8][id]: 8
attr[8][attr_value]: 中国

3、返回数据

名称	备注
id	商品id
goods_name	商品名
goods_logo	商品logo
goods_price	商品价格
goods_number	总库存
is_hot	是否热卖 1 是；0 否
is_on_sale	是否上架 1 是；0 否
is_free_shipping	是否包邮 1 是；0 否
is_recommend	是否推荐 1 是；0 否
is_new	是否新品 1 是；0 否
sales_num	销量
sort	排序
market_price	市场价
cost_price	成本价
goods_remark	商品简介
goods_desc	商品详情
weight	商品重量
volume	商品体积
keywords	商品关键字
comments_num	评论数
collect_num	收藏数
mould_id	运费模板id
type_name	所属模型名
brand_name	所属品牌名
cate_name	所属分类名
goods_attr	商品属性值集合

4、返回示例

{
                "id": 61,
                "goods_name": "iphone xr 没朋友啊",
                "goods_price": "1000.00",
                "market_price": "0.00",
                "cost_price": "0.00",
                "goods_number": 100,
                "frozen_number": 0,
                "goods_remark": "11111111",
                "goods_desc": "
test
",
                "goods_logo": "/uploads/goods/20190528/a3fe2eccd3a90a71.jpg",
                "type_id": 16,
                "brand_id": 3,
                "cate_id": 72,
                "mould_id": 0,
                "weight": 0,
                "volume": 0,
                "keywords": "",
                "comments_num": 0,
                "collect_num": "0",
                "sales_num": 0,
                "is_on_sale": 1,
                "is_free_shipping": 1,
                "is_recommend": 1,
                "is_new": 1,
                "is_hot": 1,
                "sort": 50,
                "suppliers_id": 0,
                "goods_attr": [
                    {
                        "id": "7",
                        "attr_name": "毛重",
                        "attr_value": "180g"
                    },
                    {
                        "id": "8",
                        "attr_name": "产地",
                        "attr_value": "中国"
                    }
                ],
                "cate_name": "手机",
                "type_name": "手机",
                "brand_name": "Apple"
    }

9.4、商品修改页面接口

1、请求地址

GET /goods/[:id]/edit

需进行token认证

[:id] 为模型id

示例： http://adminapi.tbyue.com/goods/61/edit

2、请求参数

无

3、返回数据

返回数据对象{}

名称	备注
goods	商品信息对象
category	分类信息集合
type	模型信息集合

–category数据集合

名称	备注
cate_one	所有一级分类数据集合
cate_two	商品所属一级分类下的二级分类数据集合
cate_three	商品所属二级分类下的三级分类数据集合

分类集合：

名称	备注
id	分类id
cate_name	分类名称

---

–type数据集合

名称	备注
id	模型id
type_name	模型名称

---

–goods数据对象

名称	备注
id	商品id
goods_name	商品名
goods_logo	商品logo
goods_price	商品价格
goods_number	总库存
is_hot	是否热卖 1 是；0 否
is_on_sale	是否上架 1 是；0 否
is_free_shipping	是否包邮 1 是；0 否
is_recommend	是否推荐 1 是；0 否
is_new	是否新品 1 是；0 否
sales_num	销量
sort	排序
market_price	市场价
cost_price	成本价
goods_remark	商品简介
goods_desc	商品详情
weight	商品重量
volume	商品体积
keywords	商品关键字
comments_num	评论数
collect_num	收藏数
mould_id	运费模板id
goods_attr	商品属性值集合
category	所属分类信息对象
type	所属模型信息对象
goods_images	相册图片集合
spec_goods	规格商品集合（SKU）

–goods–category对象

名称	备注
id	分类id
cate_name	分类名称
pid_path	家族图谱id
brands	分类下的品牌

–goods–goods_images集合

名称	备注
id	相册图片id
goods_id	商品id
pics_big	大图地址
pics_sma	小图地址

–goods–spec_goods集合

名称	备注
id	规格商品id
goods_id	商品id
value_ids	规格值ids
value_names	规格值名
price	商品价格
cost_price	成本价格
store_count	库存
store_frozen	冻结库存

–goods–type对象

名称	备注
id	模型id
type_name	模型名称
attrs	属性信息集合
specs	规格信息集合

–goods–type–attrs集合

名称	备注
id	属性id
attr_name	属性名称
type_id	所属模型id
attr_values	属性可选值数组
sort	排序

–goods–type–specs集合

名称	备注
id	规格id
spec_name	规格名称
type_id	所属模型id
sort	排序
spec_values	规格值集合

–goods–type–specs–spec_values集合

名称	备注
id	规格值id
spec_id	所属规格id
spec_value	规格值
type_id	所属模型id

4、返回示例

{
                "id": 61,
                "goods_name": "iphone xr 没朋友啊",
                "goods_price": "1000.00",
                "market_price": "0.00",
                "cost_price": "0.00",
                "goods_number": 100,
                "frozen_number": 0,
                "goods_remark": "11111111",
                "goods_desc": "
test
",
                "goods_logo": "/uploads/goods/20190528/a3fe2eccd3a90a71.jpg",
                "type_id": 16,
                "brand_id": 3,
                "cate_id": 72,
                "mould_id": 0,
                "weight": 0,
                "volume": 0,
                "keywords": "",
                "comments_num": 0,
                "collect_num": "0",
                "sales_num": 0,
                "is_on_sale": 1,
                "is_free_shipping": 1,
                "is_recommend": 1,
                "is_new": 1,
                "is_hot": 1,
                "sort": 50,
                "suppliers_id": 0,
                "goods_attr": [
                    {
                        "id": "7",
                        "attr_name": "毛重",
                        "attr_value": "180g"
                    },
                    {
                        "id": "8",
                        "attr_name": "产地",
                        "attr_value": "中国"
                    }
                ],
                "cate_name": "手机",
                "type_name": "手机",
                "brand_name": "Apple"
    }

9.5、商品修改

1、请求地址

PUT /goods/[:id]

需进行token认证

[:id] 为模型id

示例： http://adminapi.tbyue.com/goods/61

2、请求参数

名称	类型	必填	备注
goods_name	string	是	商品名
goods_remark	string	是	商品简介
cate_id	int	是	商品分类id
brand_id	int	是	商品品牌id
goods_price	string	是	商品价格
market_price	string	是	市场价格
cost_price	string	是	成本价格
goods_logo	string	是	商品logo
is_free_shipping	int	是	是否包邮 1 是；0 否
mould_id	int	否	运费模板id
weight	string	否	商品重量
volume	string	否	商品体积
goods_number	string	否	总库存
keywords	string	否	商品关键字
goods_desc	string	否	商品详情
is_hot	int	否	是否热卖 1 是；0 否
is_on_sale	int	否	是否上架 1 是；0 否
is_recommend	int	否	是否推荐 1 是；0 否
is_new	int	否	是否新品 1 是；0 否
sort	int	否	排序
goods_images	array	是	相册图片集合
type_id	int	是	商品模型id
item	array	是	商品规格值集合
attr	array	是	商品属性值集合

规格值和属性值参数示例：

item[规格id1_规格id2]

attr[属性id]

item[18_21][price]: 0
item[18_21][value_names]: 颜色:黑色 版本:全网通（4G+64G）
item[18_21][value_ids]: 18_21
item[18_21][cost_price]: 0
item[18_21][store_count]: 0
item[18_22][price]: 0
item[18_22][value_names]: 颜色:黑色 版本:全网通（6G+64G）
item[18_22][value_ids]: 18_22
item[18_22][cost_price]: 0
item[18_22][store_count]: 0
item[19_21][price]: 0
item[19_21][value_names]: 颜色:白色 版本:全网通（4G+64G）
item[19_21][value_ids]: 19_21
item[19_21][cost_price]: 0
item[19_21][store_count]: 0
item[19_22][price]: 0
item[19_22][value_names]: 颜色:白色 版本:全网通（6G+64G）
item[19_22][value_ids]: 19_22
item[19_22][cost_price]: 0
item[19_22][store_count]: 0
attr[7][attr_name]: 毛重
attr[7][id]: 7
attr[7][attr_value]: 100g
attr[8][attr_name]: 产地
attr[8][id]: 8
attr[8][attr_value]: 中国

3、返回数据

名称	备注
id	商品id
goods_name	商品名
goods_logo	商品logo
goods_price	商品价格
goods_number	总库存
is_hot	是否热卖 1 是；0 否
is_on_sale	是否上架 1 是；0 否
is_free_shipping	是否包邮 1 是；0 否
is_recommend	是否推荐 1 是；0 否
is_new	是否新品 1 是；0 否
sales_num	销量
sort	排序
market_price	市场价
cost_price	成本价
goods_remark	商品简介
goods_desc	商品详情
weight	商品重量
volume	商品体积
keywords	商品关键字
comments_num	评论数
collect_num	收藏数
mould_id	运费模板id
type_name	所属模型名
brand_name	所属品牌名
cate_name	所属分类名
goods_attr	商品属性值集合

4、返回示例

{
                "id": 61,
                "goods_name": "iphone xr 没朋友啊",
                "goods_price": "1000.00",
                "market_price": "0.00",
                "cost_price": "0.00",
                "goods_number": 100,
                "frozen_number": 0,
                "goods_remark": "11111111",
                "goods_desc": "
test
",
                "goods_logo": "/uploads/goods/20190528/a3fe2eccd3a90a71.jpg",
                "type_id": 16,
                "brand_id": 3,
                "cate_id": 72,
                "mould_id": 0,
                "weight": 0,
                "volume": 0,
                "keywords": "",
                "comments_num": 0,
                "collect_num": "0",
                "sales_num": 0,
                "is_on_sale": 1,
                "is_free_shipping": 1,
                "is_recommend": 1,
                "is_new": 1,
                "is_hot": 1,
                "sort": 50,
                "suppliers_id": 0,
                "goods_attr": [
                    {
                        "id": "7",
                        "attr_name": "毛重",
                        "attr_value": "180g"
                    },
                    {
                        "id": "8",
                        "attr_name": "产地",
                        "attr_value": "中国"
                    }
                ],
                "cate_name": "手机",
                "type_name": "手机",
                "brand_name": "Apple"
    }

9.6、商品删除

1、请求地址

DELETE /goods/[:id]

需进行token认证

[:id] 为商品id

示例： http://adminapi.tbyue.com/goods/17

2、请求参数

无

3、返回数据

无

4、返回示例

无

9.7、商品相册删除

1、请求地址

DELETE /delpics/[:id]

需进行token认证

[:id] 为商品相册图片id

示例： http://adminapi.tbyue.com/delpics/17

2、请求参数

无

3、返回数据

无

4、返回示例

无

十、订单

10.1、订单列表

1、请求地址

GET /orders

需进行token认证

示例： http://adminapi.tbyue.com/orders

2、请求参数

无

3、返回数据

名称	备注
total	总数量
per_page	每页显示数
current_page	当前页码
last_page	总页数
data	数据集

–其中：data数据集

名称	备注
id	订单id
order_sn	订单编号
user_id	用户id
order_status	订单状态
consignee	收货人姓名
phone	收货人手机号
address	收货人地址
shipping_code	物流英文名
shipping_name	物流中文名
shipping_sn	物流单号
pay_code	支付方式英文名
pay_name	支付方式中文名
goods_price	商品总价
shipping_price	运费
coupon_price	优惠金额
order_amount	应付款
total_amount	订单总额
nickname	用户昵称
invoice_title	发票抬头
taxpayer	纳税识别号
invoice_desc	发票内容
user_note	用户备注
create_time	下单时间
shipping_time	发货时间
confirm_time	收货确认时间
pay_time	支付时间

4、返回示例

[
            {
                "id": 10,
                "order_sn": "1559134264534731",
                "user_id": 1,
                "order_status": "待付款",
                "consignee": "小小",
                "address": "北京市顺义区马坡镇黑马程序员",
                "phone": "19912345678",
                "shipping_code": "yuantong",
                "shipping_name": "圆通",
                "shipping_sn": "",
                "pay_code": "alipay",
                "pay_name": "支付宝",
                "invoice_title": "",
                "taxpayer": "",
                "invoice_desc": null,
                "user_note": "",
                "goods_price": "290400.00",
                "shipping_price": "0.00",
                "coupon_price": "0.00",
                "order_amount": "290400.00",
                "total_amount": "290400.00",
                "shipping_time": 0,
                "confirm_time": 0,
                "pay_time": 0,
                "nickname": "199****5678"
            },
            {
                "id": 9,
                "order_sn": "1559134151617041",
                "user_id": 1,
                "order_status": "待付款",
                "consignee": "小小",
                "address": "北京市顺义区马坡镇黑马程序员",
                "phone": "19912345678",
                "shipping_code": "yuantong",
                "shipping_name": "圆通",
                "shipping_sn": "",
                "pay_code": "alipay",
                "pay_name": "支付宝",
                "invoice_title": "",
                "taxpayer": "",
                "invoice_desc": null,
                "user_note": "",
                "goods_price": "0.00",
                "shipping_price": "0.00",
                "coupon_price": "0.00",
                "order_amount": "0.00",
                "total_amount": "0.00",
                "shipping_time": 0,
                "confirm_time": 0,
                "pay_time": 0,
                "nickname": "199****5678"
            }
]

10.2、商品详情

1、请求地址

GET /orders/[:id]

需进行token认证

[:id] 为商品id

示例： http://adminapi.tbyue.com/orders/10

2、请求参数

无

3、返回数据

名称	备注
id	订单id
order_sn	订单编号
user_id	用户id
order_status	订单状态
consignee	收货人姓名
phone	收货人手机号
address	收货人地址
shipping_code	物流英文名
shipping_name	物流中文名
shipping_sn	物流单号
pay_code	支付方式英文名
pay_name	支付方式中文名
goods_price	商品总价
shipping_price	运费
coupon_price	优惠金额
order_amount	应付款
total_amount	订单总额
nickname	用户昵称
invoice_title	发票抬头
taxpayer	纳税识别号
invoice_desc	发票内容
user_note	用户备注
create_time	下单时间
shipping_time	发货时间
confirm_time	收货确认时间
pay_time	支付时间
order_goods	订单商品数据集

–其中：order_goods数据集

名称	备注
id	id
order_id	订单id
goods_id	商品id
spec_goods_id	规格商品id
number	购买数量
goods_name	商品名称
goods_logo	商品名logo
goods_price	商品单价
spec_value_names	规格值中文名
is_comment	是否评价 0否，1是
status	发货状态：0未发货，1已发货，2已换货，3已退货

4、返回示例

{
        "id": 10,
        "order_sn": "1559134264534731",
        "user_id": 1,
        "order_status": "待付款",
        "consignee": "小小",
        "address": "北京市顺义区马坡镇黑马程序员",
        "phone": "19912345678",
        "shipping_code": "yuantong",
        "shipping_name": "圆通",
        "shipping_sn": "",
        "pay_code": "alipay",
        "pay_name": "支付宝",
        "invoice_title": "",
        "taxpayer": "",
        "invoice_desc": null,
        "user_note": "",
        "goods_price": "290400.00",
        "shipping_price": "0.00",
        "coupon_price": "0.00",
        "order_amount": "290400.00",
        "total_amount": "290400.00",
        "shipping_time": 0,
        "confirm_time": 0,
        "pay_time": 0,
        "nickname": "199****5678",
        "order_goods": [
            {
                "id": 12,
                "order_id": 10,
                "goods_id": 1,
                "spec_goods_id": 1,
                "number": 4,
                "goods_name": "荣耀10青春版 幻彩渐变 2400万AI自拍 全网通版4GB+64GB 渐变蓝 移动联通电信4G全面屏手机 双卡双待",
                "goods_logo": "/uploads/goods/20190528/865565d919219154.jpg",
                "goods_price": "8000.00",
                "spec_value_names": "颜色：黑色 内存：32G",
                "is_comment": "否",
                "status": "未发货"
            },
            {
                "id": 13,
                "order_id": 10,
                "goods_id": 1,
                "spec_goods_id": 2,
                "number": 21,
                "goods_name": "荣耀10青春版 幻彩渐变 2400万AI自拍 全网通版4GB+64GB 渐变蓝 移动联通电信4G全面屏手机 双卡双待",
                "goods_logo": "/uploads/goods/20190528/865565d919219154.jpg",
                "goods_price": "8000.00",
                "spec_value_names": "颜色：黑色 内存：64G",
                "is_comment": "否",
                "status": "未发货"
            }
        ]
    }