Showing
16 changed files
with
1979 additions
and
0 deletions
.gitignore
0 → 100644
1 | +*.iml | ||
2 | +.idea/ | ||
3 | +.ipr | ||
4 | +.iws | ||
5 | +*~ | ||
6 | +~* | ||
7 | +*.diff | ||
8 | +*.patch | ||
9 | +*.bak | ||
10 | +.DS_Store | ||
11 | +Thumbs.db | ||
12 | +.project | ||
13 | +.*proj | ||
14 | +.svn/ | ||
15 | +*.swp | ||
16 | +*.swo | ||
17 | +*.pyc | ||
18 | +*.pyo | ||
19 | +.build | ||
20 | +node_modules | ||
21 | +_site | ||
22 | +sea-modules | ||
23 | +spm_modules | ||
24 | +.cache | ||
25 | +dist | ||
26 | +coverage | ||
27 | +.sass-cache | ||
28 | + | ||
29 | + | ||
30 | +public/css/ |
inferface-document/README.md
0 → 100644
1 | +关于接口定义规约 | ||
2 | +----------------------- | ||
3 | + | ||
4 | +## 通用规则 | ||
5 | + | ||
6 | +* 所有的服务接口都用POST方法请求 | ||
7 | +* 提交参数采用RAW的JSON文本, | ||
8 | +* 返回数据也是JSON | ||
9 | +* 字段命名采用驼峰的方式分隔多个单词 | ||
10 | + | ||
11 | +## 关于服务接口命名 | ||
12 | + | ||
13 | +> 模块名+/+方法名称 | ||
14 | + | ||
15 | +例如:`auth/getAccoutList` 账户权限模块的获取账号列表 | ||
16 | + | ||
17 | +## 关于请求参数 | ||
18 | + | ||
19 | +入参采用RAW的JSON文本 | ||
20 | + | ||
21 | +还是以获取账号列表的接口定义为例 | ||
22 | + | ||
23 | +范例: | ||
24 | + | ||
25 | +```json | ||
26 | +{ | ||
27 | + "account":"test",//用户名 | ||
28 | + "truename":"张三",//姓名 | ||
29 | + "email":"hb@126.com",//邮件 | ||
30 | + "phone":"1850021224",//电话 | ||
31 | + "identity":"32054778955412"//身份 | ||
32 | +} | ||
33 | +``` | ||
34 | + | ||
35 | +## 关于返回 | ||
36 | + | ||
37 | +* 要有返回码 | ||
38 | +* 返回数据是json | ||
39 | + | ||
40 | +范例: | ||
41 | + | ||
42 | +```json | ||
43 | +{ | ||
44 | + "code":200, | ||
45 | + "data":{ | ||
46 | + "list":[ | ||
47 | + { | ||
48 | + "username":"xxx", | ||
49 | + "truename":"xxx", | ||
50 | + "email":"xxx@126.com", | ||
51 | + "phone":"18602554147", | ||
52 | + "identity_cn":"sdasd", | ||
53 | + "status":"0", | ||
54 | + "pid":123, | ||
55 | + "create_time":1423234344 | ||
56 | + },... | ||
57 | + ], | ||
58 | + "offset":0, | ||
59 | + "limit":50, | ||
60 | + "total":1000 | ||
61 | + }, | ||
62 | + "message":"" | ||
63 | +} | ||
64 | + | ||
65 | +``` |
inferface-document/auth_interface.md
0 → 100644
1 | +##权限和账户接口定义 | ||
2 | + | ||
3 | +### 登陆 | ||
4 | + | ||
5 | +> 接口名: `portal.auth.login` | ||
6 | + | ||
7 | +#### 入参 | ||
8 | + | ||
9 | +------------------------- | ||
10 | +|属性名称|类型|例子|说明| | ||
11 | +|--------|----|----|----| | ||
12 | +|user|string|admin|用户名| | ||
13 | +|password|string|123456|密码| | ||
14 | + | ||
15 | +#### 返回 | ||
16 | + | ||
17 | +``` json | ||
18 | +{ | ||
19 | + "code":200 | ||
20 | + "data":{ | ||
21 | + auth:{ | ||
22 | + pid:1, | ||
23 | + name:'admin' | ||
24 | + }, | ||
25 | + menu:[{ | ||
26 | + title: '优惠码管理', | ||
27 | + parent: 'menu-template', | ||
28 | + menu: [{ | ||
29 | + title: '优惠码列表', | ||
30 | + href: '/coupon/list' | ||
31 | + }] | ||
32 | + }, { | ||
33 | + title: '供应商管理', | ||
34 | + parent: 'menu-template', | ||
35 | + menu: [{ | ||
36 | + title:'创建供应商', | ||
37 | + href:'/supplier/index' | ||
38 | + }] | ||
39 | + }, { | ||
40 | + title:'品牌管理', | ||
41 | + parent:'menu-template', | ||
42 | + menu: [{ | ||
43 | + title:'品牌管理', | ||
44 | + href:'/brand/index' | ||
45 | + }] | ||
46 | + }] | ||
47 | + } | ||
48 | +} | ||
49 | + | ||
50 | +``` | ||
51 | + | ||
52 | +### 获取账户列表 | ||
53 | + | ||
54 | +> 接口名: `portal.acct.list` | ||
55 | + | ||
56 | + | ||
57 | + | ||
58 | + | ||
59 | +### 添加账号 | ||
60 | + | ||
61 | +### 根据PID分配权限 | ||
62 | + | ||
63 | +### 根据PID分配角色 | ||
64 | + | ||
65 | +### 根据PID修改信息 | ||
66 | + | ||
67 | +### 查询部门结构信息 | ||
68 | + | ||
69 | +### 修改部门信息 | ||
70 | + | ||
71 | +### 添加部门信息 | ||
72 | + | ||
73 | + | ||
74 | + |
inferface-document/brand.md
0 → 100644
1 | +品牌管理接口服务定义 | ||
2 | +--------------------- | ||
3 | + | ||
4 | + | ||
5 | + | ||
6 | +## 品牌列表查询 | ||
7 | + | ||
8 | +> 接口名: 'brand/getBrandList' | ||
9 | + | ||
10 | +### 入参 | ||
11 | + | ||
12 | +------------------------- | ||
13 | +|属性名称|类型|例子|说明| | ||
14 | +|--------|----|----|----| | ||
15 | +|brandId|Number|43|品牌id| | ||
16 | +|status|Number|0|状态| | ||
17 | +|brandLevel|string|A|品牌级别| | ||
18 | +|startTime|String|2016-01-12|开始时间| | ||
19 | +|endTime|String|2016-01-13|结束时间| | ||
20 | +|page|Number|2|第几页| | ||
21 | +|size|Number|50|每页条数| | ||
22 | +--------------------- | ||
23 | + | ||
24 | +### 返回 | ||
25 | + | ||
26 | +``` json | ||
27 | +{ | ||
28 | + "code":200, | ||
29 | + "message":"请求成功", | ||
30 | + "data": { | ||
31 | + "list": [ | ||
32 | + { | ||
33 | + "id": "", | ||
34 | + "brandIco": "", //logo图片地址 | ||
35 | + "brandNameCn": "", //品牌中文名字 | ||
36 | + "brandNameEn": "", //品牌英文名字 | ||
37 | + "brandLevel": "", //级别 | ||
38 | + "brandTonality": "", //调性分 | ||
39 | + "createTime": "", //创建时间 | ||
40 | + "status": 1 //1为开启状态,0为关闭状态 | ||
41 | + } | ||
42 | + ], | ||
43 | + "offset": 0, | ||
44 | + "limit": 50, | ||
45 | + "total": 1000 | ||
46 | + } | ||
47 | +} | ||
48 | + | ||
49 | +``` | ||
50 | + | ||
51 | + | ||
52 | +## 添加品牌接口 | ||
53 | + | ||
54 | +> 接口名: 'brand/addBrand' | ||
55 | + | ||
56 | +### 入参 | ||
57 | + | ||
58 | +------------------------- | ||
59 | +|属性名称|类型|例子|说明| | ||
60 | +|--------|----|----|----| | ||
61 | +|status|String|add|状态| | ||
62 | +|brandName|string|nike|品牌名称| | ||
63 | +|brandNameEn|string|aaaa|英文名称| | ||
64 | +|brandDomain|string|yoho|二级域名| | ||
65 | +|brandIco|string|http://static.yohobuy.com/newheader/img/logo_e.png|品牌logo| | ||
66 | +|brandLevel|string|KA|品牌级别| | ||
67 | +|promotionLevel|int|2|品牌推广星级| | ||
68 | +|mainCategory|int|2|主营类目| | ||
69 | +|brandHeadstream|int|2|发源地| | ||
70 | +|brandTypes|int|2|品牌类型| | ||
71 | +|brandUrl|string|www.baidu.com|品牌网址| | ||
72 | +|brandIntro|string|xxxxxx|品牌介绍| | ||
73 | +|brandOutline|string|xxxxxx|品牌简述| | ||
74 | +|brandFounder|string|jay|品牌主理人| | ||
75 | +|brandStyle|string|街头|品牌风格| | ||
76 | +|brandNature|int|4|品牌性质| | ||
77 | +|brandTonality|string|xxxx|调性指数| | ||
78 | +--------------------- | ||
79 | + | ||
80 | +### 返回 | ||
81 | + | ||
82 | +``` json | ||
83 | +{ | ||
84 | + "code":200, | ||
85 | + "message":"请求成功" | ||
86 | +} | ||
87 | + | ||
88 | +``` | ||
89 | + | ||
90 | + | ||
91 | +## 编辑/开启/关闭品牌接口 | ||
92 | + | ||
93 | +> 接口名: 'brand/editBrand' | ||
94 | + | ||
95 | +### 入参 | ||
96 | + | ||
97 | +------------------------- | ||
98 | +|属性名称|类型|例子|说明| | ||
99 | +|--------|----|----|----| | ||
100 | +|brandId|Number|43|品牌id| | ||
101 | +|status|String|edit|状态,关闭传0,开启传1| | ||
102 | +|brandName|string|nike|品牌名称| | ||
103 | +|brandNameEn|string|aaaa|英文名称| | ||
104 | +|brandDomain|string|yoho|二级域名| | ||
105 | +|brandIco|string|http://static.yohobuy.com/newheader/img/logo_e.png|品牌logo| | ||
106 | +|brandLevel|string|KA|品牌级别| | ||
107 | +|promotionLevel|int|2|品牌推广星级| | ||
108 | +|mainCategory|int|2|主营类目| | ||
109 | +|brandHeadstream|int|2|发源地| | ||
110 | +|brandTypes|int|2|品牌类型| | ||
111 | +|brandUrl|string|www.baidu.com|品牌网址| | ||
112 | +|brandIntro|string|xxxxxx|品牌介绍| | ||
113 | +|brandOutline|string|xxxxxx|品牌简述| | ||
114 | +|brandFounder|string|jay|品牌主理人| | ||
115 | +|brandStyle|string|街头|品牌风格| | ||
116 | +|brandNature|int|4|品牌性质| | ||
117 | +|brandTonality|string|xxxx|调性指数| | ||
118 | +--------------------- | ||
119 | + | ||
120 | +### 返回 | ||
121 | + | ||
122 | +``` json | ||
123 | +{ | ||
124 | + "code":200, | ||
125 | + "message":"请求成功" | ||
126 | +} | ||
127 | + | ||
128 | +``` | ||
129 | + | ||
130 | +## 编辑时品牌详情接口 | ||
131 | + | ||
132 | +> 接口名: 'brand/getBrandDetail' | ||
133 | + | ||
134 | +### 入参 | ||
135 | + | ||
136 | +------------------------- | ||
137 | +|属性名称|类型|例子|说明| | ||
138 | +|--------|----|----|----| | ||
139 | +|brandId|Number|43|品牌id| | ||
140 | +--------------------- | ||
141 | + | ||
142 | +### 返回 | ||
143 | + | ||
144 | +``` json | ||
145 | +{ | ||
146 | + "code":200, | ||
147 | + "message":"请求成功", | ||
148 | + "data": { | ||
149 | + "brandName": "", | ||
150 | + "brandNameEn": "", | ||
151 | + "brandDomain": "", | ||
152 | + "brandIco": "", | ||
153 | + "brandLevel": "", | ||
154 | + "promotionLevel": "", | ||
155 | + "mainCategory": "", | ||
156 | + "brandHeadstream": "", | ||
157 | + "brandTypes": "", | ||
158 | + "brandUrl": "", | ||
159 | + "brandIntro": "", | ||
160 | + "brandOutline": "", | ||
161 | + "brandFounder": "", | ||
162 | + "brandStyle": "", | ||
163 | + "brandNature": "", | ||
164 | + "brandTonality": "" | ||
165 | + } | ||
166 | +} | ||
167 | + | ||
168 | +``` | ||
169 | + | ||
170 | + | ||
171 | +## 品牌获取选择选项的枚举接口 | ||
172 | + | ||
173 | +> 接口名: 'brand/getSelectItems' | ||
174 | + | ||
175 | +### 返回 | ||
176 | + | ||
177 | +``` json | ||
178 | +{ | ||
179 | + "code":200, | ||
180 | + "message":"请求成功", | ||
181 | + "data": { | ||
182 | + "brandLevelItems": [{ //品牌级别 | ||
183 | + "id": "", | ||
184 | + "name": "" | ||
185 | + }], | ||
186 | + "mainCategoryItems": [{ //主营类目 | ||
187 | + "id": "", | ||
188 | + "name": "" | ||
189 | + }], | ||
190 | + "brandHeadstreamItems": [{ //发源地 | ||
191 | + "id": "", | ||
192 | + "name": "" | ||
193 | + }], | ||
194 | + "brandTypesItems": [{ //品牌类型 | ||
195 | + "id": "", | ||
196 | + "name": "" | ||
197 | + }], | ||
198 | + "brandStyleItems": [{ //品牌风格 | ||
199 | + "id": "", | ||
200 | + "name": "" | ||
201 | + }], | ||
202 | + "brandNatureItems": [{ //品牌性质 | ||
203 | + "id": "", | ||
204 | + "name": "" | ||
205 | + }], | ||
206 | + } | ||
207 | +} | ||
208 | + | ||
209 | +``` | ||
210 | + | ||
211 | + | ||
212 | +## 获取品牌列表接口 | ||
213 | + | ||
214 | +> 接口名: 'brand/getBrandName' | ||
215 | + | ||
216 | +### 入参 | ||
217 | + | ||
218 | +------------------------- | ||
219 | +|属性名称|类型|例子|说明| | ||
220 | +|--------|----|----|----| | ||
221 | +|idOrName|Number|43|品牌id或者名称| | ||
222 | +--------------------- | ||
223 | + | ||
224 | +### 返回 | ||
225 | + | ||
226 | +``` json | ||
227 | +{ | ||
228 | + "code":200, | ||
229 | + "message":"请求成功", | ||
230 | + "data": { | ||
231 | + "list": [ | ||
232 | + { | ||
233 | + "id": "", | ||
234 | + “name”:"" | ||
235 | + } | ||
236 | + ] | ||
237 | + } | ||
238 | + | ||
239 | +} | ||
240 | + | ||
241 | +``` |
inferface-document/cms/README.md
0 → 100644
1 | +## CMS接口定义 |
inferface-document/cms/resources.md
0 → 100644
1 | +## 资源位接口定义 | ||
2 | + | ||
3 | +### 查询资源 | ||
4 | + | ||
5 | +> GET `/resources/query` | ||
6 | + | ||
7 | +#### 入参 | ||
8 | + | ||
9 | +----------------------------------------------------------- | ||
10 | +|参数名 |必填 |类型 |示例值 |描述 | | ||
11 | +|------ |---- |---- |------ |---- | | ||
12 | +|name |否 |string |男首页 |资源名称 | | ||
13 | +|sort_id |否 |int |2 |分类编号 | | ||
14 | +|platform_id|否 |int |1 |平台编号 | | ||
15 | +|page |否 |int |1 |页数 | | ||
16 | + | ||
17 | +#### 返回 | ||
18 | + | ||
19 | +``` json | ||
20 | +{ | ||
21 | + "code":200 | ||
22 | + "data":{ | ||
23 | + "number":1, | ||
24 | + "size":10, | ||
25 | + "totalPages":28, | ||
26 | + "totalElements":275, | ||
27 | + "content":[ | ||
28 | + { | ||
29 | + "id":8, | ||
30 | + "name":"男首页", | ||
31 | + "sort_id":2, | ||
32 | + "sort_name":"男首", | ||
33 | + "platform_id":1, | ||
34 | + "platform_name":"yohoApp", | ||
35 | + "code":"201504091403001", | ||
36 | + "match_code":"", | ||
37 | + "create_time":1430378310, | ||
38 | + "sort_list":[ | ||
39 | + { | ||
40 | + "sort_id":2, | ||
41 | + "sort_name":"男首", | ||
42 | + "platform_id":"1", | ||
43 | + "create_time":1430304722, | ||
44 | + "status":1 | ||
45 | + } | ||
46 | + ], | ||
47 | + "plat_list":[ | ||
48 | + { | ||
49 | + "platform_id":1, | ||
50 | + "platform_name":"yohoApp", | ||
51 | + "platform_flag":"iphone", | ||
52 | + "create_time":1430300615, | ||
53 | + "status":1 | ||
54 | + } | ||
55 | + ] | ||
56 | + } | ||
57 | + ] | ||
58 | + } | ||
59 | +} | ||
60 | + | ||
61 | +``` | ||
62 | +----------------------------- | ||
63 | +|参数名 |描述 | | ||
64 | +|------ |---- | | ||
65 | +|number |页数 | | ||
66 | +|size |每页个数 | | ||
67 | +|totalPages |总页数 | | ||
68 | +|totalElements |总个数 | | ||
69 | +|content |内容 | | ||
70 | +|id |资源编号 | | ||
71 | +|name |资源名称 | | ||
72 | +|sort_id |分类编号 | | ||
73 | +|sort_name |分类名称 | | ||
74 | +|platform_id|平台编号 | | ||
75 | +|platform_name|平台名称 | | ||
76 | +|code |资源码 | | ||
77 | +|match_code |配对码 | | ||
78 | +|create_time|创建时间 | | ||
79 | +|sort_list |分类列表 | | ||
80 | +|plat_list |平台列表 | |
1 | +优惠码接口服务定义 | ||
2 | +--------------------- | ||
3 | + | ||
4 | +## 查询优惠码列表接口 | ||
5 | + | ||
6 | +> 接口名: `portal.couponCode.getList` | ||
7 | + | ||
8 | +### 入参 | ||
9 | + | ||
10 | +------------------------- | ||
11 | +|属性名称|类型|例子|说明| | ||
12 | +|--------|----|----|----| | ||
13 | +|id|int|123|优惠码标示| | ||
14 | +|name|string|50元优惠码|优惠码名称| | ||
15 | +|req_department|string|零售部/运营部|申请部门| | ||
16 | +|state|int|1|状态| | ||
17 | +|limit|int|20|分页| | ||
18 | +|offset|int|0|第几个| | ||
19 | +--------------------- | ||
20 | + | ||
21 | +### 返回 | ||
22 | + | ||
23 | +``` json | ||
24 | +{ | ||
25 | + "code":200 | ||
26 | + "list": | ||
27 | + [ | ||
28 | + { | ||
29 | + "id":123, | ||
30 | + "name":"50元优惠券", | ||
31 | + "limit_times":10, | ||
32 | + "req_department":"零售部/运营部", | ||
33 | + "limit_date_from":"2016-01-16 00:00:00", | ||
34 | + "limit_date_to":"2016-01-20 00:00:00", | ||
35 | + "describe":"xxxxxxx", | ||
36 | + "staff":"李四", | ||
37 | + "state":0 | ||
38 | + } | ||
39 | + ], | ||
40 | + "total":100, | ||
41 | + "limit":20, | ||
42 | + "offset:0 | ||
43 | +} | ||
44 | + | ||
45 | +``` | ||
46 | + | ||
47 | + | ||
48 | +## 查询优惠码详情接口 | ||
49 | +> 接口名: `portal.couponCode.detail` | ||
50 | + | ||
51 | +### 入参 | ||
52 | + | ||
53 | +------------------------- | ||
54 | +|属性名称|类型|例子|说明| | ||
55 | +|--------|----|----|----| | ||
56 | +|id|int|123|优惠码标示| | ||
57 | +--------------------------- | ||
58 | + | ||
59 | +### 返回 | ||
60 | + | ||
61 | +```json | ||
62 | + | ||
63 | +{ | ||
64 | + "code":200 | ||
65 | + "info": | ||
66 | + { | ||
67 | + "id":123, | ||
68 | + "name":"50元优惠券", | ||
69 | + "limit_times":10, | ||
70 | + "code":"sdads123123,dasd", | ||
71 | + "req_department":"零售部/运营部", | ||
72 | + "limit_date_from":"2016-01-16 00:00:00", | ||
73 | + "limit_date_to":"2016-01-20 00:00:00", | ||
74 | + "promotion_info": | ||
75 | + { | ||
76 | + "type": "discount_market_price", | ||
77 | + "condition": { | ||
78 | + "amount_at_least": 100, | ||
79 | + "count_at_least": 1 | ||
80 | + }, | ||
81 | + "action": { | ||
82 | + "discount": 0.88, | ||
83 | + "discount_at_most": 100 | ||
84 | + } | ||
85 | + }, | ||
86 | + "user_use_limit":10, | ||
87 | + "user_source_limit":"iSO", | ||
88 | + "user_type_limit":"new_reg",//no_buy:未购买,new_reg:新注册 | ||
89 | + "describe":"xxxxxxx", | ||
90 | + "staff":"李四", | ||
91 | + "state":0 | ||
92 | + } | ||
93 | +} | ||
94 | +``` | ||
95 | + | ||
96 | +> 促销信息详细参考[优惠码表设计](http://git.dev.yoho.cn/yoho30/yohobuy-order/blob/master/promotion_code.md) | ||
97 | + | ||
98 | +## 新增优惠码接口(修改) | ||
99 | + | ||
100 | +> 接口名: `portal.couponCode.add` | ||
101 | +> 接口名: `portal.couponCode.update` | ||
102 | + | ||
103 | +------------------------- | ||
104 | +|属性名称|类型|例子|说明| | ||
105 | +|--------|----|----|----| | ||
106 | +|id|int|123|优惠码标示(修改的时候需要提交)| | ||
107 | +|name|string|50元优惠码|优惠码名称| | ||
108 | +|code|string|VA32434|码值| | ||
109 | +|req_department|string|零售部/运营部|申请部门| | ||
110 | +|limit_date_from|string|2016-01-16 00:00:00|优惠开始时间| | ||
111 | +|limit_date_to|string|2016-01-16 00:00:00|优惠结束时间| | ||
112 | +|promotion_info|string|参见如下json|促销信息| | ||
113 | +|user_use_limit|int|10|使用限制次数| | ||
114 | +|user_source_limit|string|iOS|用户来源| | ||
115 | +|user_type_limit|string|no_buy|用户类型(未购买,新注册)| | ||
116 | +|describe|string|xxxx|描述| | ||
117 | +|staff|string|李四|员工| | ||
118 | +---------------------------- | ||
119 | + | ||
120 | +```json | ||
121 | +{ | ||
122 | + "type": "discount_market_price", | ||
123 | + "condition": { | ||
124 | + "amount_at_least": 100, | ||
125 | + "count_at_least": 1 | ||
126 | + }, | ||
127 | + "action": { | ||
128 | + "discount": 0.88, | ||
129 | + "discount_at_most": 100 | ||
130 | + } | ||
131 | +} | ||
132 | +``` | ||
133 | +### 返回 | ||
134 | + | ||
135 | +```json | ||
136 | +{ | ||
137 | + "code":20001, | ||
138 | + "message":"保存成功!" | ||
139 | +} | ||
140 | + | ||
141 | +//or | ||
142 | + | ||
143 | +{ | ||
144 | + "code":5001, | ||
145 | + "message":"保存失败" | ||
146 | +} | ||
147 | + | ||
148 | +``` | ||
149 | + | ||
150 | +## 审核优惠码接口(通过,驳回,作废) | ||
151 | + | ||
152 | +> 接口名:`portal.couponCode.setState` | ||
153 | + | ||
154 | +### 入参 | ||
155 | + | ||
156 | +------------------------- | ||
157 | +|属性名称|类型|例子|说明| | ||
158 | +|--------|----|----|----| | ||
159 | +|id|int|123|优惠码标示(修改的时候需要提交)| | ||
160 | +|state|int|1|状态| | ||
161 | +------------------- | ||
162 | + | ||
163 | +### 返回 | ||
164 | + | ||
165 | +```json | ||
166 | +{ | ||
167 | + "code":20001, | ||
168 | + "message":"设置成功!" | ||
169 | +} | ||
170 | + | ||
171 | +//or | ||
172 | + | ||
173 | +{ | ||
174 | + "code":50002, | ||
175 | + "message":"设置失败" | ||
176 | +} | ||
177 | +``` | ||
178 | + | ||
179 | + | ||
180 | +--------------------------- | ||
181 | + | ||
182 | +其他接口,可以暂时写死的方式 | ||
183 | + | ||
184 | +## 登陆 | ||
185 | + | ||
186 | +> 接口名: portal.system.login | ||
187 | + | ||
188 | +### 入参 | ||
189 | + | ||
190 | +------------------------- | ||
191 | +|属性名称|类型|例子|说明| | ||
192 | +|--------|----|----|----| | ||
193 | +|user|string|admin|用户名| | ||
194 | +|password|string|123321|密码| | ||
195 | +----------------------------- | ||
196 | + | ||
197 | +### 返回 | ||
198 | + | ||
199 | +```json | ||
200 | + | ||
201 | +{ | ||
202 | + "code":20003 | ||
203 | + "data": | ||
204 | + { | ||
205 | + "auth":123123 | ||
206 | + } | ||
207 | +} | ||
208 | + | ||
209 | +//or | ||
210 | + | ||
211 | +{ | ||
212 | + "code":50003 | ||
213 | + "message": "登录失败!" | ||
214 | +} | ||
215 | + | ||
216 | +``` | ||
217 | + | ||
218 | +## 获取权限菜单 | ||
219 | + | ||
220 | +> 接口名: portal.system.menu | ||
221 | + | ||
222 | +### 入参 | ||
223 | + | ||
224 | +------------------------- | ||
225 | +|属性名称|类型|例子|说明| | ||
226 | +|--------|----|----|----| | ||
227 | +|auth|int|123123|后台用户ID| | ||
228 | +----------------------------- | ||
229 | + | ||
230 | +### 返回 | ||
231 | + | ||
232 | +```json | ||
233 | + | ||
234 | +{ | ||
235 | + list:[ | ||
236 | + { | ||
237 | + title:'首页', | ||
238 | + href:'/', | ||
239 | + icon:'home' | ||
240 | + }, | ||
241 | + { | ||
242 | + title:'页面模板', | ||
243 | + parent:true, | ||
244 | + list:[ | ||
245 | + { | ||
246 | + title:'个人资料', | ||
247 | + href:'/chart02', | ||
248 | + icon:'check' | ||
249 | + }, | ||
250 | + { | ||
251 | + title:'帮助页', | ||
252 | + href:'/test', | ||
253 | + icon:'puzzle-piece' | ||
254 | + }, | ||
255 | + { | ||
256 | + title:'404', | ||
257 | + href:'/404', | ||
258 | + icon:'bug' | ||
259 | + } | ||
260 | + ] | ||
261 | + } | ||
262 | + ] | ||
263 | +} | ||
264 | + | ||
265 | +``` | ||
266 | + | ||
267 | + | ||
268 | +## 获取部门信息 | ||
269 | + | ||
270 | +```json | ||
271 | +var department = | ||
272 | +{ | ||
273 | + list:[ | ||
274 | + { | ||
275 | + "name":"零售部", | ||
276 | + "id":1, | ||
277 | + "sub":[ | ||
278 | + { | ||
279 | + "name":"商品部", | ||
280 | + "id":11 | ||
281 | + } | ||
282 | + ] | ||
283 | + } | ||
284 | + ] | ||
285 | + | ||
286 | +} | ||
287 | + | ||
288 | +``` |
inferface-document/coupon_code/flow.png
0 → 100644
51.3 KB
1 | + | ||
2 | +## 1.数据库 | ||
3 | +### 1.1 优惠码详情(yhb_promotion.promotion_code) | ||
4 | +#### sql 脚本 | ||
5 | +```sql | ||
6 | +CREATE TABLE `promotion_code` ( | ||
7 | + `id` int(11) NOT NULL AUTO_INCREMENT, | ||
8 | + `name` varchar(225) NOT NULL, | ||
9 | + `limit_times` int(11) NOT NULL DEFAULT '0', | ||
10 | + `code` varchar(255) NOT NULL, | ||
11 | + `req_department` varchar(255) DEFAULT NULL, | ||
12 | + `limit_date_from` varchar(255) NOT NULL, | ||
13 | + `limit_date_to` varchar(255) NOT NULL, | ||
14 | + `describe` varchar(255) DEFAULT '', | ||
15 | + `promotion_info` text NOT NULL, | ||
16 | + `user_use_limit` int(11) DEFAULT '1', | ||
17 | + `user_source_limit` varchar(255) DEFAULT NULL, | ||
18 | + `user_type_limit` varchar(255) DEFAULT NULL, | ||
19 | + `creator_id` int(11) DEFAULT NULL, | ||
20 | + `create_time` varchar(255) DEFAULT NULL, | ||
21 | + `status` int(11) NOT NULL DEFAULT '0', | ||
22 | + PRIMARY KEY (`id`), | ||
23 | + KEY `code_index` (`code`) USING BTREE | ||
24 | +) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8; | ||
25 | + | ||
26 | +``` | ||
27 | + | ||
28 | +#### 说明 | ||
29 | + | ||
30 | +| 列名 | 说明 | 可用范围 | | ||
31 | +| -------- | -------- |-------- | | ||
32 | +|name| 名称| | | ||
33 | +|limit_times| 本优惠码使用次数限制|默认0,表示无限制| | ||
34 | +| code | 码值 | 用`,`分割| | ||
35 | +| req_department | 请求部门 | | | ||
36 | +| limit_date_from | 使用期限,从xxx | 格式如下: 2015-12-31 12:23:12| | ||
37 | +| limit_date_to | 使用期限,到xxx | 格式如下: 2015-12-31 12:23:12| | ||
38 | +| describe | 描述信息 | | | ||
39 | +| user_use_limit|用户使用本优惠码次数限制|默认1,只能使用1次| | ||
40 | +| user_source_limit | 用户来源 | IOS, Android| | ||
41 | +| user_type_limit | 会员身份 | 1(新注册),2(注册未购买)| | ||
42 | +| creator_id | 创建者 | | | ||
43 | +| create_time | 创建时间 | 格式如下: 2015-12-31 12:23:12 | | ||
44 | +| promotion_info | 优惠信息 | JSON格式| | ||
45 | +| status| 优惠码状态|0: 正常 1:失效| | ||
46 | + | ||
47 | +其中,表中`promotion_info`优惠信息是json格式,如下: | ||
48 | +```javascript | ||
49 | +{ | ||
50 | + "type": "discount_market_price", | ||
51 | + "condition": { | ||
52 | + "amount_at_least": 100, | ||
53 | + "count_at_least": 1 | ||
54 | + }, | ||
55 | + "action": { | ||
56 | + "discount": 0.88, | ||
57 | + "discount_at_most": 100 | ||
58 | + } | ||
59 | +} | ||
60 | +``` | ||
61 | + | ||
62 | +`type` 对应下面3种: | ||
63 | + - discount_market_price: 吊牌价折扣 | ||
64 | + - discount_sale_price: 销售价折扣 | ||
65 | + - discount_total: 满减 | ||
66 | + | ||
67 | + `condition` 是优惠码使用条件,总金额最少和购买件数最少 | ||
68 | + | ||
69 | + `action` 是具体优惠多少钱: | ||
70 | + - discount: 如果是折扣类型,`discount`表示多少折;如果是满减类型,则表示减少多少钱。 | ||
71 | + - discount_at_most: 最多优惠多少钱 | ||
72 | + | ||
73 | + | ||
74 | +### 1.2 优惠码使用记录(yhb_promotion.user_promotion_code_history) | ||
75 | + | ||
76 | +#### SQL 脚本 | ||
77 | +```sql | ||
78 | +CREATE TABLE `user_promotion_code_history` ( | ||
79 | + `id` int(11) NOT NULL AUTO_INCREMENT, | ||
80 | + `uid` int(11) NOT NULL, | ||
81 | + `promotion_code` varchar(255) NOT NULL, | ||
82 | + `used_time` varchar(255) DEFAULT NULL, | ||
83 | + `order_code` varchar(255) DEFAULT NULL, | ||
84 | + `is_use` int(11) NOT NULL, | ||
85 | + PRIMARY KEY (`id`) | ||
86 | +) ENGINE=InnoDB DEFAULT CHARSET=utf8; | ||
87 | + | ||
88 | +``` | ||
89 | +#### 说明 | ||
90 | + | ||
91 | +| 列名 | 说明 | | ||
92 | +| -------- | -------- | | ||
93 | +|uid| 用户ID| | | ||
94 | +|promotion_code| 码值| | ||
95 | +| used_time | 使用时间 | 格式如下: 2015-12-31 12:23:12| | ||
96 | +| describe | 描述信息 | | ||
97 | +| order_code|订单号| | ||
98 | +| is_use| 是否使用 | 0 未使用,1 已经使用| | ||
99 | + | ||
100 | + | ||
101 | +## 2. 流程 | ||
102 | + | ||
103 | +![alt text](flow.png "flow") | ||
104 | + | ||
105 | + | ||
106 | +## 3. 接口 | ||
107 | + | ||
108 | +### 3.1 Gateway接口 | ||
109 | +#### 3.1.1 查询优惠码详情 | ||
110 | +请求: | ||
111 | +- POST URL: `api.yoho.cn` | ||
112 | +- content-type: `'x-www-form-urlencoded'` | ||
113 | +- body: `uid=123456&code=dx12999&method=app.promotion_code.get` | ||
114 | + | ||
115 | + | ||
116 | +响应: | ||
117 | +```javascript | ||
118 | +{ | ||
119 | + "is_availble": true, | ||
120 | + "code_info" : { | ||
121 | + "id": 12, | ||
122 | + "name": "8折", | ||
123 | + "limit_times": 0, | ||
124 | + "describe": "this is describe", | ||
125 | + "discount_type": "discount_market_price", | ||
126 | + "amount_at_least": 200, | ||
127 | + "count_at_least": 1, | ||
128 | + "discount": 0.8, | ||
129 | + "discount_at_most": 100 | ||
130 | + "status": 0 | ||
131 | + } | ||
132 | + | ||
133 | +} | ||
134 | +``` | ||
135 | +| json | 说明 | | ||
136 | +| -------- | -------- | | ||
137 | +| is_availble | 用户对优惠码是否可用 | | ||
138 | +| code_info | 优惠码信息 | | ||
139 | + | ||
140 | + | ||
141 | + | ||
142 | +### 3.2 服务接口 | ||
143 | +#### 3.2.1 Promotion 查询优惠码详情 | ||
144 | +入参: `uid, promotion_code` | ||
145 | + | ||
146 | +响应:同上面的gateway接口 | ||
147 | + | ||
148 | +判断用户对某个优惠码是否可用的逻辑: | ||
149 | + | ||
150 | +1.判断Promotion Code本身是否有效: | ||
151 | + | ||
152 | + - 根据promotion_code,获取promotion_code详情 | ||
153 | + - 是否在有效期内 | ||
154 | + - 状态是否启用 | ||
155 | + - 全局使用次数是否达到限制(当前不做) | ||
156 | + | ||
157 | +2.判断用户对promotion_code是否可用: | ||
158 | + | ||
159 | + - 判断用户来源是否匹配(IOS,Android) | ||
160 | + - 判断用户类型是否匹配(当前只匹配新注册,注册未下单) | ||
161 | + - 判断用户对优惠码使用限制(需要从user_promotion_code_history表中找出记录, 当前只要有记录,则认为已经使用,后续考虑退货、订单取消的情况) | ||
162 | + | ||
163 | + | ||
164 | +#### 3.2.2 Promotion 添加用户使用优惠码记录 |
46.4 KB
inferface-document/coupon_code/supplier.md
0 → 100644
1 | +供应商接口服务定义 | ||
2 | +--------------------- | ||
3 | + | ||
4 | +## 供应商信息查询接口 | ||
5 | + | ||
6 | +> 接口名: `/interface/supplier/info` | ||
7 | + | ||
8 | +### 入参 | ||
9 | + | ||
10 | +------------------------- | ||
11 | +|属性名称|类型|例子|说明| | ||
12 | +|--------|----|----|----| | ||
13 | +|id|int|123|供应商信息查询| | ||
14 | +--------------------- | ||
15 | + | ||
16 | +### 返回 | ||
17 | + | ||
18 | +``` json | ||
19 | +{ | ||
20 | + //公司名称 | ||
21 | + "supplier_name":"南京新与力广告传媒", | ||
22 | + // 营业执照号 | ||
23 | + "supplier_code":"1234567890", | ||
24 | + // 成立日期 | ||
25 | + "found_time":"2015-1-1", | ||
26 | + // 营业期限-start | ||
27 | + "start_time":"2015-1-1", | ||
28 | + // 营业期限-end | ||
29 | + "end_time":"2020-1-1", | ||
30 | + // 注册所在地 | ||
31 | + "registered_address":"中华民国", | ||
32 | + // 法人代表姓名 | ||
33 | + "contact_person":"XXX", | ||
34 | + // 法人身份证电子版 | ||
35 | + "selectIdImage":"https://www.baidu.com/img/baidu_jgylogo3.gif", | ||
36 | + // 注册资本 | ||
37 | + "registered_capital":"1W", | ||
38 | + // 营业执照电子版 | ||
39 | + "selectCodeImage":"https://www.baidu.com/img/baidu_jgylogo3.gif", | ||
40 | + // 经营许可证 | ||
41 | + "selectLicImage":"https://www.baidu.com/img/baidu_jgylogo3.gif", | ||
42 | + // 税务登记证 | ||
43 | + "selecttaxImage":"https://www.baidu.com/img/baidu_jgylogo3.gif", | ||
44 | + // 经营范围 | ||
45 | + "business_range":"小吃", | ||
46 | + // 公司联系电话 | ||
47 | + "contact_phone":"00100100", | ||
48 | + // 公司联系地址 | ||
49 | + "contact_address":"XX省XX市XXX街道10号", | ||
50 | + // 联系人 | ||
51 | + "linkman":"XXX", | ||
52 | + // 联系电话 | ||
53 | + "phone":"001001001001", | ||
54 | + // 传真 | ||
55 | + "fax":"00100100", | ||
56 | + // 邮件地址 | ||
57 | + "email":"XXX@qq.com", | ||
58 | + // 网址 | ||
59 | + "email":"www.google.cn", | ||
60 | + // 开户行 | ||
61 | + "bank_name":"ICBC", | ||
62 | + // 开户账号 | ||
63 | + "bank_account":"001010001001" | ||
64 | +} | ||
65 | + | ||
66 | +``` |
inferface-document/pact.md
0 → 100644
1 | +合同管理接口定义 | ||
2 | +--------------------- | ||
3 | + | ||
4 | +### 筛选数据及分页 | ||
5 | +``` json | ||
6 | + | ||
7 | +{ | ||
8 | + brandName: [{ //供应商名称 | ||
9 | + value: '', //value值 | ||
10 | + name: '' //显示的文字 | ||
11 | + }], | ||
12 | + supplierName: [{ //品牌名称 | ||
13 | + value: '', //value值 | ||
14 | + name: '' //显示的文字 | ||
15 | + }], | ||
16 | + pagination: 143 //总页数 | ||
17 | +} | ||
18 | + | ||
19 | +``` | ||
20 | +### 合同创建 -> 列表数据 | ||
21 | +``` json | ||
22 | + | ||
23 | +{ | ||
24 | + data: [{ | ||
25 | + name: '', //合同名称 | ||
26 | + number: '', //合同编号 | ||
27 | + supplier: '', //供应商名称 | ||
28 | + brand: ['PUCCA', '111', '333'], //包含品牌(格式:数组) | ||
29 | + pattern: '代销入库', //经营模式 | ||
30 | + attr: '主合同', //合同属性 | ||
31 | + timeFrom: '2015-12-31', //有效期开始 | ||
32 | + timeTo: '2016-12-30', //有效期结束 | ||
33 | + recentOperation: '创建', //最近操作 | ||
34 | + status: 0 //状态(0:审核中, 2:审核驳回, 3:暂存) | ||
35 | + }, { | ||
36 | + ... | ||
37 | + }] | ||
38 | +} | ||
39 | + | ||
40 | +``` | ||
41 | +### 合同创建 -> 添加合同 -> 列表数据 | ||
42 | +``` json | ||
43 | + | ||
44 | +{ | ||
45 | + data: [{ | ||
46 | + name: '', //供应商 | ||
47 | + pattern: '代销入库', //经营模式 | ||
48 | + operate: true //操作(true: 可添加主合同, false: 可添加补充合同) | ||
49 | + }, { | ||
50 | + ... | ||
51 | + }] | ||
52 | +} | ||
53 | + | ||
54 | +``` | ||
55 | +### 合同管理 -> 列表数据 | ||
56 | +``` json | ||
57 | + | ||
58 | +{ | ||
59 | + data: [{ | ||
60 | + name: '', //合同名称 | ||
61 | + number: '16YH33', //合同编号 | ||
62 | + supplier: '', //供应商名称 | ||
63 | + brand: ['PUCCA'], //包含品牌(格式:数组) | ||
64 | + pattern: '代销入库', //经营模式 | ||
65 | + attr: '主合同', //合同属性 | ||
66 | + timeFrom: '2015-12-31', //有效期开始 | ||
67 | + timeTo: '2016-12-30', //有效期结束 | ||
68 | + operate: 1 (0: 解约, 1: 生效中, 2: 合同过期) //操作状态 | ||
69 | + }, { | ||
70 | + ... | ||
71 | + }] | ||
72 | +} | ||
73 | + | ||
74 | +``` | ||
75 | +### 合同审核 -> 列表数据 | ||
76 | +``` json | ||
77 | + | ||
78 | +{ | ||
79 | + data: [{ | ||
80 | + name: '', //合同名称 | ||
81 | + number: '16YH33', //合同编号 | ||
82 | + supplier: '', //供应商名称 | ||
83 | + brand: ['PUCCA'], //包含品牌(格式:数组) | ||
84 | + pattern: '代销入库', //经营模式 | ||
85 | + attr: '主合同', //合同属性 | ||
86 | + time: '2016-01-13', //创建时间 | ||
87 | + timeFrom: '2015-12-31', //有效期开始 | ||
88 | + timeTo: '2016-12-30' //有效期结束 | ||
89 | + }, { | ||
90 | + ... | ||
91 | + }] | ||
92 | +} | ||
93 | + | ||
94 | +``` | ||
95 | + | ||
96 | + | ||
97 | +## 添加品牌接口 | ||
98 | + | ||
99 | +> 接口名: `/interface/brand/add` | ||
100 | + | ||
101 | +### 入参 | ||
102 | + | ||
103 | +------------------------- | ||
104 | +|属性名称|类型|例子|说明| | ||
105 | +|--------|----|----|----| | ||
106 | +|contractsdatas|string|JSON|合同名称| | ||
107 | +|agreement_end_time|string|2016-01-05|有效期开始时间| | ||
108 | +|agreement_start_time|string|2016-01-05|有效期结束时间| | ||
109 | +|agreement_name|string|xxxx|合同名称| | ||
110 | +|agreement_code|string|xxxx|合同编号| | ||
111 | +|settlement_period|string|1|结算周期| | ||
112 | +|invoice_type|string|1|发票类型| | ||
113 | +|selectImage|string|http://img01.yohoboys.com/o_1a9mt81m1to11hg0d5t13de1idj7.png|纸质合同| | ||
114 | +|id|int|1|品牌ID| | ||
115 | +--------------------- | ||
116 | + | ||
117 | +``` json | ||
118 | +[ | ||
119 | + {"operation_service":{"type":"1","name":"代运营-YOHO运营","value":"0.00"}, | ||
120 | + "photographic_service":{"type":"1","name":"使用摄影服务","value":"0.00"}, | ||
121 | + "size_service":{"type":"1","name":"使用尺码测量","value":"0.00"}, | ||
122 | + "storage_service_koudian":"0.00", | ||
123 | + "ruledatas":[ | ||
124 | + { | ||
125 | + "maxSort":{"name":"所有一级目录","value":"0"}, | ||
126 | + "middleSort":{"name":"所有二级目录","value":"0"}, | ||
127 | + "smallSort":{"name":"所有三级目录","value":"0"}, | ||
128 | + "sort":{"name":"所有四级目录","value":"0"}, | ||
129 | + "commissions":[{"zhe":"0","kou":"0.00"}], | ||
130 | + "discount":"0", | ||
131 | + "key":"0-0-0-0" | ||
132 | + } | ||
133 | + ], | ||
134 | + "supplier_name":{"name":"上海热力贸易有限公司","value":"1120"} | ||
135 | + } | ||
136 | +] | ||
137 | + | ||
138 | +``` | ||
139 | + | ||
140 | + | ||
141 | +### 返回 | ||
142 | + | ||
143 | +``` json | ||
144 | +{ | ||
145 | + "code":200, | ||
146 | + "message":"添加成功!" | ||
147 | +} | ||
148 | + | ||
149 | +``` | ||
150 | + | ||
151 | + | ||
152 | + | ||
153 | +## 修改品牌接口 | ||
154 | + | ||
155 | +> 接口名: `/interface/brand/update` | ||
156 | + | ||
157 | +### 入参 | ||
158 | + | ||
159 | +------------------------- | ||
160 | +|属性名称|类型|例子|说明| | ||
161 | +|--------|----|----|----| | ||
162 | +|contractsdatas|string|JSON|合同名称| | ||
163 | +|agreement_end_time|string|2016-01-05|有效期开始时间| | ||
164 | +|agreement_start_time|string|2016-01-05|有效期结束时间| | ||
165 | +|agreement_name|string|xxxx|合同名称| | ||
166 | +|agreement_code|string|xxxx|合同编号| | ||
167 | +|settlement_period|string|1|结算周期| | ||
168 | +|invoice_type|string|1|发票类型| | ||
169 | +|selectImage|string|http://img01.yohoboys.com/o_1a9mt81m1to11hg0d5t13de1idj7.png|纸质合同| | ||
170 | +|id|int|1|品牌ID| | ||
171 | +--------------------- | ||
172 | + | ||
173 | +``` json | ||
174 | +[ | ||
175 | + {"operation_service":{"type":"1","name":"代运营-YOHO运营","value":"0.00"}, | ||
176 | + "photographic_service":{"type":"1","name":"使用摄影服务","value":"0.00"}, | ||
177 | + "size_service":{"type":"1","name":"使用尺码测量","value":"0.00"}, | ||
178 | + "storage_service_koudian":"0.00", | ||
179 | + "ruledatas":[ | ||
180 | + { | ||
181 | + "maxSort":{"name":"所有一级目录","value":"0"}, | ||
182 | + "middleSort":{"name":"所有二级目录","value":"0"}, | ||
183 | + "smallSort":{"name":"所有三级目录","value":"0"}, | ||
184 | + "sort":{"name":"所有四级目录","value":"0"}, | ||
185 | + "commissions":[{"zhe":"0","kou":"0.00"}], | ||
186 | + "discount":"0", | ||
187 | + "key":"0-0-0-0" | ||
188 | + } | ||
189 | + ], | ||
190 | + "supplier_name":{"name":"上海热力贸易有限公司","value":"1120"} | ||
191 | + } | ||
192 | +] | ||
193 | + | ||
194 | +``` | ||
195 | + | ||
196 | + | ||
197 | +### 返回 | ||
198 | + | ||
199 | +``` json | ||
200 | +{ | ||
201 | + "code":200, | ||
202 | + "message":"添加成功!" | ||
203 | +} | ||
204 | + | ||
205 | +``` | ||
206 | + |
inferface-document/product.md
0 → 100644
1 | +# 产品管理接口服务定义 | ||
2 | +--------------------- | ||
3 | + | ||
4 | +# 添加(更新)品类接口 | ||
5 | + | ||
6 | +> 接口名: `/product/update` | ||
7 | + | ||
8 | +### 入参 | ||
9 | + | ||
10 | +------------------------- | ||
11 | +|属性名称|类型|例子|说明|是否必填| | ||
12 | +|--------|----|----|----|--------| | ||
13 | +|categoryName|string|nike|品类名称|是| | ||
14 | +|categoryAbbr|string|n|品类缩写|是| | ||
15 | +|firstCategory|string|根目录|一级分类|否| | ||
16 | +|secondCategory|string|根目录|二级分类|否| | ||
17 | +|thirdCategory|string|根目录|三级分类|否| | ||
18 | +|categorySort|number|0|排序|否| | ||
19 | +|categoryStatus|boolean|true|状态|否| | ||
20 | +|id|int|1|品类ID| | ||
21 | +--------------------- | ||
22 | + | ||
23 | +### 返回 | ||
24 | + | ||
25 | +``` json | ||
26 | +{ | ||
27 | + "code":200, | ||
28 | + "message":"添加成功!" | ||
29 | +} | ||
30 | + | ||
31 | +``` | ||
32 | + | ||
33 | +# 获取品类列表 | ||
34 | + | ||
35 | +> 接口名: `/product/getClassList` | ||
36 | + | ||
37 | +### 入参 | ||
38 | + | ||
39 | +------------------------- | ||
40 | +|属性名称|类型|例子|说明|是否必填| | ||
41 | +|-------|----|----|----|-------| | ||
42 | +-------------------------------- | ||
43 | + | ||
44 | +### 返回 | ||
45 | + | ||
46 | +``` json | ||
47 | +{ | ||
48 | + code:200, | ||
49 | + message:"", | ||
50 | + data: { | ||
51 | + list: [{ | ||
52 | + categoryName: '', //品类名称 | ||
53 | + categoryAbbr: '', //品类缩写 | ||
54 | + firstCategory: '', //一级分类 | ||
55 | + secondCategory: '', //二级分类 | ||
56 | + thirdCategory: '', //三级分类 | ||
57 | + categorySort: '', //排序 | ||
58 | + categoryStatus: '',//状态, | ||
59 | + id: '', //品类ID | ||
60 | + }] | ||
61 | + page: '', //当前第几页 | ||
62 | + size: '', //每页多少条 | ||
63 | + } | ||
64 | +} | ||
65 | + | ||
66 | +``` | ||
67 | + | ||
68 | + | ||
69 | +# 添加(更新)产品属性接口 | ||
70 | + | ||
71 | +> 接口名: `/product/updateAttr` | ||
72 | + | ||
73 | +### 入参 | ||
74 | + | ||
75 | +------------------------- | ||
76 | +|属性名称|类型|例子|说明|是否必填| | ||
77 | +|--------|----|----|----|--------| | ||
78 | +|attrName|string|衣长|属性名称|未知| | ||
79 | +|saleType|string|非销售属性|销售类型|未知| | ||
80 | +|inputType|string|单选按钮|输入类型|未知| | ||
81 | +|enableSearch|boolean|true|启用搜索|未知| | ||
82 | +|maxVal|number|50|最大输入值|未知| | ||
83 | +|hasAlias|boolean|true|是否允许别名|未知| | ||
84 | +|attrSort|number|0|排序|未知| | ||
85 | +|attrAttr|string|abc|属性值|未知| | ||
86 | +|attrComment|string|abc|备注|否| | ||
87 | +|id|int|1|商品属性ID| | ||
88 | +--------------------- | ||
89 | + | ||
90 | +### 返回 | ||
91 | + | ||
92 | +``` json | ||
93 | +{ | ||
94 | + "code":200, | ||
95 | + "message":"添加成功!" | ||
96 | +} | ||
97 | + | ||
98 | +``` | ||
99 | + | ||
100 | +# 获取产品属性列表接口 | ||
101 | + | ||
102 | +> 接口名: `/product/getAttr` | ||
103 | + | ||
104 | +### 入参 | ||
105 | + | ||
106 | +------------------------- | ||
107 | +|属性名称|类型|例子|说明|是否必填| | ||
108 | +|--------|----|----|----|--------| | ||
109 | +|id|int|1|商品属性ID| | ||
110 | +--------------------- | ||
111 | + | ||
112 | +### 返回 | ||
113 | + | ||
114 | +``` json | ||
115 | +{ | ||
116 | + code:200, | ||
117 | + message:"", | ||
118 | + data: { | ||
119 | + list: [{ | ||
120 | + attrName: '', //属性名称 | ||
121 | + saleType: '', //销售类型 | ||
122 | + inputType: '', //输入类型 | ||
123 | + enableSearch: '', //启用搜索 | ||
124 | + id: '', //品类ID | ||
125 | + }] | ||
126 | + page: '', //当前第几页 | ||
127 | + size: '', //每页多少条 | ||
128 | + } | ||
129 | +} | ||
130 | + | ||
131 | +``` | ||
132 | + | ||
133 | +# 获取产品列表 | ||
134 | + | ||
135 | +> 接口名: `/product/getList` | ||
136 | + | ||
137 | +------------------------- | ||
138 | +|属性名称|类型|例子|说明|是否必填| | ||
139 | +|--------|----|----|----|--------| | ||
140 | +| | | | | | | ||
141 | +--------------------- | ||
142 | + | ||
143 | +### 返回 | ||
144 | + | ||
145 | +``` json | ||
146 | +{ | ||
147 | + code:200, | ||
148 | + message:"", | ||
149 | + data: { | ||
150 | + list: [{ | ||
151 | + //... | ||
152 | + }] | ||
153 | + page: '', //当前第几页 | ||
154 | + size: '', //每页多少条 | ||
155 | + } | ||
156 | +} | ||
157 | + | ||
158 | +``` |
inferface-document/shops.md
0 → 100644
1 | +# 店铺接口服务定义 | ||
2 | +--------------------- | ||
3 | + | ||
4 | +## 创建店铺 | ||
5 | + | ||
6 | +> 接口名:`/shops/createShop` | ||
7 | + | ||
8 | +### 入参 | ||
9 | + | ||
10 | +------------------------- | ||
11 | +|属性名称|类型|例子|说明| | ||
12 | +|--------|----|----|----| | ||
13 | +|shop_name|String|得宝旗舰店|店铺名称| | ||
14 | +|shop_nature|int|1|店铺性质(1 旗舰店 2 专卖店)| | ||
15 | +|shop_domain|String|debao|店铺域名| | ||
16 | +|create_pid|int|1|创建人ID| | ||
17 | +|shop_logo|String|http://img11.static.yhbimg.com/yhb-img01/2015/09/11/02/01f42dff5d5bd383af1025eea1218cbccc.jpg?imageView/{mode}/w/{width}/h/{height}|店铺logo| | ||
18 | +|shop_intro|String|秉承以设计为核心的创新理念,用专业的思维方式将自然与科技、传统与革新、技艺与时尚三者良好融合,着重面料材质与软式廓型的品质互动,更好的诠释“less is more”的设计理念。|店铺简介| | ||
19 | +|shop_admin|JSON数组||| | ||
20 | +|shop_relation|JSON数组||| | ||
21 | +|website_url|JSON数组|["www.paperworks.com.cn"]|| | ||
22 | +|other_url|JSON数组|["www.paperworks.com.cn","https:\/\/jnby.tmall.com\/"]|| | ||
23 | +|shop_address|JSON数组||| | ||
24 | +--------------------- | ||
25 | + | ||
26 | +### 返回 | ||
27 | + | ||
28 | +``` json | ||
29 | +{ | ||
30 | + "code":200 | ||
31 | + "message":"创建成功" | ||
32 | + "shop_id":12 | ||
33 | +} | ||
34 | + | ||
35 | +``` | ||
36 | + | ||
37 | + | ||
38 | +## 获取店铺列表 | ||
39 | +> 接口名: `/shops/getShopList` | ||
40 | + | ||
41 | +### 入参 | ||
42 | + | ||
43 | +------------------------- | ||
44 | +|属性名称|类型|例子|说明| | ||
45 | +|--------|----|----|----| | ||
46 | +|page|int|2|第几页| | ||
47 | +|size|int|50|每页条数| | ||
48 | +|shops_id|int|15|店铺ID| | ||
49 | +|shop_name|String|得宝旗舰店|店铺名称| | ||
50 | +|shop_nature|int|1|店铺性质(1 旗舰店 2 专卖店)| | ||
51 | +|status|int|1|状态(1开启 0 关闭)| | ||
52 | +|check_status|int|300|审核状态(100 暂存 200 待审核 300 审核通过 900 驳回)| | ||
53 | +|supplier_id|int|950|供应商ID| | ||
54 | +|brand_id|int|928|品牌ID| | ||
55 | +--------------------------- | ||
56 | + | ||
57 | +### 返回 | ||
58 | + | ||
59 | +```json | ||
60 | + | ||
61 | +{ | ||
62 | + "code":200 | ||
63 | + "info": | ||
64 | + { | ||
65 | + "id":123, | ||
66 | + "name":"50元优惠券", | ||
67 | + "limit_times":10, | ||
68 | + "code":"sdads123123,dasd", | ||
69 | + "req_department":"零售部/运营部", | ||
70 | + "limit_date_from":"2016-01-16 00:00:00", | ||
71 | + "limit_date_to":"2016-01-20 00:00:00", | ||
72 | + "promotion_info": | ||
73 | + { | ||
74 | + "type": "discount_market_price", | ||
75 | + "condition": { | ||
76 | + "amount_at_least": 100, | ||
77 | + "count_at_least": 1 | ||
78 | + }, | ||
79 | + "action": { | ||
80 | + "discount": 0.88, | ||
81 | + "discount_at_most": 100 | ||
82 | + } | ||
83 | + }, | ||
84 | + "user_use_limit":10, | ||
85 | + "user_source_limit":"iSO", | ||
86 | + "user_type_limit":"new_reg",//no_buy:未购买,new_reg:新注册 | ||
87 | + "describe":"xxxxxxx", | ||
88 | + "staff":"李四", | ||
89 | + "state":0 | ||
90 | + } | ||
91 | +} | ||
92 | +``` | ||
93 | + | ||
94 | +## 店铺同步 | ||
95 | +> 接口名: `/shops/saveOrUpdateShop` | ||
96 | + | ||
97 | +### 入参 | ||
98 | + | ||
99 | +------------------------- | ||
100 | +|属性名称|类型|例子|说明| | ||
101 | +|--------|----|----|----| | ||
102 | +|shop_name|String|得宝旗舰店|店铺名称| | ||
103 | +|shop_nature|int|1|店铺性质(1 旗舰店 2 专卖店)| | ||
104 | +|shop_domain|String|debao|店铺域名| | ||
105 | +|create_pid|int|1|创建人ID| | ||
106 | +shop_logo|String|http://img11.static.yhbimg.com/yhb-img01/2015/09/11/02/01f42dff5d5bd383af1025eea1218cbccc.jpg?imageView/{mode}/w/{width}/h/{height}|店铺logo| | ||
107 | +|shop_intro|String|秉承以设计为核心的创新理念,用专业的思维方式将自然与科技、传统与革新、技艺与时尚三者良好融合,着重面料材质与软式廓型的品质互动,更好的诠释“less is more”的设计理念。|店铺简介| | ||
108 | +|shop_admin|JSON数组||| | ||
109 | +|shop_relation|JSON数组||| | ||
110 | +|website_url|JSON数组|["www.paperworks.com.cn"]|| | ||
111 | +|other_url|JSON数组|["www.paperworks.com.cn","https:\/\/jnby.tmall.com\/"]|| | ||
112 | +|shop_address|JSON数组||| | ||
113 | +--------------------------- | ||
114 | + | ||
115 | +### 返回 | ||
116 | + | ||
117 | +```json | ||
118 | + | ||
119 | +{ | ||
120 | + "code":200 | ||
121 | + "message":"修改成功" | ||
122 | +} | ||
123 | +``` | ||
124 | + | ||
125 | +## 根据店铺名查看是否存在 | ||
126 | + | ||
127 | +> 接口名:`/shops/checkByShopName` | ||
128 | + | ||
129 | +### 入参 | ||
130 | + | ||
131 | +------------------------- | ||
132 | +|属性名称|类型|例子|说明| | ||
133 | +|--------|----|----|----| | ||
134 | +|shop_name|String|得宝旗舰店|店铺名称| | ||
135 | +|shops_id|int|15|店铺ID| | ||
136 | +------------------- | ||
137 | + | ||
138 | +### 返回 | ||
139 | + | ||
140 | +```json | ||
141 | +{ | ||
142 | + "code":20001, | ||
143 | + "message":"设置成功!" | ||
144 | +} | ||
145 | + | ||
146 | +//or | ||
147 | + | ||
148 | +{ | ||
149 | + "code":50002, | ||
150 | + "message":"设置失败" | ||
151 | +} | ||
152 | +``` | ||
153 | + | ||
154 | + | ||
155 | +## 根据店铺域名查看是否存在 | ||
156 | + | ||
157 | +> 接口名: `/shops/checkByShopDomain` | ||
158 | + | ||
159 | +### 入参 | ||
160 | + | ||
161 | +------------------------- | ||
162 | +|属性名称|类型|例子|说明| | ||
163 | +|--------|----|----|----| | ||
164 | +|shop_domain|String|debao|店铺域名| | ||
165 | +|shops_id|int|15|店铺ID| | ||
166 | +----------------------------- | ||
167 | + | ||
168 | +### 返回 | ||
169 | + | ||
170 | +```json | ||
171 | + | ||
172 | +{ | ||
173 | + "code":20003 | ||
174 | + "data": | ||
175 | + { | ||
176 | + "auth":123123 | ||
177 | + } | ||
178 | +} | ||
179 | + | ||
180 | +//or | ||
181 | + | ||
182 | +{ | ||
183 | + "code":50003 | ||
184 | + "message": "登录失败!" | ||
185 | +} | ||
186 | + | ||
187 | +``` | ||
188 | + | ||
189 | +## 获取店铺详情 | ||
190 | + | ||
191 | +> 接口名: `/shops/getDetailByShopId` | ||
192 | + | ||
193 | +### 入参 | ||
194 | + | ||
195 | +------------------------- | ||
196 | +|属性名称|类型|例子|说明| | ||
197 | +|--------|----|----|----| | ||
198 | +|shops_id|int|15|店铺ID| | ||
199 | +----------------------------- | ||
200 | + | ||
201 | +### 返回 | ||
202 | + | ||
203 | +```json | ||
204 | + | ||
205 | +{ | ||
206 | + list:[ | ||
207 | + { | ||
208 | + title:'首页', | ||
209 | + href:'/', | ||
210 | + icon:'home' | ||
211 | + }, | ||
212 | + { | ||
213 | + title:'页面模板', | ||
214 | + parent:true, | ||
215 | + list:[ | ||
216 | + { | ||
217 | + title:'个人资料', | ||
218 | + href:'/chart02', | ||
219 | + icon:'check' | ||
220 | + }, | ||
221 | + { | ||
222 | + title:'帮助页', | ||
223 | + href:'/test', | ||
224 | + icon:'puzzle-piece' | ||
225 | + }, | ||
226 | + { | ||
227 | + title:'404', | ||
228 | + href:'/404', | ||
229 | + icon:'bug' | ||
230 | + } | ||
231 | + ] | ||
232 | + } | ||
233 | + ] | ||
234 | +} | ||
235 | + | ||
236 | +``` | ||
237 | + | ||
238 | + |
inferface-document/supplier.md
0 → 100644
1 | +供应商接口服务定义 | ||
2 | +--------------------- | ||
3 | +#### 创建供应商页接口 | ||
4 | + | ||
5 | +> 接口名: '' | ||
6 | + | ||
7 | +##### 入参 | ||
8 | +|属性名称|类型|例子|说明| | ||
9 | +|--------|----|----|----| | ||
10 | +|id|int|10|id| | ||
11 | +|status|int|100|供应商状态(100:暂存,200:审核中,300:通过, 900: 驳回)| | ||
12 | +|timeSort|string|asc,desc|排序(asc:正序, desc:倒序)| | ||
13 | +#### 返回 | ||
14 | + | ||
15 | +``` json | ||
16 | +{ | ||
17 | + "code": 200, | ||
18 | + "message": "请求成功", | ||
19 | + "dade":[{ | ||
20 | + //id | ||
21 | + "id":10, | ||
22 | + //供应商名称 | ||
23 | + "supplierName":"南京新与力广告传媒", | ||
24 | + // 更新时间 | ||
25 | + "updateTime":"2016-01-14 16:30:23", | ||
26 | + // 供应商状态 | ||
27 | + "status":100, | ||
28 | + // 是否冻结 | ||
29 | + "isFreeze":"Y", | ||
30 | + // 最近操作 | ||
31 | + "operations":"1" | ||
32 | + }] | ||
33 | +} | ||
34 | + | ||
35 | +``` | ||
36 | +#### 供应商列表页接口 | ||
37 | + | ||
38 | +> 接口名: '' | ||
39 | + | ||
40 | +##### 入参 | ||
41 | +|属性名称|类型|例子|说明| | ||
42 | +|--------|----|----|----| | ||
43 | +|supplierId|int|10|供应商名称| | ||
44 | +|status|int|100|供应商状态(100:暂存,200:审核中,300:通过, 900: 驳回)| | ||
45 | +|isFreeze|string|Y,N|生效状态(Y:已冻结, N:生效中)| | ||
46 | +##### 返回 | ||
47 | +> 同创建供应商页接口 | ||
48 | +#### 供应商审核列表页接口 | ||
49 | + | ||
50 | +> 接口名: '' | ||
51 | + | ||
52 | +##### 入参 | ||
53 | +|属性名称|类型|例子|说明| | ||
54 | +|--------|----|----|----| | ||
55 | +|supplierId|int|100|供应商名称| | ||
56 | +##### 返回 | ||
57 | + | ||
58 | +> 同创建供应商页接口 | ||
59 | + | ||
60 | +#### 供应商新增编辑接口 | ||
61 | +> 接口名: '' | ||
62 | +##### 入参 | ||
63 | +|属性名称|类型|例子|说明| | ||
64 | +|--------|----|----|----| | ||
65 | +|status|int|100|供应商状态(100:暂存,200:提交审核)| | ||
66 | +|supplierName|String|nike|供应商名称| | ||
67 | +|supplierCode|String|123456|营业执照号| | ||
68 | +|foundTime|Date|2012-12-12|成立日期| | ||
69 | +|beginOperateTime|Date|2012-12-12|经营开始时间| | ||
70 | +|endOperateTime|Date|2012-12-12|经营结束时间| | ||
71 | +|registeredAddress|string|澳门|公司注册地址| | ||
72 | +|legalPerson|string|张三|法人代表姓名| | ||
73 | +|registeredCapital|string|nike|注册资本| | ||
74 | +|contactPhone|string|nike|公司联系电话| | ||
75 | +|contactAddress|string|xx省xx市|公司联系地址| | ||
76 | +||||必填项,选填项不在其中| | ||
77 | + | ||
78 | +##### 返回 | ||
79 | +``` json | ||
80 | +{ | ||
81 | + "code": 200, | ||
82 | + "message": "保存成功", | ||
83 | +} | ||
84 | + | ||
85 | +``` | ||
86 | + | ||
87 | +#### 供应商审核接口 | ||
88 | +> 接口名: '' | ||
89 | + | ||
90 | +##### 入参 | ||
91 | +|属性名称|类型|例子|说明| | ||
92 | +|--------|----|----|----| | ||
93 | +|supplierId|int|10|供应商名称| | ||
94 | +|status|int|100|供应商状态(100:暂存,200:审核中,300:通过, 900: 驳回)| | ||
95 | +##### 返回 | ||
96 | +``` json | ||
97 | +{ | ||
98 | + "code": 200, | ||
99 | + "message": "提交成功", | ||
100 | +} | ||
101 | + | ||
102 | +``` | ||
103 | + | ||
104 | +#### 供应商冻结解冻接口 | ||
105 | +> 接口名: '' | ||
106 | + | ||
107 | +##### 入参 | ||
108 | +|属性名称|类型|例子|说明| | ||
109 | +|--------|----|----|----| | ||
110 | +|supplierId|int|10|供应商名称| | ||
111 | +|isFreeze|string|Y,N|生效状态(Y:已冻结, N:生效中)| | ||
112 | +##### 返回 | ||
113 | +``` json | ||
114 | +{ | ||
115 | + "code": 200, | ||
116 | + "message": "修改成功", | ||
117 | +} | ||
118 | + | ||
119 | +``` | ||
120 | +##### 查看供应商接口 | ||
121 | +> 接口名: '' | ||
122 | + | ||
123 | +##### 入参 | ||
124 | +|属性名称|类型|例子|说明| | ||
125 | +|--------|----|----|----| | ||
126 | +|id|int|123|供应商信息查询| | ||
127 | + | ||
128 | +##### 返回 | ||
129 | + | ||
130 | +``` json | ||
131 | +{ | ||
132 | + //公司名称 | ||
133 | + "supplierName":"南京新与力广告传媒", | ||
134 | + // 营业执照号 | ||
135 | + "supplierCode":"1234567890", | ||
136 | + // 成立日期 | ||
137 | + "foundTime":"2015-1-1", | ||
138 | + // 营业期限-start | ||
139 | + "beginOperateTime":"2015-1-1", | ||
140 | + // 营业期限-end | ||
141 | + "endOperateTime":"2020-1-1", | ||
142 | + // 注册所在地 | ||
143 | + "registeredAddress":"中华民国", | ||
144 | + // 法人代表姓名 | ||
145 | + "legalPerson":"XXX", | ||
146 | + // 法人身份证电子版 | ||
147 | + "legalIdentityCard":"https://www.baidu.com/img/baidu_jgylogo3.gif", | ||
148 | + // 注册资本 | ||
149 | + "registeredCapital":"1W", | ||
150 | + // 营业执照电子版 | ||
151 | + "":"https://www.baidu.com/img/baidu_jgylogo3.gif", | ||
152 | + // 经营许可证 | ||
153 | + "":"https://www.baidu.com/img/baidu_jgylogo3.gif", | ||
154 | + // 税务登记证 | ||
155 | + "":"https://www.baidu.com/img/baidu_jgylogo3.gif", | ||
156 | + // 经营范围 | ||
157 | + "businessRange":"小吃", | ||
158 | + // 公司联系电话 | ||
159 | + "contactPhone":"00100100", | ||
160 | + // 公司联系地址 | ||
161 | + "contactAddress":"XX省XX市XXX街道10号", | ||
162 | + // 联系人 | ||
163 | + "linkman":"XXX", | ||
164 | + // 联系电话 | ||
165 | + "phone":"001001001001", | ||
166 | + // 传真 | ||
167 | + "fax":"00100100", | ||
168 | + // 邮件地址 | ||
169 | + "email":"XXX@qq.com", | ||
170 | + // 网址 | ||
171 | + "url":"www.google.cn", | ||
172 | + // 开户行 | ||
173 | + "bankName":"ICBC", | ||
174 | + // 开户账号 | ||
175 | + "bankAccount":"001010001001" | ||
176 | +} | ||
177 | + | ||
178 | +``` |
1 | +# 供应商列表接口定义 | ||
2 | + | ||
3 | +### 筛选数据及分页 | ||
4 | +``` json | ||
5 | + | ||
6 | +{ | ||
7 | + supplierName: [{ //供应商名称 | ||
8 | + value: '', //value值 | ||
9 | + name: '' //显示的文字 | ||
10 | + }], | ||
11 | + pagination: 143 //总页数 | ||
12 | +} | ||
13 | + | ||
14 | +``` | ||
15 | +### 创建供应商 -> 列表数据 | ||
16 | +``` json | ||
17 | + | ||
18 | +{ | ||
19 | + data: [{ | ||
20 | + name: '', //供应商名字 | ||
21 | + updateTime: '', //更新时间 | ||
22 | + status: 2 //状态值 (0:审核中, 2:审核驳回) | ||
23 | + }, { | ||
24 | + ... | ||
25 | + }] | ||
26 | +} | ||
27 | + | ||
28 | +``` | ||
29 | +### 供应商列表 -> 列表数据 | ||
30 | +``` json | ||
31 | + | ||
32 | +{ | ||
33 | + data: [{ | ||
34 | + name: '心飞扬有限公司', //供应商名字 | ||
35 | + updateTime: '', //更新时间 | ||
36 | + recentOperation: '编辑', //最近操作 | ||
37 | + status: 2, //状态值 (0:审核中, 1:审核成功) | ||
38 | + valid: 1 //是否有效 (0:冻结, 1:生效) | ||
39 | + }, { | ||
40 | + ... | ||
41 | + }] | ||
42 | +} | ||
43 | + | ||
44 | +``` | ||
45 | +### 供应商审核 -> 列表数据 | ||
46 | +``` json | ||
47 | + | ||
48 | +{ | ||
49 | + data: [{ | ||
50 | + name: '', //供应商名字 | ||
51 | + updateTime: '', //更新时间 | ||
52 | + recentOperation: '' //最近操作 | ||
53 | + }, { | ||
54 | + ... | ||
55 | + }] | ||
56 | +} | ||
57 | + | ||
58 | +``` | ||
59 | + | ||
60 | + | ||
61 | +# 品牌管理列表接口定义 | ||
62 | + | ||
63 | +### 筛选数据及分页 | ||
64 | +``` json | ||
65 | + | ||
66 | +{ | ||
67 | + brandName: [{ //品牌名称 | ||
68 | + value: '', //value值 | ||
69 | + name: '' //显示的文字 | ||
70 | + }], | ||
71 | + brandLevel: [{ //品牌级别 | ||
72 | + name: '' //显示的文字 | ||
73 | + }], | ||
74 | + pagination: 143 //总页数 | ||
75 | +} | ||
76 | + | ||
77 | + | ||
78 | +``` | ||
79 | +### 品牌管理 -> 列表数据 | ||
80 | +``` json | ||
81 | + | ||
82 | +{ | ||
83 | + data: [{ | ||
84 | + logo: '', //logo图片地址 | ||
85 | + nameCn: '心飞扬', //品牌中文名字 | ||
86 | + nameEn: 'xinfeiyang', //品牌英文名字 | ||
87 | + level: 'KA', //级别 | ||
88 | + score: '0', //调性分 | ||
89 | + time: '2016-01-18 11:18:20', //创建时间 | ||
90 | + operate: 1 //1为开启状态,0为关闭状态 | ||
91 | + }, { | ||
92 | + ... | ||
93 | + }] | ||
94 | +} | ||
95 | + | ||
96 | +``` | ||
97 | + | ||
98 | +# 合同管理列表接口定义 | ||
99 | + | ||
100 | +### 筛选数据及分页 | ||
101 | +``` json | ||
102 | + | ||
103 | +{ | ||
104 | + brandName: [{ //供应商名称 | ||
105 | + value: '', //value值 | ||
106 | + name: '' //显示的文字 | ||
107 | + }], | ||
108 | + supplierName: [{ //品牌名称 | ||
109 | + value: '', //value值 | ||
110 | + name: '' //显示的文字 | ||
111 | + }], | ||
112 | + pagination: 143 //总页数 | ||
113 | +} | ||
114 | + | ||
115 | +``` | ||
116 | +### 合同创建 -> 列表数据 | ||
117 | +``` json | ||
118 | + | ||
119 | +{ | ||
120 | + data: [{ | ||
121 | + name: '', //合同名称 | ||
122 | + number: '', //合同编号 | ||
123 | + supplier: '', //供应商名称 | ||
124 | + brand: ['PUCCA', '111', '333'], //包含品牌(格式:数组) | ||
125 | + pattern: '代销入库', //经营模式 | ||
126 | + attr: '主合同', //合同属性 | ||
127 | + timeFrom: '2015-12-31', //有效期开始 | ||
128 | + timeTo: '2016-12-30', //有效期结束 | ||
129 | + recentOperation: '创建', //最近操作 | ||
130 | + status: 0 //状态(0:审核中, 2:审核驳回, 3:暂存) | ||
131 | + }, { | ||
132 | + ... | ||
133 | + }] | ||
134 | +} | ||
135 | + | ||
136 | +``` | ||
137 | +### 合同创建 -> 添加合同 -> 列表数据 | ||
138 | +``` json | ||
139 | + | ||
140 | +{ | ||
141 | + data: [{ | ||
142 | + name: '', //供应商 | ||
143 | + pattern: '代销入库', //经营模式 | ||
144 | + operate: true //操作(true: 可添加主合同, false: 可添加补充合同) | ||
145 | + }, { | ||
146 | + ... | ||
147 | + }] | ||
148 | +} | ||
149 | + | ||
150 | +``` | ||
151 | +### 合同管理 -> 列表数据 | ||
152 | +``` json | ||
153 | + | ||
154 | +{ | ||
155 | + data: [{ | ||
156 | + name: '', //合同名称 | ||
157 | + number: '16YH33', //合同编号 | ||
158 | + supplier: '', //供应商名称 | ||
159 | + brand: ['PUCCA'], //包含品牌(格式:数组) | ||
160 | + pattern: '代销入库', //经营模式 | ||
161 | + attr: '主合同', //合同属性 | ||
162 | + timeFrom: '2015-12-31', //有效期开始 | ||
163 | + timeTo: '2016-12-30', //有效期结束 | ||
164 | + operate: 1 (0: 解约, 1: 生效中, 2: 合同过期) //操作状态 | ||
165 | + }, { | ||
166 | + ... | ||
167 | + }] | ||
168 | +} | ||
169 | + | ||
170 | +``` | ||
171 | +### 合同审核 -> 列表数据 | ||
172 | +``` json | ||
173 | + | ||
174 | +{ | ||
175 | + data: [{ | ||
176 | + name: '', //合同名称 | ||
177 | + number: '16YH33', //合同编号 | ||
178 | + supplier: '', //供应商名称 | ||
179 | + brand: ['PUCCA'], //包含品牌(格式:数组) | ||
180 | + pattern: '代销入库', //经营模式 | ||
181 | + attr: '主合同', //合同属性 | ||
182 | + time: '2016-01-13', //创建时间 | ||
183 | + timeFrom: '2015-12-31', //有效期开始 | ||
184 | + timeTo: '2016-12-30' //有效期结束 | ||
185 | + }, { | ||
186 | + ... | ||
187 | + }] | ||
188 | +} | ||
189 | + | ||
190 | +``` |
-
Please register or login to post a comment