Showing
2 changed files
with
314 additions
and
0 deletions
inferface-document/shop_admin.md
0 → 100644
1 | +# 店铺管理员接口服务定义 | ||
2 | +--------------------- | ||
3 | + | ||
4 | +## 获取店铺管理员列表 | ||
5 | + | ||
6 | +> 接口名:`/shops/getShopsAdminList` | ||
7 | + | ||
8 | +### 入参 | ||
9 | + | ||
10 | +------------------------- | ||
11 | +|属性名称|类型|例子|说明| | ||
12 | +|--------|----|----|----| | ||
13 | +|page|int|2|第几页| | ||
14 | +|size|int|50|每页条数| | ||
15 | +--------------------- | ||
16 | + | ||
17 | +### 返回 | ||
18 | + | ||
19 | +``` json | ||
20 | +{ | ||
21 | + "code":200, | ||
22 | + "message":"list", | ||
23 | + "data":{ | ||
24 | + | ||
25 | + } | ||
26 | +} | ||
27 | +``` | ||
28 | + | ||
29 | + | ||
30 | +## 添加店铺管理员关系 | ||
31 | +> 接口名: `/shops/addAdminRelation` | ||
32 | + | ||
33 | +### 入参 | ||
34 | + | ||
35 | +------------------------- | ||
36 | +|属性名称|类型|例子|说明| | ||
37 | +|--------|----|----|----| | ||
38 | +|shopsId|int|15|店铺ID| | ||
39 | +|adminPid|int|2951|管理员ID| | ||
40 | +|identity|int|1|身份(1、店长 2、供应商 3、店员)| | ||
41 | +--------------------------- | ||
42 | + | ||
43 | +### 返回 | ||
44 | + | ||
45 | +```json | ||
46 | +{ | ||
47 | + "code":500 | ||
48 | + "message":"shops_id is null" | ||
49 | +} | ||
50 | +{ | ||
51 | + "code":500 | ||
52 | + "message":"admin_pid is null" | ||
53 | +} | ||
54 | +{ | ||
55 | + "code":500 | ||
56 | + "message":"该关系已存在" | ||
57 | +} | ||
58 | +{ | ||
59 | + "code":500 | ||
60 | + "message":"添加失败" | ||
61 | +} | ||
62 | +{ | ||
63 | + "code":200 | ||
64 | + "message":"添加成功" | ||
65 | +} | ||
66 | + | ||
67 | +``` | ||
68 | + | ||
69 | +## 删除店铺管理员关系 | ||
70 | +> 接口名: `/shops/delAdminRelation` | ||
71 | + | ||
72 | +### 入参 | ||
73 | + | ||
74 | +------------------------- | ||
75 | +|属性名称|类型|例子|说明| | ||
76 | +|--------|----|----|----| | ||
77 | +|id|int|20|店铺管理员记录ID| | ||
78 | +|shopsId|int|15|店铺ID| | ||
79 | +--------------------------- | ||
80 | + | ||
81 | +### 返回 | ||
82 | + | ||
83 | +```json | ||
84 | +{ | ||
85 | + "code":500 | ||
86 | + "message":"id is null" | ||
87 | +} | ||
88 | +{ | ||
89 | + "code":200 | ||
90 | + "message":"删除成功!" | ||
91 | +} | ||
92 | +``` | ||
93 | + | ||
94 | +## 获取管理员关系详情 | ||
95 | + | ||
96 | +> 接口名:`/shops/getAdminRelationDetailById` | ||
97 | + | ||
98 | +### 入参 | ||
99 | + | ||
100 | +------------------------- | ||
101 | +|属性名称|类型|例子|说明| | ||
102 | +|--------|----|----|----| | ||
103 | +|id|int|20|店铺管理员记录ID| | ||
104 | +|shopsId|int|15|店铺ID| | ||
105 | +------------------- | ||
106 | + | ||
107 | +### 返回 | ||
108 | + | ||
109 | +```json | ||
110 | +{ | ||
111 | + "code":500, | ||
112 | + "message":"id is null" | ||
113 | +} | ||
114 | +{ | ||
115 | + "code":500, | ||
116 | + "message":"shops_id is null" | ||
117 | +} | ||
118 | +{ | ||
119 | + "code":500, | ||
120 | + "message":"暂无数据" | ||
121 | +} | ||
122 | +{ | ||
123 | + "code":200, | ||
124 | + "message":"list", | ||
125 | + "data":{ | ||
126 | + | ||
127 | + } | ||
128 | +} | ||
129 | +``` | ||
130 | + | ||
131 | + | ||
132 | +## 修改店铺管理员关系 | ||
133 | + | ||
134 | +> 接口名: `/shops/updateAdminRalation` | ||
135 | + | ||
136 | +### 入参 | ||
137 | + | ||
138 | +------------------------- | ||
139 | +|属性名称|类型|例子|说明| | ||
140 | +|--------|----|----|----| | ||
141 | +|shopDomain|String|debao|店铺域名| | ||
142 | +|shopsId|int|15|店铺ID| | ||
143 | +----------------------------- | ||
144 | + | ||
145 | +### 返回 | ||
146 | + | ||
147 | +```json | ||
148 | +{ | ||
149 | + "code":500 | ||
150 | + "message":"id is null" | ||
151 | +} | ||
152 | +{ | ||
153 | + "code":500 | ||
154 | + "message":"shops_id is null" | ||
155 | +} | ||
156 | +{ | ||
157 | + "code":500 | ||
158 | + "message":"admin_pid is null" | ||
159 | +} | ||
160 | +{ | ||
161 | + "code":500 | ||
162 | + "message":"该关系已存在" | ||
163 | +} | ||
164 | +{ | ||
165 | + "code":200 | ||
166 | + "message":"修改成功" | ||
167 | +} | ||
168 | + | ||
169 | +``` | ||
170 | + |
inferface-document/shops_check.md
0 → 100644
1 | +# 店铺审核接口服务定义 | ||
2 | +--------------------- | ||
3 | + | ||
4 | +## 添加店铺审核 | ||
5 | + | ||
6 | +> 接口名:`/shops/addCheckShop` | ||
7 | + | ||
8 | +### 入参 | ||
9 | + | ||
10 | +------------------------- | ||
11 | +|属性名称|类型|例子|说明| | ||
12 | +|--------|----|----|----| | ||
13 | +|shopsId|int|15|店铺ID| | ||
14 | +|shopName|String|得宝旗舰店|店铺名称| | ||
15 | +|shopNature|int|1|店铺性质(1 旗舰店 2 专卖店)| | ||
16 | +|shopDomain|String|debao|店铺域名| | ||
17 | +|shopRelation|JSON数组||| | ||
18 | +|createPid|int|1|创建人ID| | ||
19 | +|shopsType|int|1|店铺模式(1 单品店 2 多品店)| | ||
20 | +|shopLogo|String|http://img11.static.yhbimg.com/yhb-img01/2015/09/11/02/01f42dff5d5bd383af1025eea1218cbccc.jpg?imageView/{mode}/w/{width}/h/{height}|店铺logo| | ||
21 | +|shopIntro|String|秉承以设计为核心的创新理念,用专业的思维方式将自然与科技、传统与革新、技艺与时尚三者良好融合,着重面料材质与软式廓型的品质互动,更好的诠释“less is more”的设计理念。|店铺简介| | ||
22 | +|websiteUrl|JSON数组|["www.paperworks.com.cn"]|| | ||
23 | +|otherUrl|JSON数组|["www.paperworks.com.cn","https:\/\/jnby.tmall.com\/"]|| | ||
24 | +|shopAddress|JSON数组||| | ||
25 | +|status|int|0|状态(1 开启 0 关闭)| | ||
26 | +|createTime|int|1441936854|添加时间| | ||
27 | +|updateTime|int|1442312299|修改时间| | ||
28 | +--------------------- | ||
29 | + | ||
30 | +### 返回 | ||
31 | + | ||
32 | +``` json | ||
33 | +{ | ||
34 | + "code":400 | ||
35 | + "message":"店铺已经在审核中" | ||
36 | +} | ||
37 | +{ | ||
38 | + "code":500 | ||
39 | + "message":"操作成功" | ||
40 | +} | ||
41 | +{ | ||
42 | + "code":200 | ||
43 | + "message":"操作成功" | ||
44 | +} | ||
45 | +``` | ||
46 | + | ||
47 | + | ||
48 | +## 获取查看审核详情 | ||
49 | +> 接口名: `/shops/getCheckShopInfo` | ||
50 | + | ||
51 | +### 入参 | ||
52 | + | ||
53 | +------------------------- | ||
54 | +|属性名称|类型|例子|说明| | ||
55 | +|--------|----|----|----| | ||
56 | +|shopsId|int|15|店铺ID| | ||
57 | +--------------------------- | ||
58 | + | ||
59 | +### 返回 | ||
60 | + | ||
61 | +```json | ||
62 | +{ | ||
63 | + "code":400 | ||
64 | + "message":"店铺id有误" | ||
65 | +} | ||
66 | +{ | ||
67 | + "code":500 | ||
68 | + "message":"暂无数据" | ||
69 | +} | ||
70 | +{ | ||
71 | + "code":200, | ||
72 | + "message":"ok", | ||
73 | + "data":{ | ||
74 | + | ||
75 | + } | ||
76 | +} | ||
77 | + | ||
78 | +``` | ||
79 | + | ||
80 | +## 审核通过 | ||
81 | +> 接口名: `/shops/allowShop` | ||
82 | + | ||
83 | +### 入参 | ||
84 | + | ||
85 | +------------------------- | ||
86 | +|属性名称|类型|例子|说明| | ||
87 | +|--------|----|----|----| | ||
88 | +|shopsId|int|15|店铺ID| | ||
89 | +--------------------------- | ||
90 | + | ||
91 | +### 返回 | ||
92 | + | ||
93 | +```json | ||
94 | +{ | ||
95 | + "code":400 | ||
96 | + "message":"店铺信息有误" | ||
97 | +} | ||
98 | +{ | ||
99 | + "code":500 | ||
100 | + "message":"没有待审核的信息" | ||
101 | +} | ||
102 | +{ | ||
103 | + "code":500 | ||
104 | + "message":"更新店铺信息失败" | ||
105 | +} | ||
106 | +{ | ||
107 | + "code":200 | ||
108 | + "message":"更新成功" | ||
109 | +} | ||
110 | +``` | ||
111 | + | ||
112 | +## 审核驳回 | ||
113 | + | ||
114 | +> 接口名:`/shops/rejectShop` | ||
115 | + | ||
116 | +### 入参 | ||
117 | + | ||
118 | +------------------------- | ||
119 | +|属性名称|类型|例子|说明| | ||
120 | +|--------|----|----|----| | ||
121 | +|shopsId|int|15|店铺ID| | ||
122 | +------------------- | ||
123 | + | ||
124 | +### 返回 | ||
125 | + | ||
126 | +```json | ||
127 | +{ | ||
128 | + "code":400, | ||
129 | + "message":"店铺信息有误" | ||
130 | +} | ||
131 | +{ | ||
132 | + "code":500, | ||
133 | + "message":"没有待审核的信息" | ||
134 | +} | ||
135 | +{ | ||
136 | + "code":500, | ||
137 | + "message":"操作失败" | ||
138 | +} | ||
139 | +{ | ||
140 | + "code":200, | ||
141 | + "message":"操作成功", | ||
142 | +} | ||
143 | +``` | ||
144 | + |
-
Please register or login to post a comment