Merge branch 'develop' of http://git.dev.yoho.cn/platform/yohobuy-doc into develop
Showing
17 changed files
with
2518 additions
and
236 deletions
1 | -平台服务接口公共参数 | ||
2 | -====== | ||
3 | -###### 平台页面端在向平台服务发起请求时应该携带以下参数, | ||
4 | -###### 便于后台问题定位和操作回溯 | ||
5 | - | ||
6 | ---- | ||
7 | -页面传入参数(参数通过扩展HTTP头方式提供) | ||
8 | -------------------------- | ||
9 | -|属性名称|类型|例子|说明| | ||
10 | -|--------|----|----|----| | ||
11 | -|x-user-id|string|0|用户ID| | ||
12 | -|x-user-name|string|admin|用户名| | ||
13 | -|x-site-type|string|1|站点类型:1-运营平台 2-商家平台| | ||
14 | -|x-client-ip|string|192.168.0.1|客户端IP| | ||
15 | - | ||
16 | ---- | ||
17 | -服务调用传入参数示例: | ||
18 | -POST /xx/xx HTTP/1.1\r\n | ||
19 | -... http standard headers... | ||
20 | -x-user-id:0\r\n | ||
21 | -x-user-name:admin\r\n | ||
22 | -x-size-type:1\r\n | ||
23 | -x-client-ip:192.168.0.1\r\n | ||
24 | -\r\n | ||
25 | -...json body.. | ||
26 | - | ||
27 | - | 1 | +平台服务接口公共参数 |
2 | +====== | ||
3 | +###### 平台页面端在向平台服务发起请求时应该携带以下参数, | ||
4 | +###### 便于后台问题定位和操作回溯 | ||
5 | + | ||
6 | +--- | ||
7 | +页面传入参数(参数通过扩展HTTP头方式提供) | ||
8 | +------------------------- | ||
9 | +|属性名称|类型|例子|说明| | ||
10 | +|--------|----|----|----| | ||
11 | +|x-user-id|string|0|用户ID| | ||
12 | +|x-user-name|string|admin|用户名| | ||
13 | +|x-site-type|string|1|站点类型:1-运营平台 2-商家平台| | ||
14 | +|x-client-ip|string|192.168.0.1|客户端IP| | ||
15 | + | ||
16 | +--- | ||
17 | +服务调用传入参数示例: | ||
18 | +``` | ||
19 | +POST /xx/xx HTTP/1.1\r\n | ||
20 | +... http standard headers... | ||
21 | +x-user-id:0\r\n | ||
22 | +x-user-name:admin\r\n | ||
23 | +x-size-type:1\r\n | ||
24 | +x-client-ip:192.168.0.1\r\n | ||
25 | +\r\n | ||
26 | +...json body.. | ||
27 | +``` | ||
28 | + |
inferface-document/brandSeries.md
0 → 100644
1 | +# 品牌款型系列管理接口服务定义 | ||
2 | +--------------------- | ||
3 | + | ||
4 | +# 添加品牌款型系列接口 | ||
5 | + | ||
6 | +> 接口名: `/brandSeries/add` | ||
7 | + | ||
8 | +### 入参 | ||
9 | + | ||
10 | +------------------------- | ||
11 | +|属性名称|类型|例子|说明|是否必填| | ||
12 | +|--------|----|----|----|--------| | ||
13 | +|seriesName | string | 羽绒服系列 |名称|是| | ||
14 | +|shopsId | int | 1 | 店铺id | 是| | ||
15 | +|brandId | int | 1 | 店铺id下的某个品牌id | 是| | ||
16 | +|type | int | 1 | 1:"品牌款型";2:"品牌系列" | 是| | ||
17 | +|orderBy | int | 1 | 排序值 | 否| | ||
18 | +--------------------- | ||
19 | + | ||
20 | +### 返回 | ||
21 | + | ||
22 | +``` json | ||
23 | +{ | ||
24 | + "code":200,--若失败为500 | ||
25 | + "message":"success" | ||
26 | +} | ||
27 | + | ||
28 | +``` | ||
29 | + | ||
30 | + | ||
31 | +# 获取品牌款型系列列表(有分页) | ||
32 | + | ||
33 | +> 接口名: `/brandSeries/queryAll` | ||
34 | + | ||
35 | +### 入参 | ||
36 | + | ||
37 | +------------------------- | ||
38 | +|属性名称|类型|例子|说明|是否必填| | ||
39 | +|-------|----|----|----|-------| | ||
40 | +|seriesName | string | 羽绒服系列 |名称|是| | ||
41 | +|shopsId | int | 1 | 店铺id | 是| | ||
42 | +|brandId | int | 1 | 店铺id下的某个品牌id | 是| | ||
43 | +|type | int | 1 | 1:"品牌款型";2:"品牌系列" | 是| | ||
44 | +|page | int | 1 | 页码数,默认1 | 否| | ||
45 | +|size | int | 10 | 记录数,默认10条 | 否| | ||
46 | +-------------------------------- | ||
47 | + | ||
48 | +### 返回 | ||
49 | + | ||
50 | +``` json | ||
51 | +{ | ||
52 | + "code": 200,--若失败为500 | ||
53 | + "data": { | ||
54 | + "list": [ | ||
55 | + { | ||
56 | + "brandId": 5, | ||
57 | + "id": 48, | ||
58 | + "seriesName": "test-cc-u", | ||
59 | + "shopsId": 5, | ||
60 | + "status": 1, | ||
61 | + "type": 5 | ||
62 | + } | ||
63 | + ], | ||
64 | + "page": 0,-第几页 | ||
65 | + "size": 0,-单页记录数 | ||
66 | + "total": 437,--总数 | ||
67 | + "totalPage": 1--总页数 | ||
68 | + }, | ||
69 | + "md5": "81531967e3291781f608555ca63ccd28", | ||
70 | + "message": "success" | ||
71 | +} | ||
72 | + | ||
73 | +``` | ||
74 | + | ||
75 | + | ||
76 | +# 更新品牌款型系列接口 | ||
77 | + | ||
78 | +> 接口名: `/brandSeries/update` | ||
79 | + | ||
80 | +### 入参 | ||
81 | + | ||
82 | +------------------------- | ||
83 | +|属性名称|类型|例子|说明|是否必填| | ||
84 | +|--------|----|----|----|--------| | ||
85 | +|id|int|15|ID|是| | ||
86 | +|seriesName | string | 羽绒服系列 |名称|否| | ||
87 | +|shopsId | int | 1 | 店铺id | 否| | ||
88 | +|brandId | int | 1 | 店铺id下的某个品牌id | 否| | ||
89 | +|type | int | 1 | 1:"品牌款型";2:"品牌系列" | 否| | ||
90 | +|orderBy | int | 1 | 排序值 | 否| | ||
91 | +--------------------- | ||
92 | + | ||
93 | +### 返回 | ||
94 | + | ||
95 | +``` json | ||
96 | +{ | ||
97 | + "code": 200,--若失败为500 | ||
98 | + "data": [], | ||
99 | + "md5": "d751713988987e9331980363e24189ce", | ||
100 | + "message": "success" | ||
101 | +} | ||
102 | + | ||
103 | +``` | ||
104 | + | ||
105 | + | ||
106 | + | ||
107 | +# 获取单个品牌款型系列接口 | ||
108 | + | ||
109 | +> 接口名: `/brandSeries/queryById/{id}` | ||
110 | + | ||
111 | +{id} 具体的品牌款型系列id值,数据类型:int | ||
112 | +例:/brandSeries/queryById/14 | ||
113 | + | ||
114 | +http method : get & post all ok; | ||
115 | + | ||
116 | +### 入参 | ||
117 | + | ||
118 | +------------------------- | ||
119 | +|属性名称|类型|例子|说明|是否必填| | ||
120 | +|--------|----|----|----|--------| | ||
121 | + | ||
122 | +--------------------- | ||
123 | + | ||
124 | +### 返回 | ||
125 | + | ||
126 | +``` json | ||
127 | +{ | ||
128 | + "code": 200,--若失败为500 | ||
129 | + "data":{ | ||
130 | + "brandId": 286, | ||
131 | + "id": 13, | ||
132 | + "orderBy": 4, | ||
133 | + "parentId": 0, | ||
134 | + "seriesName": "Mikio Sakabe", | ||
135 | + "shopsId": 1, | ||
136 | + "status": 1 | ||
137 | + }, | ||
138 | + "md5": "dfc645ecb0c66c8d4771dd2a749047e8", | ||
139 | + "message": "success" | ||
140 | +} | ||
141 | + | ||
142 | +``` | ||
143 | + | ||
144 | +# 打开品牌款型系列接口 | ||
145 | + | ||
146 | +> 接口名: `/brandSeries/open/{id}` | ||
147 | + | ||
148 | +{id} 具体的品牌款型系列id值,数据类型:int | ||
149 | +例:/brandSeries/open/14 | ||
150 | + | ||
151 | +### 入参 | ||
152 | + | ||
153 | +------------------------- | ||
154 | +|属性名称|类型|例子|说明|是否必填| | ||
155 | +|--------|----|----|----|--------| | ||
156 | + | ||
157 | +--------------------- | ||
158 | + | ||
159 | +### 返回 | ||
160 | + | ||
161 | +``` json | ||
162 | +{ | ||
163 | + "code": 200,--若失败为500 | ||
164 | + "data": [], | ||
165 | + "md5": "dfc645ecb0c66c8d4771dd2a749047e8", | ||
166 | + "message": "success" | ||
167 | +} | ||
168 | + | ||
169 | +``` | ||
170 | + | ||
171 | +# 关闭品牌款型系列接口(restfull 风格) | ||
172 | + | ||
173 | +> 接口名: `/brandSeries/close/{id}` | ||
174 | + | ||
175 | +{id} 具体的品牌款型系列id值,数据类型:int | ||
176 | +例:/brandSeries/close/14 | ||
177 | + | ||
178 | +### 入参 | ||
179 | + | ||
180 | +------------------------- | ||
181 | +|属性名称|类型|例子|说明|是否必填| | ||
182 | +|--------|----|----|----|--------| | ||
183 | + | ||
184 | +--------------------- | ||
185 | + | ||
186 | +### 返回 | ||
187 | + | ||
188 | +``` json | ||
189 | +{ | ||
190 | + "code": 200,--若失败为500 | ||
191 | + "data": [ ], | ||
192 | + "md5": "dfc645ecb0c66c8d4771dd2a749047e8", | ||
193 | + "message": "success" | ||
194 | +} | ||
195 | + | ||
196 | +``` |
inferface-document/cms/activity_template.md
0 → 100644
1 | +# 活动模板接口服务定义 | ||
2 | +---------------------- | ||
3 | + | ||
4 | +# 查询模板列表接口 | ||
5 | + | ||
6 | +> 接口名:`activityTemplate/selectTemplateList` | ||
7 | + | ||
8 | +### 入参 | ||
9 | + | ||
10 | +---------------------------------- | ||
11 | +|属性名称|类型|例子|说明|是否必填| | ||
12 | +|--------|----|----|----|--------| | ||
13 | +|status|integer|1|状态:0 不启用 ,1 启用 |否| | ||
14 | +---------------------------------- | ||
15 | + | ||
16 | +### 返回 | ||
17 | + | ||
18 | +``` json | ||
19 | +{ | ||
20 | + "code":200, | ||
21 | + "message":"请求成功", | ||
22 | + "data": [ | ||
23 | + { | ||
24 | + "createTime": 1453966206, | ||
25 | + "id": 1, | ||
26 | + "image": "", // 图片链接 | ||
27 | + "shareId": 0, | ||
28 | + "status": 1, // 0 不启用 ,1 启用 | ||
29 | + "title": "", | ||
30 | + "url": "" | ||
31 | + } | ||
32 | + ] | ||
33 | +} | ||
34 | +``` | ||
35 | + | ||
36 | +# 添加模板接口 | ||
37 | + | ||
38 | +> 接口名:`activityTemplate/addTemplate` | ||
39 | + | ||
40 | +### 入参 | ||
41 | + | ||
42 | +---------------------------------- | ||
43 | +|属性名称|类型|例子|说明|是否必填| | ||
44 | +|--------|----|----|----|--------| | ||
45 | +|title|string|新人专享活动模板|模板标题|是| | ||
46 | +|image|string|http://yoho.cn/18282.jpg|图片地址|否| | ||
47 | +|url|string|http://yoho.cn/18282.template|模板地址|否| | ||
48 | +|shareId|integer|1|共享ID|否| | ||
49 | +---------------------------------- | ||
50 | + | ||
51 | +### 返回 | ||
52 | + | ||
53 | +``` json | ||
54 | +{ | ||
55 | + "code":200, | ||
56 | + "message":"添加成功!" | ||
57 | +} | ||
58 | +``` | ||
59 | + | ||
60 | +# 更新模板接口 | ||
61 | + | ||
62 | +> 接口名:`activityTemplate/updateTeplate` | ||
63 | + | ||
64 | +### 入参 | ||
65 | + | ||
66 | +---------------------------------- | ||
67 | +|属性名称|类型|例子|说明|是否必填| | ||
68 | +|--------|----|----|----|--------| | ||
69 | +|id|integer|1|主键|是| | ||
70 | +|title|string|新人专享活动模板|模板标题|是| | ||
71 | +|image|string|http://yoho.cn/18282.jpg|图片地址|否| | ||
72 | +|url|string|http://yoho.cn/18282.template|模板地址|否| | ||
73 | +|shareId|integer|1|共享ID|否| | ||
74 | +---------------------------------- | ||
75 | + | ||
76 | +### 返回 | ||
77 | + | ||
78 | +``` json | ||
79 | +{ | ||
80 | + "code":200, | ||
81 | + "message":"添加成功!" | ||
82 | +} | ||
83 | +``` | ||
84 | + | ||
85 | +# 开启模板接口 | ||
86 | + | ||
87 | +> 接口名:`activityTemplate/publishTemplate` | ||
88 | + | ||
89 | +### 入参 | ||
90 | + | ||
91 | +---------------------------------- | ||
92 | +|属性名称|类型|例子|说明|是否必填| | ||
93 | +|--------|----|----|----|--------| | ||
94 | +|id|integer|1|主键|是| | ||
95 | +---------------------------------- | ||
96 | + | ||
97 | +### 返回 | ||
98 | + | ||
99 | +``` json | ||
100 | +{ | ||
101 | + "code":200, | ||
102 | + "message":"操作成功!" | ||
103 | +} | ||
104 | +``` | ||
105 | + | ||
106 | +# 关闭模板接口 | ||
107 | + | ||
108 | +> 接口名:`activityTemplate/closeTemplate` | ||
109 | + | ||
110 | +### 入参 | ||
111 | + | ||
112 | +---------------------------------- | ||
113 | +|属性名称|类型|例子|说明|是否必填| | ||
114 | +|--------|----|----|----|--------| | ||
115 | +|id|integer|1|主键|是| | ||
116 | +---------------------------------- | ||
117 | + | ||
118 | +### 返回 | ||
119 | + | ||
120 | +``` json | ||
121 | +{ | ||
122 | + "code":200, | ||
123 | + "message":"操作成功!" | ||
124 | +} | ||
125 | +``` | ||
126 | + | ||
127 | +# 根据条件查询活动商品列表接口 | ||
128 | + | ||
129 | +> 接口名:`activityTemplate/getProductListByCondition` | ||
130 | + | ||
131 | +### 入参 | ||
132 | + | ||
133 | +---------------------------------- | ||
134 | +|属性名称|类型|例子|说明|是否必填| | ||
135 | +|--------|----|----|----|--------| | ||
136 | +|templateId|integer|1|模板ID|是| | ||
137 | +|productSkn|integer|1|商品SKN|否| | ||
138 | +---------------------------------- | ||
139 | + | ||
140 | +### 返回 | ||
141 | + | ||
142 | +``` json | ||
143 | +{ | ||
144 | + "code": 200, | ||
145 | + "data": { | ||
146 | + "list": [ | ||
147 | + { | ||
148 | + "id": 1, | ||
149 | + "isRecommend": true, | ||
150 | + "orderBy": 110, | ||
151 | + "productSkn": 51125277, | ||
152 | + "status": 1, | ||
153 | + "templateId": 2 | ||
154 | + } | ||
155 | + ], | ||
156 | + "page": 1, | ||
157 | + "size": 10, | ||
158 | + "total": 1, | ||
159 | + "totalPage": 1 | ||
160 | + }, | ||
161 | + "message": "Temp SKN list" | ||
162 | +} | ||
163 | +``` | ||
164 | + | ||
165 | +# 插入活动商品信息接口 | ||
166 | + | ||
167 | +> 接口名:`activityTemplate/insertProduct` | ||
168 | + | ||
169 | +### 入参 | ||
170 | + | ||
171 | +---------------------------------- | ||
172 | +|属性名称|类型|例子|说明|是否必填| | ||
173 | +|--------|----|----|----|--------| | ||
174 | +|templateId|integer|1|模板ID|是| | ||
175 | +|productSkn|integer|1|商品SKN|是| | ||
176 | +---------------------------------- | ||
177 | + | ||
178 | +### 返回 | ||
179 | + | ||
180 | +``` json | ||
181 | +{ | ||
182 | + "code": 200, | ||
183 | + "message": "添加成功", | ||
184 | +} | ||
185 | +``` | ||
186 | + | ||
187 | + | ||
188 | +# 更新商品信息接口 | ||
189 | + | ||
190 | +> 接口名:`activityTemplate/updateProduct` | ||
191 | + | ||
192 | +### 入参 | ||
193 | + | ||
194 | +---------------------------------- | ||
195 | +|属性名称|类型|例子|说明|是否必填| | ||
196 | +|--------|----|----|----|--------| | ||
197 | +|id|integer|1|商品ID|是| | ||
198 | +|orderBy|integer|1|排序号|否| | ||
199 | +|isRecommend|integer|1|是否推荐|否| | ||
200 | +|status|integer|1|是否启用|否| | ||
201 | +---------------------------------- | ||
202 | + | ||
203 | +### 返回 | ||
204 | + | ||
205 | +``` json | ||
206 | +{ | ||
207 | + "code": 200, | ||
208 | + "message": "操作成功", | ||
209 | +} | ||
210 | +``` | ||
211 | + | ||
212 | +# 删除商品信息接口 | ||
213 | + | ||
214 | +> 接口名:`activityTemplate/delOneProduct` | ||
215 | + | ||
216 | +### 入参 | ||
217 | + | ||
218 | +---------------------------------- | ||
219 | +|属性名称|类型|例子|说明|是否必填| | ||
220 | +|--------|----|----|----|--------| | ||
221 | +|id|integer|1|主键|是| | ||
222 | +---------------------------------- | ||
223 | + | ||
224 | +### 返回 | ||
225 | + | ||
226 | +如果删除失败,可能是没有删除权限。 | ||
227 | + | ||
228 | +``` json | ||
229 | +{ | ||
230 | + "code":200, | ||
231 | + "message":"操作成功!" | ||
232 | +} | ||
233 | +``` | ||
234 | + |
inferface-document/cms/help_content.md
0 → 100644
1 | +# 帮助内容接口服务定义 | ||
2 | +--------------------- | ||
3 | + | ||
4 | +## 添加帮助内容 | ||
5 | + | ||
6 | +> 接口名:`/HelpContentRest/addHelpContent` | ||
7 | + | ||
8 | +### 入参 | ||
9 | +``` json | ||
10 | +{ | ||
11 | + "title":"补开发票", | ||
12 | + "categoryId":13, | ||
13 | + "content":"如订单未选择发票需要补寄,请您联系有货客服,我们可以为您补开三个自然月内订单的发票,但是需运费到付。", | ||
14 | + "platform":"iphone,android" | ||
15 | +} | ||
16 | +``` | ||
17 | +------------------------- | ||
18 | +|属性名称|类型|例子|说明| | ||
19 | +|--------|----|----|----| | ||
20 | +|title|String|补开发票|帮助标题| | ||
21 | +|categoryId|int|13|分类ID| | ||
22 | +|content|String|如订单未选择发票需要补寄,请您联系有货客服,我们可以为您补开三个自然月内订单的发票,但是需运费到付。|帮助内容| | ||
23 | +|platform|String|iphone,android|显示平台| | ||
24 | +--------------------- | ||
25 | + | ||
26 | +### 返回 | ||
27 | + | ||
28 | +``` json | ||
29 | +{ | ||
30 | + "code": 200, | ||
31 | + "message": "Add Help Content Success" | ||
32 | +} | ||
33 | +{ | ||
34 | + "code":400 | ||
35 | + "message":"帮助标题不能为空" | ||
36 | +} | ||
37 | +{ | ||
38 | + "code":400 | ||
39 | + "message":"分类ID无效" | ||
40 | +} | ||
41 | +{ | ||
42 | + "code":400 | ||
43 | + "message":"内容无效" | ||
44 | +} | ||
45 | +{ | ||
46 | + "code":400 | ||
47 | + "message":"显示平台无效" | ||
48 | +} | ||
49 | +{ | ||
50 | + "code":500 | ||
51 | + "message":"Add Help Content Fail" | ||
52 | +} | ||
53 | +``` | ||
54 | + | ||
55 | + | ||
56 | +## 修改帮助内容 | ||
57 | + | ||
58 | +> 接口名:`/HelpContentRest/updateHelpContent` | ||
59 | + | ||
60 | +### 入参 | ||
61 | +``` json | ||
62 | +{ | ||
63 | + "id":44, | ||
64 | + "title":"补开发票", | ||
65 | + "categoryId":13, | ||
66 | + "platform":"iphone,android,h5", | ||
67 | + "content":"如订单未选择发票需要补寄,请您联系有货客服,我们可以为您补开三个自然月内订单的发票,但是需运费到付。" | ||
68 | +} | ||
69 | +``` | ||
70 | +------------------------- | ||
71 | +|属性名称|类型|例子|说明| | ||
72 | +|--------|----|----|----| | ||
73 | +|id|int|44|帮助内容记录ID| | ||
74 | +|title|String|补开发票|帮助标题| | ||
75 | +|categoryId|int|13|分类ID| | ||
76 | +|content|String|如订单未选择发票需要补寄,请您联系有货客服,我们可以为您补开三个自然月内订单的发票,但是需运费到付。|帮助内容| | ||
77 | +|platform|String|iphone,android|显示平台| | ||
78 | +--------------------- | ||
79 | + | ||
80 | +### 返回 | ||
81 | + | ||
82 | +``` json | ||
83 | +{ | ||
84 | + "code": 200, | ||
85 | + "message": "Update Help Content Success" | ||
86 | +} | ||
87 | +{ | ||
88 | + "code":400 | ||
89 | + "message":"Id is null" | ||
90 | +} | ||
91 | +{ | ||
92 | + "code":400 | ||
93 | + "message":"帮助标题不能为空" | ||
94 | +} | ||
95 | +{ | ||
96 | + "code":400 | ||
97 | + "message":"分类ID无效" | ||
98 | +} | ||
99 | +{ | ||
100 | + "code":400 | ||
101 | + "message":"内容无效" | ||
102 | +} | ||
103 | +{ | ||
104 | + "code":400 | ||
105 | + "message":"显示平台无效" | ||
106 | +} | ||
107 | +{ | ||
108 | + "code":500 | ||
109 | + "message":"Upodate Help Content Fail" | ||
110 | +} | ||
111 | +``` | ||
112 | + | ||
113 | +## 根据ID获得帮助内容 | ||
114 | + | ||
115 | +> 接口名:`/HelpContentRest/getHelpContentById` | ||
116 | + | ||
117 | +### 入参 | ||
118 | +``` json | ||
119 | +{ | ||
120 | + "id":44 | ||
121 | +} | ||
122 | +``` | ||
123 | +------------------------- | ||
124 | +|属性名称|类型|例子|说明| | ||
125 | +|--------|----|----|----| | ||
126 | +|id|int|44|帮助内容记录ID| | ||
127 | +--------------------- | ||
128 | + | ||
129 | +### 返回 | ||
130 | + | ||
131 | +``` json | ||
132 | +{ | ||
133 | + "code": 200, | ||
134 | + "data": { | ||
135 | + "categoryId": 13, | ||
136 | + "content": "如订单未选择发票需要补寄,请您联系有货客服,我们可以为您补开三个自然月内订单的发票,但是需运费到付。", | ||
137 | + "createTime": 1455438073, | ||
138 | + "id": 44, | ||
139 | + "platform": [ | ||
140 | + "iphone", | ||
141 | + "android", | ||
142 | + "h5" | ||
143 | + ], | ||
144 | + "title": "补开发票", | ||
145 | + "updateTime": 1455438842 | ||
146 | + }, | ||
147 | + "message": "Help Content" | ||
148 | +} | ||
149 | +{ | ||
150 | + "code":400 | ||
151 | + "message":"Id is null" | ||
152 | +} | ||
153 | +``` | ||
154 | +## 获取所有帮助内容 | ||
155 | + | ||
156 | +> 接口名:`/HelpContentRest/getAllHelpContent` | ||
157 | + | ||
158 | +### 入参 | ||
159 | +``` json | ||
160 | +{ | ||
161 | + "categoryId":13, | ||
162 | + "platform":"iphone,android" | ||
163 | +} | ||
164 | +or | ||
165 | +{ | ||
166 | + "categoryId":13, | ||
167 | +} | ||
168 | +or | ||
169 | +{ | ||
170 | + "platform":"iphone,android" | ||
171 | +} | ||
172 | +or | ||
173 | +{ } | ||
174 | +``` | ||
175 | +注意:如果不传入参数,必须传入`{}` | ||
176 | +------------------------- | ||
177 | +|属性名称|类型|例子|说明| | ||
178 | +|--------|----|----|----| | ||
179 | +|categoryId|int|13|分类ID(可选)| | ||
180 | +|platform|String|iphone,android|显示平台(可选)| | ||
181 | +--------------------- | ||
182 | + | ||
183 | +### 返回 | ||
184 | + | ||
185 | +``` json | ||
186 | +{ | ||
187 | + "code": 200, | ||
188 | + "data": [ | ||
189 | + { | ||
190 | + "categoryId": 13, | ||
191 | + "content": "如订单未选择发票需要补寄,请您联系有货客服,我们可以为您补开三个自然月内订单的发票,但是需运费到付。", | ||
192 | + "createTime": 1455438073, | ||
193 | + "id": 44, | ||
194 | + "platform": "iphone,android,h5", | ||
195 | + "status": 1, | ||
196 | + "title": "补开发票", | ||
197 | + "updateTime": 1455438842 | ||
198 | + }, | ||
199 | + { | ||
200 | + "categoryId": 13, | ||
201 | + "content": "4", | ||
202 | + "createTime": 1437566047, | ||
203 | + "id": 17, | ||
204 | + "platform": "iphone,android", | ||
205 | + "status": 1, | ||
206 | + "title": "3", | ||
207 | + "updateTime": 0 | ||
208 | + }, | ||
209 | + { | ||
210 | + "categoryId": 13, | ||
211 | + "content": "3", | ||
212 | + "createTime": 1437566035, | ||
213 | + "id": 16, | ||
214 | + "platform": "iphone,android", | ||
215 | + "status": 1, | ||
216 | + "title": "2", | ||
217 | + "updateTime": 0 | ||
218 | + }, | ||
219 | + { | ||
220 | + "categoryId": 13, | ||
221 | + "content": "订单生成后无法修改收货人信息,请您联系有货客服处理。", | ||
222 | + "createTime": 1437562842, | ||
223 | + "id": 13, | ||
224 | + "platform": "iphone,android", | ||
225 | + "status": 1, | ||
226 | + "title": "修改订单地址/电话", | ||
227 | + "updateTime": 0 | ||
228 | + }, | ||
229 | + { | ||
230 | + "categoryId": 13, | ||
231 | + "content": "因为网络问题,信息更新有所延迟,导致无法显示,请您保持网络顺畅情况下,重新登录进入再查看。", | ||
232 | + "createTime": 1437562792, | ||
233 | + "id": 11, | ||
234 | + "platform": "iphone,android", | ||
235 | + "status": 1, | ||
236 | + "title": "下单后看不到订单", | ||
237 | + "updateTime": 0 | ||
238 | + }, | ||
239 | + { | ||
240 | + "categoryId": 13, | ||
241 | + "content": "目前暂不支持订单修改功能,请您联系有货客服为您处理。", | ||
242 | + "createTime": 1437562767, | ||
243 | + "id": 10, | ||
244 | + "platform": "iphone,android", | ||
245 | + "status": 1, | ||
246 | + "title": "订单内容的修改", | ||
247 | + "updateTime": 0 | ||
248 | + }, | ||
249 | + { | ||
250 | + "categoryId": 13, | ||
251 | + "content": "在线支付订单未付款2小时内会自动取消,付款成功后需联系有货客服取消订单,货到付款订单未发货前可以进入“我的订单”自行取消订单。", | ||
252 | + "createTime": 1437545220, | ||
253 | + "id": 1, | ||
254 | + "platform": "iphone,android", | ||
255 | + "status": 1, | ||
256 | + "title": "取消订单", | ||
257 | + "updateTime": 1437548510 | ||
258 | + } | ||
259 | + ], | ||
260 | + "message": "All Help Content Platform List" | ||
261 | +} | ||
262 | +``` | ||
263 | +## 删除帮助内容 | ||
264 | + | ||
265 | +> 接口名:`/HelpContentRest/deleteHelpContent` | ||
266 | + | ||
267 | +### 入参 | ||
268 | +``` json | ||
269 | +{ | ||
270 | + "id":44 | ||
271 | +} | ||
272 | +``` | ||
273 | +------------------------- | ||
274 | +|属性名称|类型|例子|说明| | ||
275 | +|--------|----|----|----| | ||
276 | +|id|int|44|帮助内容记录ID| | ||
277 | +--------------------- | ||
278 | + | ||
279 | +### 返回 | ||
280 | + | ||
281 | +``` json | ||
282 | +{ | ||
283 | + "code": 200, | ||
284 | + "message": "删除成功" | ||
285 | +} | ||
286 | +or | ||
287 | +{ | ||
288 | + "code": 400, | ||
289 | + "message": "Id is null" | ||
290 | +} | ||
291 | +or | ||
292 | +{ | ||
293 | + "code": 500, | ||
294 | + "message": "删除失败" | ||
295 | +} | ||
296 | +``` | ||
297 | + | ||
298 | +## 分页显示帮助内容 | ||
299 | + | ||
300 | +> 接口名:`/HelpContentRest/getHelpContentList` | ||
301 | + | ||
302 | +### 入参 | ||
303 | +``` json | ||
304 | +{ | ||
305 | + "page":2, | ||
306 | + "size":12 | ||
307 | +} | ||
308 | +``` | ||
309 | +------------------------- | ||
310 | +|属性名称|类型|例子|说明| | ||
311 | +|--------|----|----|----| | ||
312 | +|page|int|2|第几页(可选) 默认为1| | ||
313 | +|size|int|12|每页条数(可选)默认为10| | ||
314 | +--------------------- | ||
315 | + | ||
316 | +### 返回 | ||
317 | + | ||
318 | +``` json | ||
319 | +{ | ||
320 | + "code": 200, | ||
321 | + "data": { | ||
322 | + "list": [ | ||
323 | + { | ||
324 | + "categoryId": 0, | ||
325 | + "content": "目前暂不支持订单修改功能,请您联系有货客服为您处理。", | ||
326 | + "createTime": 0, | ||
327 | + "id": 0, | ||
328 | + "platform": "iphone,android", | ||
329 | + "title": "订单内容的修改", | ||
330 | + "updateTime": 0 | ||
331 | + }, | ||
332 | + { | ||
333 | + "categoryId": 0, | ||
334 | + "content": "优惠券是有货线上品牌商城针对不同品牌或商品向消费者发送的虚拟券,优惠券可直接用于指定品牌或商品消费,不可转让他人,不可兑换为现金。", | ||
335 | + "createTime": 0, | ||
336 | + "id": 0, | ||
337 | + "platform": "iphone,android", | ||
338 | + "title": "什么是优惠券?", | ||
339 | + "updateTime": 0 | ||
340 | + }, | ||
341 | + { | ||
342 | + "categoryId": 0, | ||
343 | + "content": "Yoho币是有货商城全场针对不同商品向已激活用户返还的虚拟购物币。Yoho!币可直接用于有货线上购物使用,不可转让他人,不可兑换为现金。使用YOHO币支付的金额将不计入消费金额用以计算返还金额。", | ||
344 | + "createTime": 0, | ||
345 | + "id": 0, | ||
346 | + "platform": "iphone,android", | ||
347 | + "title": "Yoho币是什么,有什么用?", | ||
348 | + "updateTime": 0 | ||
349 | + }, | ||
350 | + { | ||
351 | + "categoryId": 0, | ||
352 | + "content": "银卡会员需年度累计消费满600元,金卡会员需年度累计消费满2000元,白金会员需年度累计消费满5000元。年度指连续的365天内(数字年),而非2011,2012这样的自然年。", | ||
353 | + "createTime": 0, | ||
354 | + "id": 0, | ||
355 | + "platform": "iphone,android", | ||
356 | + "title": "消费多少可以成为银卡会员、金卡会员、白金会员?", | ||
357 | + "updateTime": 0 | ||
358 | + }, | ||
359 | + { | ||
360 | + "categoryId": 0, | ||
361 | + "content": "您可进入“我的订单”,点击”确认收货”后,申请退换货,按页面提示填写相关信息,提交申请。我们会在24小时内以短信或电话的方式告知您审核结果,审核通过后,请您将商品连同发货单一并寄回,请您寄回时不要选择平邮或到付。", | ||
362 | + "createTime": 0, | ||
363 | + "id": 0, | ||
364 | + "platform": "iphone,android", | ||
365 | + "title": "如何办理退换货", | ||
366 | + "updateTime": 0 | ||
367 | + }, | ||
368 | + { | ||
369 | + "categoryId": 0, | ||
370 | + "content": "有货与配送公司签订先验货后签收协议,请在配送人员还在场的情况下,当面验收您的商品,货到付款订单可以开箱验货但是未签收情况下不能试穿。", | ||
371 | + "createTime": 0, | ||
372 | + "id": 0, | ||
373 | + "platform": "iphone,android", | ||
374 | + "title": "可以开箱验货吗", | ||
375 | + "updateTime": 0 | ||
376 | + }, | ||
377 | + { | ||
378 | + "categoryId": 0, | ||
379 | + "content": "浦发,深发,民生等银行只要客户设了密码,都是不可以进行交易的;工,农,建等全国性银行中,只有工行肯定是不能交易,别的银行是可以的。如在支付中有任何疑问,请联系有货客服为您处理", | ||
380 | + "createTime": 0, | ||
381 | + "id": 0, | ||
382 | + "platform": "iphone,android", | ||
383 | + "title": "为什么信用卡无法支付", | ||
384 | + "updateTime": 0 | ||
385 | + }, | ||
386 | + { | ||
387 | + "categoryId": 0, | ||
388 | + "content": "如订单未选择发票需要补寄,请您联系有货客服,我们可以为您补开三个自然月内订单的发票,但是需运费到付。", | ||
389 | + "createTime": 0, | ||
390 | + "id": 0, | ||
391 | + "platform": "iphone,android", | ||
392 | + "title": "补开发票", | ||
393 | + "updateTime": 0 | ||
394 | + }, | ||
395 | + { | ||
396 | + "categoryId": 0, | ||
397 | + "content": "您可进入“我的订单”中查询订单状态,有货会在订单审核通过后24小时内为您发出包裹。(温馨提示:预售商品发货时间以商品页面标注为准)。", | ||
398 | + "createTime": 0, | ||
399 | + "id": 0, | ||
400 | + "platform": "iphone,android", | ||
401 | + "title": "发货时间", | ||
402 | + "updateTime": 0 | ||
403 | + }, | ||
404 | + { | ||
405 | + "categoryId": 0, | ||
406 | + "content": "在线支付订单未付款2小时内会自动取消,付款成功后需联系有货客服取消订单,货到付款订单未发货前可以进入“我的订单”自行取消订单。", | ||
407 | + "createTime": 0, | ||
408 | + "id": 0, | ||
409 | + "platform": "iphone,android", | ||
410 | + "title": "取消订单", | ||
411 | + "updateTime": 0 | ||
412 | + } | ||
413 | + ], | ||
414 | + "page": 2, | ||
415 | + "size": 12, | ||
416 | + "total": 0, | ||
417 | + "totalPage": 0 | ||
418 | + }, | ||
419 | + "message": "Help Content List" | ||
420 | +} | ||
421 | +``` | ||
422 | + | ||
423 | +## 获取帮助内容总记录数 | ||
424 | + | ||
425 | +> 接口名:`/HelpContentRest/getHelpContentCount` | ||
426 | + | ||
427 | +### 入参 | ||
428 | +无 | ||
429 | +--------------------- | ||
430 | + | ||
431 | +### 返回 | ||
432 | + | ||
433 | +``` json | ||
434 | +{ | ||
435 | + "code": 200, | ||
436 | + "data": 22, | ||
437 | + "message": "成功" | ||
438 | +} | ||
439 | +``` | ||
440 | + | ||
441 | +## 根据分类ID查帮助内容 | ||
442 | + | ||
443 | +> 接口名:`/HelpContentRest/getHelpContentByCategoryId` | ||
444 | + | ||
445 | +### 入参 | ||
446 | +``` json | ||
447 | +{ | ||
448 | + "categoryId": 13 | ||
449 | +} | ||
450 | +``` | ||
451 | +------------------------- | ||
452 | +|属性名称|类型|例子|说明| | ||
453 | +|--------|----|----|----| | ||
454 | +|categoryId|int|13|分类ID| | ||
455 | +--------------------- | ||
456 | + | ||
457 | +### 返回 | ||
458 | + | ||
459 | +``` json | ||
460 | +{ | ||
461 | + "code": 200, | ||
462 | + "data": [ | ||
463 | + { | ||
464 | + "categoryId": 13, | ||
465 | + "content": "在线支付订单未付款2小时内会自动取消,付款成功后需联系有货客服取消订单,货到付款订单未发货前可以进入“我的订单”自行取消订单。", | ||
466 | + "createTime": 1437545220, | ||
467 | + "id": 1, | ||
468 | + "platform": "iphone,android", | ||
469 | + "status": 1, | ||
470 | + "title": "取消订单", | ||
471 | + "updateTime": 1437548510 | ||
472 | + }, | ||
473 | + { | ||
474 | + "categoryId": 13, | ||
475 | + "content": "目前暂不支持订单修改功能,请您联系有货客服为您处理。", | ||
476 | + "createTime": 1437562767, | ||
477 | + "id": 10, | ||
478 | + "platform": "iphone,android", | ||
479 | + "status": 1, | ||
480 | + "title": "订单内容的修改", | ||
481 | + "updateTime": 0 | ||
482 | + }, | ||
483 | + { | ||
484 | + "categoryId": 13, | ||
485 | + "content": "因为网络问题,信息更新有所延迟,导致无法显示,请您保持网络顺畅情况下,重新登录进入再查看。", | ||
486 | + "createTime": 1437562792, | ||
487 | + "id": 11, | ||
488 | + "platform": "iphone,android", | ||
489 | + "status": 1, | ||
490 | + "title": "下单后看不到订单", | ||
491 | + "updateTime": 0 | ||
492 | + }, | ||
493 | + { | ||
494 | + "categoryId": 13, | ||
495 | + "content": "订单生成后无法修改收货人信息,请您联系有货客服处理。", | ||
496 | + "createTime": 1437562842, | ||
497 | + "id": 13, | ||
498 | + "platform": "iphone,android", | ||
499 | + "status": 1, | ||
500 | + "title": "修改订单地址/电话", | ||
501 | + "updateTime": 0 | ||
502 | + }, | ||
503 | + { | ||
504 | + "categoryId": 13, | ||
505 | + "content": "3", | ||
506 | + "createTime": 1437566035, | ||
507 | + "id": 16, | ||
508 | + "platform": "iphone,android", | ||
509 | + "status": 1, | ||
510 | + "title": "2", | ||
511 | + "updateTime": 0 | ||
512 | + }, | ||
513 | + { | ||
514 | + "categoryId": 13, | ||
515 | + "content": "4", | ||
516 | + "createTime": 1437566047, | ||
517 | + "id": 17, | ||
518 | + "platform": "iphone,android", | ||
519 | + "status": 1, | ||
520 | + "title": "3", | ||
521 | + "updateTime": 0 | ||
522 | + } | ||
523 | + ], | ||
524 | + "message": "Help Content List by CategoryId" | ||
525 | +} | ||
526 | +or | ||
527 | +{ | ||
528 | + "code":400 | ||
529 | + "message":"分类ID无效" | ||
530 | +} | ||
531 | +``` | ||
532 | + | ||
533 | +## 根据平台查帮助内容 | ||
534 | + | ||
535 | +> 接口名:`/HelpContentRest/getHelpContentByPlatform` | ||
536 | + | ||
537 | +### 入参 | ||
538 | +``` json | ||
539 | +{ | ||
540 | + "platform": "iphone,android" | ||
541 | +} | ||
542 | +``` | ||
543 | +------------------------- | ||
544 | +|属性名称|类型|例子|说明| | ||
545 | +|--------|----|----|----| | ||
546 | +|platform|String|iphone,android|显示平台| | ||
547 | +--------------------- | ||
548 | + | ||
549 | +### 返回 | ||
550 | + | ||
551 | +``` json | ||
552 | +{ | ||
553 | + "code": 200, | ||
554 | + "data": [ | ||
555 | + { | ||
556 | + "categoryId": 13, | ||
557 | + "content": "在线支付订单未付款2小时内会自动取消,付款成功后需联系有货客服取消订单,货到付款订单未发货前可以进入“我的订单”自行取消订单。", | ||
558 | + "createTime": 1437545220, | ||
559 | + "id": 1, | ||
560 | + "platform": "iphone,android", | ||
561 | + "status": 1, | ||
562 | + "title": "取消订单", | ||
563 | + "updateTime": 1437548510 | ||
564 | + }, | ||
565 | + { | ||
566 | + "categoryId": 14, | ||
567 | + "content": "您可进入“我的订单”中查询订单状态,有货会在订单审核通过后24小时内为您发出包裹。(温馨提示:预售商品发货时间以商品页面标注为准)。", | ||
568 | + "createTime": 1437546597, | ||
569 | + "id": 2, | ||
570 | + "platform": "iphone,android", | ||
571 | + "status": 1, | ||
572 | + "title": "发货时间", | ||
573 | + "updateTime": 1437548685 | ||
574 | + }, | ||
575 | + { | ||
576 | + "categoryId": 15, | ||
577 | + "content": "如订单未选择发票需要补寄,请您联系有货客服,我们可以为您补开三个自然月内订单的发票,但是需运费到付。", | ||
578 | + "createTime": 1437546640, | ||
579 | + "id": 3, | ||
580 | + "platform": "iphone,android", | ||
581 | + "status": 1, | ||
582 | + "title": "补开发票", | ||
583 | + "updateTime": 1437548679 | ||
584 | + }, | ||
585 | + { | ||
586 | + "categoryId": 17, | ||
587 | + "content": "浦发,深发,民生等银行只要客户设了密码,都是不可以进行交易的;工,农,建等全国性银行中,只有工行肯定是不能交易,别的银行是可以的。如在支付中有任何疑问,请联系有货客服为您处理", | ||
588 | + "createTime": 1437546674, | ||
589 | + "id": 4, | ||
590 | + "platform": "iphone,android", | ||
591 | + "status": 1, | ||
592 | + "title": "为什么信用卡无法支付", | ||
593 | + "updateTime": 1437548673 | ||
594 | + }, | ||
595 | + { | ||
596 | + "categoryId": 18, | ||
597 | + "content": "有货与配送公司签订先验货后签收协议,请在配送人员还在场的情况下,当面验收您的商品,货到付款订单可以开箱验货但是未签收情况下不能试穿。", | ||
598 | + "createTime": 1437546710, | ||
599 | + "id": 5, | ||
600 | + "platform": "iphone,android", | ||
601 | + "status": 1, | ||
602 | + "title": "可以开箱验货吗", | ||
603 | + "updateTime": 1437548665 | ||
604 | + }, | ||
605 | + { | ||
606 | + "categoryId": 19, | ||
607 | + "content": "您可进入“我的订单”,点击”确认收货”后,申请退换货,按页面提示填写相关信息,提交申请。我们会在24小时内以短信或电话的方式告知您审核结果,审核通过后,请您将商品连同发货单一并寄回,请您寄回时不要选择平邮或到付。", | ||
608 | + "createTime": 1437546751, | ||
609 | + "id": 6, | ||
610 | + "platform": "iphone,android", | ||
611 | + "status": 1, | ||
612 | + "title": "如何办理退换货", | ||
613 | + "updateTime": 1437548659 | ||
614 | + }, | ||
615 | + { | ||
616 | + "categoryId": 21, | ||
617 | + "content": "银卡会员需年度累计消费满600元,金卡会员需年度累计消费满2000元,白金会员需年度累计消费满5000元。年度指连续的365天内(数字年),而非2011,2012这样的自然年。", | ||
618 | + "createTime": 1437546777, | ||
619 | + "id": 7, | ||
620 | + "platform": "iphone,android", | ||
621 | + "status": 1, | ||
622 | + "title": "消费多少可以成为银卡会员、金卡会员、白金会员?", | ||
623 | + "updateTime": 1437548651 | ||
624 | + }, | ||
625 | + { | ||
626 | + "categoryId": 22, | ||
627 | + "content": "Yoho币是有货商城全场针对不同商品向已激活用户返还的虚拟购物币。Yoho!币可直接用于有货线上购物使用,不可转让他人,不可兑换为现金。使用YOHO币支付的金额将不计入消费金额用以计算返还金额。", | ||
628 | + "createTime": 1437546798, | ||
629 | + "id": 8, | ||
630 | + "platform": "iphone,android", | ||
631 | + "status": 1, | ||
632 | + "title": "Yoho币是什么,有什么用?", | ||
633 | + "updateTime": 1437548645 | ||
634 | + }, | ||
635 | + { | ||
636 | + "categoryId": 23, | ||
637 | + "content": "优惠券是有货线上品牌商城针对不同品牌或商品向消费者发送的虚拟券,优惠券可直接用于指定品牌或商品消费,不可转让他人,不可兑换为现金。", | ||
638 | + "createTime": 1437546819, | ||
639 | + "id": 9, | ||
640 | + "platform": "iphone,android", | ||
641 | + "status": 1, | ||
642 | + "title": "什么是优惠券?", | ||
643 | + "updateTime": 1437552970 | ||
644 | + }, | ||
645 | + { | ||
646 | + "categoryId": 13, | ||
647 | + "content": "目前暂不支持订单修改功能,请您联系有货客服为您处理。", | ||
648 | + "createTime": 1437562767, | ||
649 | + "id": 10, | ||
650 | + "platform": "iphone,android", | ||
651 | + "status": 1, | ||
652 | + "title": "订单内容的修改", | ||
653 | + "updateTime": 0 | ||
654 | + }, | ||
655 | + { | ||
656 | + "categoryId": 13, | ||
657 | + "content": "因为网络问题,信息更新有所延迟,导致无法显示,请您保持网络顺畅情况下,重新登录进入再查看。", | ||
658 | + "createTime": 1437562792, | ||
659 | + "id": 11, | ||
660 | + "platform": "iphone,android", | ||
661 | + "status": 1, | ||
662 | + "title": "下单后看不到订单", | ||
663 | + "updateTime": 0 | ||
664 | + }, | ||
665 | + { | ||
666 | + "categoryId": 14, | ||
667 | + "content": "货到付款订单提交后为待审核状态的正常的,我们会在您成功下单后24小时内审核您的订单。", | ||
668 | + "createTime": 1437562820, | ||
669 | + "id": 12, | ||
670 | + "platform": "iphone,android", | ||
671 | + "status": 1, | ||
672 | + "title": "订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核", | ||
673 | + "updateTime": 1437815593 | ||
674 | + }, | ||
675 | + { | ||
676 | + "categoryId": 13, | ||
677 | + "content": "订单生成后无法修改收货人信息,请您联系有货客服处理。", | ||
678 | + "createTime": 1437562842, | ||
679 | + "id": 13, | ||
680 | + "platform": "iphone,android", | ||
681 | + "status": 1, | ||
682 | + "title": "修改订单地址/电话", | ||
683 | + "updateTime": 0 | ||
684 | + }, | ||
685 | + { | ||
686 | + "categoryId": 13, | ||
687 | + "content": "3", | ||
688 | + "createTime": 1437566035, | ||
689 | + "id": 16, | ||
690 | + "platform": "iphone,android", | ||
691 | + "status": 1, | ||
692 | + "title": "2", | ||
693 | + "updateTime": 0 | ||
694 | + }, | ||
695 | + { | ||
696 | + "categoryId": 13, | ||
697 | + "content": "4", | ||
698 | + "createTime": 1437566047, | ||
699 | + "id": 17, | ||
700 | + "platform": "iphone,android", | ||
701 | + "status": 1, | ||
702 | + "title": "3", | ||
703 | + "updateTime": 0 | ||
704 | + }, | ||
705 | + { | ||
706 | + "categoryId": 17, | ||
707 | + "content": "测试", | ||
708 | + "createTime": 1438219772, | ||
709 | + "id": 35, | ||
710 | + "platform": "iphone,android", | ||
711 | + "status": 1, | ||
712 | + "title": "这个是常见支付的问题", | ||
713 | + "updateTime": 0 | ||
714 | + }, | ||
715 | + { | ||
716 | + "categoryId": 22, | ||
717 | + "content": "测试", | ||
718 | + "createTime": 1438219938, | ||
719 | + "id": 36, | ||
720 | + "platform": "iphone,android", | ||
721 | + "status": 1, | ||
722 | + "title": "这是yoho币的问题", | ||
723 | + "updateTime": 0 | ||
724 | + } | ||
725 | + ], | ||
726 | + "message": "Help Content List by CategoryId" | ||
727 | +} | ||
728 | +or | ||
729 | +{ | ||
730 | + "code":400 | ||
731 | + "message":"显示平台无效" | ||
732 | +} | ||
733 | +``` | ||
734 | + | ||
735 | +## 帮助列表 | ||
736 | + | ||
737 | +> 接口名:`/HelpContentRest/getHelp` | ||
738 | + | ||
739 | +### 入参 | ||
740 | +``` json | ||
741 | +{ | ||
742 | + "categoryId":13, | ||
743 | + "platform":"iphone,android" | ||
744 | +} | ||
745 | +or | ||
746 | +{ | ||
747 | + "categoryId":13, | ||
748 | +} | ||
749 | +``` | ||
750 | +------------------------- | ||
751 | +|属性名称|类型|例子|说明| | ||
752 | +|--------|----|----|----| | ||
753 | +|categoryId|int|13|分类ID| | ||
754 | +|platform|String|iphone,android|显示平台(可选)默认h5| | ||
755 | +--------------------- | ||
756 | + | ||
757 | +### 返回 | ||
758 | + | ||
759 | +``` json | ||
760 | +{ | ||
761 | + "categoryId":13, | ||
762 | + "platform":"iphone,android" | ||
763 | +} | ||
764 | +or | ||
765 | +{ | ||
766 | + "code":400 | ||
767 | + "message":"帮助分类不能为空" | ||
768 | +} | ||
769 | +``` | ||
770 | + | ||
771 | +## 帮助内容 | ||
772 | + | ||
773 | +> 接口名:`/HelpContentRest/getHelpContent` | ||
774 | + | ||
775 | +### 入参 | ||
776 | +``` json | ||
777 | +{ | ||
778 | + "id": 42 | ||
779 | +} | ||
780 | +``` | ||
781 | +------------------------- | ||
782 | +|属性名称|类型|例子|说明| | ||
783 | +|--------|----|----|----| | ||
784 | +|id|int|42|帮助内容记录ID| | ||
785 | +--------------------- | ||
786 | + | ||
787 | +### 返回 | ||
788 | + | ||
789 | +``` json | ||
790 | +{ | ||
791 | + "code": 200, | ||
792 | + "data": { | ||
793 | + "categoryId": 14, | ||
794 | + "content": "这个是物流问题", | ||
795 | + "createTime": 1449038392, | ||
796 | + "id": 42, | ||
797 | + "platform": [ | ||
798 | + "h5" | ||
799 | + ], | ||
800 | + "title": "物流问题", | ||
801 | + "updateTime": 0 | ||
802 | + }, | ||
803 | + "message": "帮助内容" | ||
804 | +} | ||
805 | +or | ||
806 | +{ | ||
807 | + "code":400 | ||
808 | + "message":"请选择要查看的帮助" | ||
809 | +} | ||
810 | +or | ||
811 | +{ | ||
812 | + "code":400 | ||
813 | + "message":"内容不存在" | ||
814 | +} | ||
815 | +``` | ||
816 | + | ||
817 | + |
inferface-document/cms/hot_rank_tag.md
0 → 100644
1 | +# 热门标签接口服务定义 | ||
2 | +---------------------- | ||
3 | + | ||
4 | +# 查询热门标签接口 | ||
5 | + | ||
6 | +> 接口名:`hotRankTag/selectTagList` | ||
7 | + | ||
8 | +### 入参 | ||
9 | + | ||
10 | +---------------------------------- | ||
11 | +|属性名称|类型|例子|说明|是否必填| | ||
12 | +|--------|----|----|----|--------| | ||
13 | +|platform|string|iphone|平台|否| | ||
14 | +|channel|string|1|频道|否| | ||
15 | +|status|integer|1|状态:0 不启用 ,1 启用 |否| | ||
16 | +---------------------------------- | ||
17 | + | ||
18 | +### 返回 | ||
19 | + | ||
20 | +``` json | ||
21 | +{ | ||
22 | + "code": 200, | ||
23 | + "data": [ | ||
24 | + { | ||
25 | + "categoryId": "134,135", | ||
26 | + "channel": "2", | ||
27 | + "createTime": 1442233441, | ||
28 | + "id": 17, | ||
29 | + "orderBy": 0, | ||
30 | + "platform": "iphone,ipad,android,androidpad,web", | ||
31 | + "status": 1, | ||
32 | + "tagName": "裙装", | ||
33 | + "updateTime": 1448000665 | ||
34 | + } | ||
35 | + ], | ||
36 | + "message": "Tag List" | ||
37 | +} | ||
38 | +``` | ||
39 | + | ||
40 | +# 添加标签接口 | ||
41 | + | ||
42 | +> 接口名:`hotRankTag/addTag` | ||
43 | + | ||
44 | +### 入参 | ||
45 | + | ||
46 | +---------------------------------- | ||
47 | +|属性名称|类型|例子|说明|是否必填| | ||
48 | +|--------|----|----|----|--------| | ||
49 | +|tagName|string|智能装备|标签名称|是| | ||
50 | +|categoryId|string|33,34|分类ID,多个分类用逗号隔开|否| | ||
51 | +|platform|string|iphone|平台|是| | ||
52 | +|channel|string|1|频道|是| | ||
53 | +|orderBy|integer|1|序号|否| | ||
54 | +---------------------------------- | ||
55 | + | ||
56 | +### 返回 | ||
57 | + | ||
58 | +``` json | ||
59 | +{ | ||
60 | + "code":200, | ||
61 | + "message":"添加标签信息成功" | ||
62 | +} | ||
63 | +``` | ||
64 | + | ||
65 | +# 更新标签接口 | ||
66 | + | ||
67 | +> 接口名:`hotRankTag/updateTag` | ||
68 | + | ||
69 | +### 入参 | ||
70 | + | ||
71 | +---------------------------------- | ||
72 | +|属性名称|类型|例子|说明|是否必填| | ||
73 | +|--------|----|----|----|--------| | ||
74 | +|id|integer|33|主键|是| | ||
75 | +|tagName|string|智能装备|标签名称|是| | ||
76 | +|categoryId|string|33,34|分类ID,多个分类用逗号隔开|否| | ||
77 | +|platform|string|iphone|平台|是| | ||
78 | +|channel|string|1|频道|是| | ||
79 | +|orderBy|integer|1|序号|否| | ||
80 | +---------------------------------- | ||
81 | + | ||
82 | +### 返回 | ||
83 | + | ||
84 | +``` json | ||
85 | +{ | ||
86 | + "code":200, | ||
87 | + "message":"修改标签信息成功" | ||
88 | +} | ||
89 | +``` | ||
90 | + | ||
91 | +# 发布标签接口 | ||
92 | + | ||
93 | +> 接口名:`hotRankTag/updateTag` | ||
94 | + | ||
95 | +### 入参 | ||
96 | + | ||
97 | +---------------------------------- | ||
98 | +|属性名称|类型|例子|说明|是否必填| | ||
99 | +|--------|----|----|----|--------| | ||
100 | +|id|integer|33|主键|是| | ||
101 | +---------------------------------- | ||
102 | + | ||
103 | +### 返回 | ||
104 | + | ||
105 | +``` json | ||
106 | +{ | ||
107 | + "code":200, | ||
108 | + "message":"操作成功" | ||
109 | +} | ||
110 | +``` | ||
111 | + | ||
112 | +# 关闭标签接口 | ||
113 | + | ||
114 | +> 接口名:`hotRankTag/updateTag` | ||
115 | + | ||
116 | +### 入参 | ||
117 | + | ||
118 | +---------------------------------- | ||
119 | +|属性名称|类型|例子|说明|是否必填| | ||
120 | +|--------|----|----|----|--------| | ||
121 | +|id|integer|33|主键|是| | ||
122 | +---------------------------------- | ||
123 | + | ||
124 | +### 返回 | ||
125 | + | ||
126 | +``` json | ||
127 | +{ | ||
128 | + "code":200, | ||
129 | + "message":"操作成功" | ||
130 | +} | ||
131 | +``` |
1 | -# 文件上传接口服务定义 | 1 | +# 七牛云图片上传服务接口定义 |
2 | --------------------- | 2 | --------------------- |
3 | 3 | ||
4 | -# 添加颜色接口 | 4 | +# 七牛云图片上传服务接口 |
5 | 5 | ||
6 | > 接口名: `/fileupload/upload/` | 6 | > 接口名: `/fileupload/upload/` |
7 | 7 | ||
@@ -9,11 +9,11 @@ | @@ -9,11 +9,11 @@ | ||
9 | ### 入参 | 9 | ### 入参 |
10 | 10 | ||
11 | ------------------------- | 11 | ------------------------- |
12 | -|属性名称|类型|例子|说明|是否必填| | ||
13 | -|--------|----|----|----|--------| | ||
14 | -|file|file|-|颜色名称|是| | ||
15 | -|userId|int|543883|用户id|是| | ||
16 | -|bucket|string|smart|bucket|是| | 12 | +|属性名称|类型|例子|说明 |
13 | +|--------|----|----|----| | ||
14 | +|file|file|-|图片文件 | ||
15 | +|userId|string|54|用户id| | ||
16 | +|bucket|string|yhb-img02|bucket空间,可选(默认为yhb-img01)但值只能是yhb-img01或yhb-img02| | ||
17 | 17 | ||
18 | --------------------- | 18 | --------------------- |
19 | 19 | ||
@@ -21,9 +21,9 @@ | @@ -21,9 +21,9 @@ | ||
21 | 21 | ||
22 | ``` json | 22 | ``` json |
23 | { | 23 | { |
24 | - "code":200, | ||
25 | - "data" : "url", --图片URL | ||
26 | - "message":"success" | 24 | + "code": 200, |
25 | + "data": "http://yhfair.qiniudn.com/yhb-img01/2016/02/16/22/01575e9f268f8e9f2357a6105f0e707536.png", | ||
26 | + "message": "上传成功" | ||
27 | } | 27 | } |
28 | 28 | ||
29 | ``` | 29 | ``` |
inferface-document/guang/article.md
0 → 100644
1 | +资讯管理接口服务定义 | ||
2 | +--------------------- | ||
3 | + | ||
4 | + | ||
5 | + | ||
6 | +## 资讯列表查询 | ||
7 | + | ||
8 | +> 接口名: 'article/getList' | ||
9 | + | ||
10 | +### 入参 | ||
11 | + | ||
12 | +------------------------- | ||
13 | +|属性名称|类型|例子|说明| | ||
14 | +|--------|----|----|----| | ||
15 | +|articleTitle|String|尖货盘点|资讯标题| | ||
16 | +|articleGender|String|1|性别| | ||
17 | +|authorId|int|2890|作者ID| | ||
18 | +|maxSortId|int|12|分类ID| | ||
19 | +|status|int|1|资讯状态| | ||
20 | +|orderBy|String|1|时间方式| | ||
21 | +|startTime|String|2016-01-01|开始时间| | ||
22 | +|endTime|String|2016-02-01|结束时间| | ||
23 | +--------------------- | ||
24 | + | ||
25 | +### 返回 | ||
26 | + | ||
27 | +``` json | ||
28 | +{ | ||
29 | + "code":200, | ||
30 | + "message":"操作成功", | ||
31 | + "data": { | ||
32 | + "list": [ | ||
33 | + { | ||
34 | + "id": "", | ||
35 | + “coverImage": "", //封面图 | ||
36 | + "articleTitle": "", //资讯标题 | ||
37 | + "maxSortId": "", //分类 | ||
38 | + "articleGender": "", //性别 | ||
39 | + "authorId": "", //作者 | ||
40 | + "status": "", //状态,-1已关闭,0 未发布,1 已发布 | ||
41 | + "createTime": "", //创建时间 | ||
42 | + "publishTime": "", //发布时间 | ||
43 | + }, | ||
44 | + "page": 0, | ||
45 | + "size": 50, | ||
46 | + "total": 1000 | ||
47 | + "totalPage":20 | ||
48 | + ] | ||
49 | + } | ||
50 | +} | ||
51 | + | ||
52 | +``` | ||
53 | + | ||
54 | + | ||
55 | +## 获取作者列表接口 | ||
56 | + | ||
57 | +> 接口名: 'article/getAuthorList' | ||
58 | + | ||
59 | +### 入参 | ||
60 | + | ||
61 | +------------------------- | ||
62 | +|属性名称|类型|例子|说明| | ||
63 | +|--------|----|----|----| | ||
64 | +|idName|String|1054|作者ID或姓名| | ||
65 | +--------------------- | ||
66 | + | ||
67 | +### 返回 | ||
68 | + | ||
69 | +``` json | ||
70 | +{ | ||
71 | + "code":200, | ||
72 | + "message":"操作成功", | ||
73 | + "data": [ | ||
74 | + { | ||
75 | + "id": "", | ||
76 | + "name":"" | ||
77 | + } | ||
78 | + ] | ||
79 | + | ||
80 | +} | ||
81 | + | ||
82 | +``` | ||
83 | + | ||
84 | + | ||
85 | +## 获取所有分类接口 | ||
86 | + | ||
87 | +> 接口名: 'article/getSortList' | ||
88 | + | ||
89 | +### 入参 | ||
90 | + | ||
91 | +无 | ||
92 | + | ||
93 | +### 返回 | ||
94 | + | ||
95 | +``` json | ||
96 | +{ | ||
97 | + "code":200, | ||
98 | + "message":"操作成功", | ||
99 | + "data": [ | ||
100 | + { | ||
101 | + "id": "", | ||
102 | + "name":"" | ||
103 | + } | ||
104 | + ] | ||
105 | +} | ||
106 | + | ||
107 | +``` | ||
108 | + | ||
109 | +## 编辑时资讯详情接口 | ||
110 | + | ||
111 | +> 接口名: 'article/getArticleDetail' | ||
112 | + | ||
113 | +### 入参 | ||
114 | + | ||
115 | +------------------------- | ||
116 | +|属性名称|类型|例子|说明| | ||
117 | +|--------|----|----|----| | ||
118 | +|id|int|43|资讯id| | ||
119 | +--------------------- | ||
120 | + | ||
121 | +### 返回 | ||
122 | + | ||
123 | +``` json | ||
124 | +{ | ||
125 | + "code":200, | ||
126 | + "message":"操作成功", | ||
127 | + "data": { | ||
128 | + "id": "", | ||
129 | + “coverImage": "", //封面图 | ||
130 | + "articleTitle": "", //资讯标题 | ||
131 | + "maxSortId": "", //一级分类 | ||
132 | + "minSortId": "", //二级分类 | ||
133 | + "articleSummary": "",//摘要 | ||
134 | + "coverImageType": "",//图片类型 | ||
135 | + "articleType": "", //文章类型 | ||
136 | + "adsImgSize": "", //广告尺寸 | ||
137 | + "url": "", //链接 | ||
138 | + "articleGender": "", //性别 | ||
139 | + "authorId": "", //作者 | ||
140 | + "status": "", //状态,-1已关闭,0 未发布,1 已发布 | ||
141 | + "createTime": "", //创建时间 | ||
142 | + "publishTime": "", //发布时间 | ||
143 | + } | ||
144 | +} | ||
145 | + | ||
146 | +``` | ||
147 | + | ||
148 | + | ||
149 | +## 新增资讯接口 | ||
150 | + | ||
151 | +> 接口名: 'article/addArticle' | ||
152 | + | ||
153 | +### 入参 | ||
154 | + | ||
155 | +------------------------- | ||
156 | +|属性名称|类型|例子|说明| | ||
157 | +|--------|----|----|----| | ||
158 | +|articleTitle|String|尖货盘点|资讯标题| | ||
159 | +|articleGender|String|0|性别| | ||
160 | +|authorId|int|3098|作者ID| | ||
161 | +|maxSortId|int|12|一级分类ID| | ||
162 | +|minSortId|int|35|二级分类ID| | ||
163 | +|articleSummary|String|御寒首选|摘要| | ||
164 | +|coverImage|String||封面图| | ||
165 | +|coverImageType|int|1|图片类型| | ||
166 | +|articleType|int|1|文章类型| | ||
167 | +|adsImgSize|String|10881088|广告尺寸| | ||
168 | +|url|String|{"action":"go.activity","url":"http://feature.yohobuy.com/0/0/373/index.html"|链接| | ||
169 | +--------------------- | ||
170 | + | ||
171 | +### 返回 | ||
172 | + | ||
173 | +``` json | ||
174 | +{ | ||
175 | + "code":200, | ||
176 | + "message":"添加成功!" | ||
177 | +} | ||
178 | + | ||
179 | +``` | ||
180 | + | ||
181 | +## 修改/发布(关闭)/推荐(取消推荐)资讯接口 | ||
182 | + | ||
183 | +> 接口名: 'article/updateArticle' | ||
184 | + | ||
185 | +### 入参 | ||
186 | + | ||
187 | +------------------------- | ||
188 | +|属性名称|类型|例子|说明| | ||
189 | +|--------|----|----|----| | ||
190 | +|id|int|1054|资讯ID| | ||
191 | +|articleTitle|String|尖货盘点|资讯标题| | ||
192 | +|articleGender|String|0|性别| | ||
193 | +|authorId|int|3098|作者ID| | ||
194 | +|maxSortId|int|12|一级分类ID| | ||
195 | +|minSortId|int|35|二级分类ID| | ||
196 | +|articleSummary|String|御寒首选|摘要| | ||
197 | +|coverImage|String||封面图| | ||
198 | +|coverImageType|int|1|图片类型| | ||
199 | +|articleType|int|1|文章类型| | ||
200 | +|adsImgSize|String|10881088|广告尺寸| | ||
201 | +|url|String|{"action":"go.activity","url":"http://feature.yohobuy.com/0/0/373/index.html"|链接| | ||
202 | +--------------------- | ||
203 | + | ||
204 | +### 返回 | ||
205 | + | ||
206 | +``` json | ||
207 | +{ | ||
208 | + "code":200, | ||
209 | + "message":"修改成功!" | ||
210 | +} | ||
211 | + | ||
212 | +``` | ||
213 | + | ||
214 | +## 删除资讯接口 | ||
215 | + | ||
216 | +> 接口名: 'article/delArticle' | ||
217 | + | ||
218 | +### 入参 | ||
219 | + | ||
220 | +------------------------- | ||
221 | +|属性名称|类型|例子|说明| | ||
222 | +|--------|----|----|----| | ||
223 | +|id|int|43|资讯id| | ||
224 | +--------------------- | ||
225 | + | ||
226 | +### 返回 | ||
227 | + | ||
228 | +``` json | ||
229 | +{ | ||
230 | + "code":200, | ||
231 | + "message":"删除成功!" | ||
232 | +} | ||
233 | + | ||
234 | +``` | ||
235 | + | ||
236 | +## 定时发布资讯接口 | ||
237 | + | ||
238 | +> 接口名: 'article/timePublish' | ||
239 | + | ||
240 | +### 入参 | ||
241 | + | ||
242 | +------------------------- | ||
243 | +|属性名称|类型|例子|说明| | ||
244 | +|--------|----|----|----| | ||
245 | +|id|int|43|资讯id| | ||
246 | +|publishTime|int|1432188073|定时发布时间| | ||
247 | +--------------------- | ||
248 | + | ||
249 | +### 返回 | ||
250 | + | ||
251 | +``` json | ||
252 | +{ | ||
253 | + "code":200, | ||
254 | + "message":"定时发布成功!" | ||
255 | +} | ||
256 | + | ||
257 | +``` | ||
258 | + | ||
259 | +## 资讯获取选择选项的枚举接口 | ||
260 | + | ||
261 | +> 接口名: 'EnumListRest/getEnumList' | ||
262 | + | ||
263 | +### 返回 | ||
264 | + | ||
265 | +``` json | ||
266 | +{ | ||
267 | + "code":200, | ||
268 | + "message":"请求成功", | ||
269 | + "data": { | ||
270 | + "genderItems": [{ //性别 | ||
271 | + "id": "", | ||
272 | + "name": "" | ||
273 | + }], | ||
274 | + "publishStatusItems": [{ //发布状态 | ||
275 | + "id": "", | ||
276 | + "name": "" | ||
277 | + }], | ||
278 | + "articleTypeItems": [{ //文章类型 | ||
279 | + "id": "", | ||
280 | + "name": "" | ||
281 | + }], | ||
282 | + "coverImageTypeItems": [{ //封面图片类型 | ||
283 | + "id": "", | ||
284 | + "name": "" | ||
285 | + }], | ||
286 | + "adsImgSizeItems": [{ //广告尺寸 | ||
287 | + "id": "", | ||
288 | + "name": "" | ||
289 | + }] | ||
290 | + } | ||
291 | +} | ||
292 | + | ||
293 | +``` | ||
294 | + | ||
295 | +``` |
inferface-document/guang/articleSort.md
0 → 100644
1 | +文章分类管理接口服务定义 | ||
2 | +--------------------- | ||
3 | + | ||
4 | + | ||
5 | + | ||
6 | +## 文章分类列表查询 | ||
7 | + | ||
8 | +> 接口名: 'article/sort/getList' | ||
9 | + | ||
10 | +### 入参 | ||
11 | + | ||
12 | +无 | ||
13 | + | ||
14 | +### 返回 | ||
15 | + | ||
16 | +``` json | ||
17 | +{ | ||
18 | + "code":200, | ||
19 | + "message":"操作成功", | ||
20 | + "data": { | ||
21 | + "list": [ | ||
22 | + { | ||
23 | + "id": "", | ||
24 | + “parentId": "", //父分类ID | ||
25 | + "name": "", //分类名称 | ||
26 | + "status": "", //状态,0关闭,1开启 | ||
27 | + "orderBy": "", //排序 | ||
28 | + "advertCode": "",//广告码 | ||
29 | + "sub": "", //子分类 | ||
30 | + } | ||
31 | + ] | ||
32 | + } | ||
33 | +} | ||
34 | + | ||
35 | +``` | ||
36 | + | ||
37 | + | ||
38 | +## 添加分类接口 | ||
39 | + | ||
40 | +> 接口名: 'article/sort/addSort' | ||
41 | + | ||
42 | +### 入参 | ||
43 | + | ||
44 | +------------------------- | ||
45 | +|属性名称|类型|例子|说明| | ||
46 | +|--------|----|----|----| | ||
47 | +|parentId|int|0|父分类ID| | ||
48 | +|name|string|欧美风|分类名称| | ||
49 | +|status|int|1|是否启用| | ||
50 | +|advertCode|string|180a31250622f11180f808d4404d0e78|广告码| | ||
51 | +|orderBy|int|5|排序| | ||
52 | +--------------------- | ||
53 | + | ||
54 | +### 返回 | ||
55 | + | ||
56 | +``` json | ||
57 | +{ | ||
58 | + "code":200, | ||
59 | + "message":"添加成功!" | ||
60 | +} | ||
61 | + | ||
62 | +``` | ||
63 | + | ||
64 | + | ||
65 | +## 编辑分类接口 | ||
66 | + | ||
67 | +> 接口名: 'article/sort/updateSort' | ||
68 | + | ||
69 | +### 入参 | ||
70 | + | ||
71 | +------------------------- | ||
72 | +|属性名称|类型|例子|说明| | ||
73 | +|--------|----|----|----| | ||
74 | +|id|int|10231|分类ID| | ||
75 | +|parentId|int|0|父分类ID| | ||
76 | +|name|string|欧美风|分类名称| | ||
77 | +|status|int|1|是否启用| | ||
78 | +|advertCode|string|180a31250622f11180f808d4404d0e78|广告码| | ||
79 | +|orderBy|int|5|排序| | ||
80 | +--------------------- | ||
81 | + | ||
82 | +### 返回 | ||
83 | + | ||
84 | +``` json | ||
85 | +{ | ||
86 | + "code":200, | ||
87 | + "message":"修改成功!" | ||
88 | +} | ||
89 | + | ||
90 | +``` | ||
91 | + | ||
92 | +## 编辑时分类详情接口 | ||
93 | + | ||
94 | +> 接口名: 'article/sort/getDetail' | ||
95 | + | ||
96 | +### 入参 | ||
97 | + | ||
98 | +------------------------- | ||
99 | +|属性名称|类型|例子|说明| | ||
100 | +|--------|----|----|----| | ||
101 | +|id|int|43|分类id| | ||
102 | +--------------------- | ||
103 | + | ||
104 | +### 返回 | ||
105 | + | ||
106 | +``` json | ||
107 | +{ | ||
108 | + "code":200, | ||
109 | + "message":"操作成功", | ||
110 | + "data": { | ||
111 | + "id": "", | ||
112 | + “parentId": "", //父分类ID | ||
113 | + "name": "", //分类名称 | ||
114 | + "status": "", //状态,0关闭,1开启 | ||
115 | + "orderBy": "", //排序 | ||
116 | + "advertCode": "", //广告码 | ||
117 | + } | ||
118 | +} | ||
119 | + | ||
120 | +``` | ||
121 | + | ||
122 | + | ||
123 | +## 删除分类接口 | ||
124 | + | ||
125 | +> 接口名: 'article/sort/delSort' | ||
126 | + | ||
127 | +### 入参 | ||
128 | + | ||
129 | +------------------------- | ||
130 | +|属性名称|类型|例子|说明| | ||
131 | +|--------|----|----|----| | ||
132 | +|id|intr|43|分类id| | ||
133 | +--------------------- | ||
134 | + | ||
135 | +### 返回 | ||
136 | + | ||
137 | +``` json | ||
138 | +{ | ||
139 | + "code":200, | ||
140 | + "message":"删除成功!" | ||
141 | +} | ||
142 | + | ||
143 | +``` | ||
144 | + | ||
145 | +``` |
@@ -114,6 +114,42 @@ | @@ -114,6 +114,42 @@ | ||
114 | "totalPage": 1 | 114 | "totalPage": 1 |
115 | }, | 115 | }, |
116 | "md5": "6d6052f3afcec10ba4d4c8490cd8e5eb", | 116 | "md5": "6d6052f3afcec10ba4d4c8490cd8e5eb", |
117 | + "message": "getLimitCodeList success." | ||
118 | +} | ||
119 | + | ||
120 | +``` | ||
121 | + | ||
122 | +# 获取限购码详情 | ||
123 | + | ||
124 | +> 接口名: `/limitCode/getLimitCode` | ||
125 | + | ||
126 | +### 入参 | ||
127 | + | ||
128 | +------------------------- | ||
129 | +|属性名称|类型|例子|说明|是否必填| | ||
130 | +|-------|----|----|----|-------| | ||
131 | +|id|int|7|限购码ID|是| | ||
132 | +-------------------------------- | ||
133 | + | ||
134 | +### 返回 | ||
135 | + | ||
136 | +``` json | ||
137 | +{ | ||
138 | + "code": 200, | ||
139 | + "data": { | ||
140 | + "batchNo": "201602031002", | ||
141 | + "createTime": "2016-02-03 17:33:08", | ||
142 | + "describe": "", | ||
143 | + "id": 7, | ||
144 | + "limitDateFrom": "2016-01-01", | ||
145 | + "limitDateTo": "2016-01-31", | ||
146 | + "limitTimes": 10, | ||
147 | + "name": "第一批次限购码", | ||
148 | + "reqDepartment": "运营部", | ||
149 | + "status": 0, | ||
150 | + "userUseLimit": 1 | ||
151 | + } | ||
152 | + "md5": "6d6052f3afcec10ba4d4c8490cd8e5eb", | ||
117 | "message": "getLimitCode success." | 153 | "message": "getLimitCode success." |
118 | } | 154 | } |
119 | 155 | ||
@@ -233,7 +269,7 @@ | @@ -233,7 +269,7 @@ | ||
233 | "all": "2" | 269 | "all": "2" |
234 | }, | 270 | }, |
235 | "md5": "f29559d3d32c56f9cd94c892128cbae8", | 271 | "md5": "f29559d3d32c56f9cd94c892128cbae8", |
236 | - "message": "deleteLimitCode success." | 272 | + "message": "getLimitCodeCountByStatus success." |
237 | } | 273 | } |
238 | 274 | ||
239 | ``` | 275 | ``` |
@@ -36,8 +36,8 @@ | @@ -36,8 +36,8 @@ | ||
36 | |属性名称|类型|例子|说明|是否必填| | 36 | |属性名称|类型|例子|说明|是否必填| |
37 | |-------|----|----|----|-------| | 37 | |-------|----|----|----|-------| |
38 | |sortId |int|1 |品类id |是 | | 38 | |sortId |int|1 |品类id |是 | |
39 | -|pageNumber|int|2|页码,默认1|是| | ||
40 | -|pageSize|int|20|记录数,默认10|是| | 39 | +|page|int|2|页码,默认1|是| |
40 | +|size|int|20|记录数,默认10|是| | ||
41 | -------------------------------- | 41 | -------------------------------- |
42 | 42 | ||
43 | ### 返回 | 43 | ### 返回 |
@@ -22,16 +22,16 @@ | @@ -22,16 +22,16 @@ | ||
22 | |size|Number|10|每页显示条数,默认10| | 22 | |size|Number|10|每页显示条数,默认10| |
23 | --------------------- | 23 | --------------------- |
24 | 24 | ||
25 | -### 返回 | 25 | +### 返回(备注: ("1", "男")("2", "女")("3", "通用") |
26 | 26 | ||
27 | ``` json | 27 | ``` json |
28 | { | 28 | { |
29 | "code": 200, | 29 | "code": 200, |
30 | "data": { | 30 | "data": { |
31 | - "content": [ | 31 | + "list": [ |
32 | { | 32 | { |
33 | "brand_id": 175, | 33 | "brand_id": 175, |
34 | - "brand_name": "团一", | 34 | + "brand_name": "品牌名称", |
35 | "founder": 9278, | 35 | "founder": 9278, |
36 | "max_sort_id": 10, | 36 | "max_sort_id": 10, |
37 | "max_sort_name": "创意生活", | 37 | "max_sort_name": "创意生活", |
@@ -46,12 +46,17 @@ | @@ -46,12 +46,17 @@ | ||
46 | "small_sort_id": 111, | 46 | "small_sort_id": 111, |
47 | "small_sort_name": "本子", | 47 | "small_sort_name": "本子", |
48 | "supplier_id": 0, | 48 | "supplier_id": 0, |
49 | + "supplier_name":"供应商名称", | ||
49 | "updateTime": "2016-02-02 10:37:43", | 50 | "updateTime": "2016-02-02 10:37:43", |
50 | "vip1_price": 0, | 51 | "vip1_price": 0, |
51 | "vip2_price": 0, | 52 | "vip2_price": 0, |
52 | "vip3_price": 0, | 53 | "vip3_price": 0, |
53 | "vip_discount_type": 1, | 54 | "vip_discount_type": 1, |
54 | - "vip_price": 0 | 55 | + "vip_price": 0, |
56 | + "shop_id":1, | ||
57 | + "shop_name":"店铺名称", | ||
58 | + "gender":"1", | ||
59 | + "founderName":"操作人姓名" | ||
55 | }, | 60 | }, |
56 | { | 61 | { |
57 | "brand_id": 187, | 62 | "brand_id": 187, |
@@ -70,18 +75,23 @@ | @@ -70,18 +75,23 @@ | ||
70 | "small_sort_id": 305, | 75 | "small_sort_id": 305, |
71 | "small_sort_name": "挂饰", | 76 | "small_sort_name": "挂饰", |
72 | "supplier_id": 0, | 77 | "supplier_id": 0, |
78 | + "supplier_name":"供应商名称", | ||
73 | "updateTime": "2016-02-02 10:37:43", | 79 | "updateTime": "2016-02-02 10:37:43", |
74 | "vip1_price": 0, | 80 | "vip1_price": 0, |
75 | "vip2_price": 0, | 81 | "vip2_price": 0, |
76 | "vip3_price": 0, | 82 | "vip3_price": 0, |
77 | "vip_discount_type": 1, | 83 | "vip_discount_type": 1, |
78 | - "vip_price": 0 | 84 | + "vip_price": 0, |
85 | + "shop_id":1, | ||
86 | + "shop_name":"店铺名称", | ||
87 | + "gender":"1", | ||
88 | + "founderName":"操作人姓名" | ||
79 | } | 89 | } |
80 | ], | 90 | ], |
81 | - "number": 1, | 91 | + "page": 1, |
82 | "size": 2, | 92 | "size": 2, |
83 | - "totalElements": 2, | ||
84 | - "totalPages": 1 | 93 | + "total": 2, |
94 | + "totalPage": 1 | ||
85 | }, | 95 | }, |
86 | "md5": "9a92b3c94d9676a8089169ee46ebce4a", | 96 | "md5": "9a92b3c94d9676a8089169ee46ebce4a", |
87 | "message": "Product Price List." | 97 | "message": "Product Price List." |
@@ -457,14 +467,156 @@ | @@ -457,14 +467,156 @@ | ||
457 | |vip3_price|float|22.33|折扣类型为5时必填| | 467 | |vip3_price|float|22.33|折扣类型为5时必填| |
458 | --------------------- | 468 | --------------------- |
459 | 469 | ||
460 | -### 返回 (备注 :code 为200代表成功 ) | 470 | +### 返回 (备注 :code 为200代表成功 , data表示成功记录的表格所处相对路径) |
461 | 471 | ||
462 | ``` json | 472 | ``` json |
463 | { | 473 | { |
464 | "code": 200, | 474 | "code": 200, |
465 | - "data": [], | 475 | + "data": "1455604702941.xlsx", |
466 | "md5": "d751713988987e9331980363e24189ce", | 476 | "md5": "d751713988987e9331980363e24189ce", |
467 | "message": "Product Price update success." | 477 | "message": "Product Price update success." |
468 | } | 478 | } |
469 | 479 | ||
480 | +``` | ||
481 | + | ||
482 | + | ||
483 | + | ||
484 | +## 下载文件 | ||
485 | + | ||
486 | +> 接口名: '/batch/download?path= ***' | ||
487 | + | ||
488 | +### 入参 | ||
489 | + | ||
490 | +------------------------- | ||
491 | +|属性名称|类型|例子|说明| | ||
492 | +|--------|----|----|----| | ||
493 | +|path|字符串|文件链接|必填| | ||
494 | +--------------------- | ||
495 | + | ||
496 | +### 返回 | ||
497 | + | ||
498 | +``` | ||
499 | +文件流 | ||
500 | +``` | ||
501 | + | ||
502 | + | ||
503 | + | ||
504 | +## 批量上传变价文本 | ||
505 | + | ||
506 | +> 接口名: '/batch/import' | ||
507 | + | ||
508 | +### 入参 | ||
509 | + | ||
510 | +------------------------- | ||
511 | +|属性名称|类型|例子|说明| | ||
512 | +|--------|----|----|----| | ||
513 | +|file|文件|文件流|必填| | ||
514 | +|type|字符串|price|必填| | ||
515 | +--------------------- | ||
516 | + | ||
517 | +### 返回 (备注:failFileReason 是失败的原因, succesList成功的列表 newProductPriceBo代表表格中的新数据 oldProductPriceBo代表数据库中的旧记录 ) | ||
518 | + | ||
519 | +``` | ||
520 | +{ | ||
521 | + "code": 200, | ||
522 | + "data": { | ||
523 | + "failFileReason": [ | ||
524 | + "第2行:对应的skn不存在数据库中;", | ||
525 | + "第3行:非代销商品;", | ||
526 | + "第5行:固定折扣,填写VIP价;", | ||
527 | + "第7行:固定折扣,填写VIP价;", | ||
528 | + "第9行:固定折扣,填写VIP价;", | ||
529 | + "第10行:固定折扣,填写VIP价;", | ||
530 | + "第11行:固定折扣,填写VIP价;", | ||
531 | + "第12行:固定折扣,填写VIP价;" | ||
532 | + ], | ||
533 | + "succesList": [ | ||
534 | + { | ||
535 | + "newProductPriceBo": { | ||
536 | + "product_skn": 50000082, | ||
537 | + "retail_price": 298, | ||
538 | + "return_coin": 1111, | ||
539 | + "sales_price": 22, | ||
540 | + "vip_discount_type": 4, | ||
541 | + "vip_price": 260 | ||
542 | + }, | ||
543 | + "oldProductPriceBo": { | ||
544 | + "product_skn": 50000082, | ||
545 | + "retail_price": 298, | ||
546 | + "return_coin": 0, | ||
547 | + "sales_price": 149, | ||
548 | + "vip1_price": 0, | ||
549 | + "vip2_price": 0, | ||
550 | + "vip3_price": 0, | ||
551 | + "vip_discount_type": 3, | ||
552 | + "vip_price": 0 | ||
553 | + } | ||
554 | + }, | ||
555 | + { | ||
556 | + "newProductPriceBo": { | ||
557 | + "product_skn": 50000082, | ||
558 | + "retail_price": 298, | ||
559 | + "return_coin": 1111, | ||
560 | + "sales_price": 22, | ||
561 | + "vip_discount_type": 4, | ||
562 | + "vip_price": 260 | ||
563 | + }, | ||
564 | + "oldProductPriceBo": { | ||
565 | + "product_skn": 50000082, | ||
566 | + "retail_price": 298, | ||
567 | + "return_coin": 0, | ||
568 | + "sales_price": 149, | ||
569 | + "vip1_price": 0, | ||
570 | + "vip2_price": 0, | ||
571 | + "vip3_price": 0, | ||
572 | + "vip_discount_type": 3, | ||
573 | + "vip_price": 0 | ||
574 | + } | ||
575 | + }, | ||
576 | + { | ||
577 | + "newProductPriceBo": { | ||
578 | + "product_skn": 50000082, | ||
579 | + "retail_price": 298, | ||
580 | + "return_coin": 1111, | ||
581 | + "sales_price": 22, | ||
582 | + "vip_discount_type": 4, | ||
583 | + "vip_price": 260 | ||
584 | + }, | ||
585 | + "oldProductPriceBo": { | ||
586 | + "product_skn": 50000082, | ||
587 | + "retail_price": 298, | ||
588 | + "return_coin": 0, | ||
589 | + "sales_price": 149, | ||
590 | + "vip1_price": 0, | ||
591 | + "vip2_price": 0, | ||
592 | + "vip3_price": 0, | ||
593 | + "vip_discount_type": 3, | ||
594 | + "vip_price": 0 | ||
595 | + } | ||
596 | + }, | ||
597 | + { | ||
598 | + "newProductPriceBo": { | ||
599 | + "product_skn": 50000082, | ||
600 | + "retail_price": 298, | ||
601 | + "return_coin": 1111, | ||
602 | + "sales_price": 22, | ||
603 | + "vip_discount_type": 4, | ||
604 | + "vip_price": 260 | ||
605 | + }, | ||
606 | + "oldProductPriceBo": { | ||
607 | + "product_skn": 50000082, | ||
608 | + "retail_price": 298, | ||
609 | + "return_coin": 0, | ||
610 | + "sales_price": 149, | ||
611 | + "vip1_price": 0, | ||
612 | + "vip2_price": 0, | ||
613 | + "vip3_price": 0, | ||
614 | + "vip_discount_type": 3, | ||
615 | + "vip_price": 0 | ||
616 | + } | ||
617 | + } | ||
618 | + ] | ||
619 | + }, | ||
620 | + "message": "导入成功" | ||
621 | +} | ||
470 | ``` | 622 | ``` |
inferface-document/shops/shops_decorator.md
0 → 100644
1 | +# 店铺装修接口 | ||
2 | + | ||
3 | +## 保存店铺装修系信息 | ||
4 | +> POST `/ShopsDecoratorRest/saveShopsDecorator` | ||
5 | + | ||
6 | +### 入参 | ||
7 | + | ||
8 | +```json | ||
9 | + | ||
10 | +{ | ||
11 | + "shopsId":1, | ||
12 | + "platform": "APP", | ||
13 | + "templateName": "BASE", | ||
14 | + "resources": [ | ||
15 | + { | ||
16 | + "id":7, | ||
17 | + "name": "shopTopBanner", | ||
18 | + "data": { | ||
19 | + "src": "http://img10.static.yhbimg.com/taobaocms/2016/01/25/12/0155598441256e46ec285a8ea64e762394.png", | ||
20 | + "isShowShopName": "Y" | ||
21 | + } | ||
22 | + }, | ||
23 | + { | ||
24 | + "id":8, | ||
25 | + "name": "productDetailTopBanner", | ||
26 | + "data": { | ||
27 | + "src": "http://img10.static.yhbimg.com/taobaocms/2016/01/25/12/015}5598441256e46ec285a8ea64e762394.png" | ||
28 | + } | ||
29 | + }, | ||
30 | + { | ||
31 | + "id":9, | ||
32 | + "name": "oneRowTwoColImages", | ||
33 | + "data": [ | ||
34 | + { | ||
35 | + "position": 1, | ||
36 | + "src": "http://img10.static.yhbimg.com/taobaocms/2016/01/25/12/0155598441256e46ec285a8ea64e762394.png", | ||
37 | + "url": {}, | ||
38 | + "startTime": 1309514897, | ||
39 | + "endTime": 1309514967, | ||
40 | + "publishStatus": 0 | ||
41 | + } | ||
42 | + ] | ||
43 | + }, | ||
44 | + { | ||
45 | + "id":10, | ||
46 | + "name": "hotProducts", | ||
47 | + "data": [ | ||
48 | + 50000881, | ||
49 | + 50000882, | ||
50 | + 50000883, | ||
51 | + 50000884, | ||
52 | + 50000885, | ||
53 | + 50000886, | ||
54 | + 50000887, | ||
55 | + 50000888 | ||
56 | + ] | ||
57 | + } | ||
58 | + ] | ||
59 | +} | ||
60 | +``` | ||
61 | + | ||
62 | +|参数名 |必填 |类型 |示例值 |描述 | | ||
63 | +|------ |---- |---- |------ |---- | | ||
64 | +|shopsId |是 |int |1 |店铺编号 | | ||
65 | +|platform |否 |string |APP |平台名称 | | ||
66 | +|templateName|否 |string |BASE |模板名称 | | ||
67 | +|resources |否 |json | |资源 | | ||
68 | + | ||
69 | +#### 资源描述-店铺头部横幅 | ||
70 | + | ||
71 | +|参数名 |必填 |类型 |示例值 |描述 | | ||
72 | +|------ |---- |---- |------ |---- | | ||
73 | +|id |否 |int |7 |资源编号 | | ||
74 | +|name |是 |string |shopTopBanner |资源名称 | | ||
75 | +|data |是 |json | |资源内容 | | ||
76 | +|src |是 |string |http://img10.static.yhbimg.com/taobaocms/2016/01/25/12/0155598441256e46ec285a8ea64e762394.png|店铺头部横幅图片| | ||
77 | +|isShowShopName |否 |string |Y |是否显示店铺名称| | ||
78 | + | ||
79 | +#### 资源描述-商品详情头部横幅 | ||
80 | + | ||
81 | +|参数名 |必填 |类型 |示例值 |描述 | | ||
82 | +|------ |---- |---- |------ |---- | | ||
83 | +|id |否 |int |8 |资源编号 | | ||
84 | +|name |是 |string |productDetailTopBanner |资源名称 | | ||
85 | +|data |是 |json | |资源内容 | | ||
86 | +|src |是 |string |http://img10.static.yhbimg.com/taobaocms/2016/01/25/12/0155598441256e46ec285a8ea64e762394.png|商品详情头部横幅图片| | ||
87 | + | ||
88 | + | ||
89 | +### 返回 | ||
90 | + | ||
91 | +```json | ||
92 | + | ||
93 | +{ | ||
94 | + "code": 200, | ||
95 | + "message": "操作成功", | ||
96 | + "data":{ | ||
97 | + "id":1, | ||
98 | + "platform":"APP", | ||
99 | + "templateName":"BASE", | ||
100 | + "resources":[] | ||
101 | + } | ||
102 | +} | ||
103 | +``` | ||
104 | + | ||
105 | +|参数名 |必填 |类型 |示例值 |描述 | | ||
106 | +|------ |---- |---- |------ |---- | | ||
107 | +|id |是 |int |1 |店铺装修编号 | | ||
108 | +|platform |是 |string |APP |平台名称 | | ||
109 | +|templateName|是 |string |BASE |模板名称 | | ||
110 | +|resources |是 |json | |资源 | | ||
111 | + | ||
112 | + | ||
113 | +## 查询店铺装修信息 | ||
114 | +> POST `/ShopsDecoratorRest/findShopsDecorator` | ||
115 | + | ||
116 | +### 入参 | ||
117 | + | ||
118 | +```json | ||
119 | + | ||
120 | +{ | ||
121 | + "page":1, | ||
122 | + "size":20, | ||
123 | + "shopsId":1, | ||
124 | + "checkStatus": 100, | ||
125 | + "supplierId": 1, | ||
126 | + "brandId": 1 | ||
127 | +} | ||
128 | +``` | ||
129 | + | ||
130 | +|参数名 |必填 |类型 |示例值 |描述 | | ||
131 | +|------ |---- |---- |------ |---- | | ||
132 | +|page |否 |int |1 |页数 | | ||
133 | +|size |否 |int |20 |每页大小 | | ||
134 | +|shopsId |否 |int |1 |店铺编号 | | ||
135 | +|checkStatus |否 |int |100 |审核状态 | | ||
136 | +|supplierId |否 |int |1 |供应商编号 | | ||
137 | +|brandId |否 |int |1 |品牌编号 | | ||
138 | + | ||
139 | + | ||
140 | +### 返回 | ||
141 | + | ||
142 | +```json | ||
143 | + | ||
144 | +{ | ||
145 | + "code": 200, | ||
146 | + "message": "操作成功", | ||
147 | + "data":{ | ||
148 | + "page":1, | ||
149 | + "size":20, | ||
150 | + "total":101, | ||
151 | + "totalPage":6, | ||
152 | + "list":[{ | ||
153 | + "id":1, | ||
154 | + "shopsId":1, | ||
155 | + "shopsName":"T.U.K", | ||
156 | + "checkStatus":100, | ||
157 | + "createTime":1454551897, | ||
158 | + "updateTime":1454551897, | ||
159 | + "status":1, | ||
160 | + "brands":[{ | ||
161 | + "id":517, | ||
162 | + "brandName":"T.U.K", | ||
163 | + "brandNameCn":"", | ||
164 | + "brandNameEn":"T.U.K" | ||
165 | + }] | ||
166 | + }] | ||
167 | + } | ||
168 | +} | ||
169 | +``` | ||
170 | + | ||
171 | +|参数名 |必填 |类型 |示例值 |描述 | | ||
172 | +|------ |---- |---- |------ |---- | | ||
173 | +|page |是 |int |1 |页数 | | ||
174 | +|size |是 |int |20 |每页大小 | | ||
175 | +|total |是 |int |1 |总记录数 | | ||
176 | +|totalPage |是 |int |100 |总页数 | | ||
177 | +|list |是 |json | |店铺装修信息 | | ||
178 | +|id |否 |int |1 |店铺装修编号 | | ||
179 | +|shopsId |是 |int |1 |店铺编号 | | ||
180 | +|shopsName |是 |string |T.U.K |店铺名称 | | ||
181 | +|checkStatus |否 |int |100 |店铺装修审核状态| | ||
182 | +|createTime |否 |int |1454551897 |店铺创建时间 | | ||
183 | +|updateTime |否 |int |1454551897 |店铺更新时间 | | ||
184 | +|status |否 |int |1 |店铺装修状态 | | ||
185 | +|brands |否 |json | |品牌信息 | | ||
186 | +|id |否 |int |517 |品牌编号 | | ||
187 | +|brandName |否 |string |T.U.K |品牌名称 | | ||
188 | +|brandNameCn |否 |string | |品牌中文名称 | | ||
189 | +|brandNameEn |否 |string |T.U.K |品牌英文名称 | | ||
190 | + | ||
191 | + | ||
192 | +## 查询店铺装修详细信息 | ||
193 | +> POST `/ShopsDecoratorRest/findShopsDecoratorDetail` | ||
194 | + | ||
195 | +### 入参 | ||
196 | + | ||
197 | +```json | ||
198 | + | ||
199 | +{ | ||
200 | + "id":2, | ||
201 | + "platform": "APP", | ||
202 | + "templateName": "BASE" | ||
203 | +} | ||
204 | +``` | ||
205 | + | ||
206 | +|参数名 |必填 |类型 |示例值 |描述 | | ||
207 | +|------ |---- |---- |------ |---- | | ||
208 | +|id |是 |int |1 |页数 | | ||
209 | +|platform |否 |string |APP |平台名称(默认:APP) | | ||
210 | +|templateName|否 |string |BASE |模板名称(默认:启用的模板)| | ||
211 | + | ||
212 | +### 返回 | ||
213 | + | ||
214 | +```json | ||
215 | + | ||
216 | +{ | ||
217 | + "code": 200, | ||
218 | + "message": "操作成功", | ||
219 | + "data":{ | ||
220 | + "id":1, | ||
221 | + "platform":"APP", | ||
222 | + "templateName":"BASE", | ||
223 | + "resources":[] | ||
224 | + } | ||
225 | +} | ||
226 | +``` | ||
227 | + | ||
228 | +|参数名 |必填 |类型 |示例值 |描述 | | ||
229 | +|------ |---- |---- |------ |---- | | ||
230 | +|id |是 |int |1 |店铺装修编号 | | ||
231 | +|platform |是 |string |APP |平台名称 | | ||
232 | +|templateName|是 |string |BASE |模板名称 | | ||
233 | +|resources |是 |json | |资源 | |
@@ -34,8 +34,8 @@ | @@ -34,8 +34,8 @@ | ||
34 | ------------------------- | 34 | ------------------------- |
35 | |属性名称|类型|例子|说明|是否必填| | 35 | |属性名称|类型|例子|说明|是否必填| |
36 | |-------|----|----|----|-------| | 36 | |-------|----|----|----|-------| |
37 | -|curPage|int|1|页码|是| | ||
38 | -|pageSize|int|10|条数|是| | 37 | +|page|int|1|页码|是| |
38 | +|size|int|10|条数|是| | ||
39 | -------------------------------- | 39 | -------------------------------- |
40 | 40 | ||
41 | ### 返回 | 41 | ### 返回 |
@@ -157,9 +157,9 @@ | @@ -157,9 +157,9 @@ | ||
157 | "code": 200, | 157 | "code": 200, |
158 | "data": [ | 158 | "data": [ |
159 | { | 159 | { |
160 | - "attributeName": "衣长", | ||
161 | - "id": 60, | ||
162 | - "orderBy": 0 | 160 | + "text": "衣长", |
161 | + "id": 60 | ||
162 | + | ||
163 | } | 163 | } |
164 | ], | 164 | ], |
165 | "md5": "dfc645ecb0c66c8d4771dd2a749047e8", | 165 | "md5": "dfc645ecb0c66c8d4771dd2a749047e8", |
@@ -72,8 +72,8 @@ | @@ -72,8 +72,8 @@ | ||
72 | ------------------------- | 72 | ------------------------- |
73 | |属性名称|类型|例子|说明|是否必填| | 73 | |属性名称|类型|例子|说明|是否必填| |
74 | |-------|----|----|----|-------| | 74 | |-------|----|----|----|-------| |
75 | -|curPage|int|1|页码|是| | ||
76 | -|pageSize|int|10|条数|是| | 75 | +|page|int|1|页码|是| |
76 | +|size|int|10|条数|是| | ||
77 | -------------------------------- | 77 | -------------------------------- |
78 | 78 | ||
79 | ### 返回 | 79 | ### 返回 |
@@ -169,4 +169,45 @@ | @@ -169,4 +169,45 @@ | ||
169 | } | 169 | } |
170 | 170 | ||
171 | ``` | 171 | ``` |
172 | +# 根据名称获取尺码接口 | ||
173 | + | ||
174 | +> 接口名: `/product/querySizeByNameForSelect/` | ||
175 | + | ||
176 | +### 入参 | ||
177 | + | ||
178 | +------------------------- | ||
179 | +|属性名称|类型|例子|说明|是否必填| | ||
180 | +|--------|----|----|----|--------| | ||
181 | +|idName |String |码 |名称 |否| | ||
182 | +--------------------- | ||
183 | + | ||
184 | +### 返回 | ||
185 | + | ||
186 | +``` json | ||
187 | +{ | ||
188 | + "code": 200, | ||
189 | + "data": { | ||
190 | + { | ||
191 | + "id": "2", | ||
192 | + "text": "10#" | ||
193 | + }, | ||
194 | + { | ||
195 | + "id": "3", | ||
196 | + "text": "10.5码" | ||
197 | + }, | ||
198 | + { | ||
199 | + "id": "4", | ||
200 | + "text": "10000" | ||
201 | + }, | ||
202 | + { | ||
203 | + "id": "5", | ||
204 | + "text": "105" | ||
205 | + } | ||
206 | + }, | ||
207 | + "md5": "dfc645ecb0c66c8d4771dd2a749047e8", | ||
208 | + "message": "success" | ||
209 | +} | ||
210 | + | ||
211 | +``` | ||
212 | + | ||
172 | 213 |
@@ -35,8 +35,9 @@ | @@ -35,8 +35,9 @@ | ||
35 | 35 | ||
36 | ------------------------- | 36 | ------------------------- |
37 | |属性名称|类型|例子|说明|是否必填| | 37 | |属性名称|类型|例子|说明|是否必填| |
38 | -|sortId|int |1 |分类id|是| | 38 | + |
39 | |-------|----|----|----|-------| | 39 | |-------|----|----|----|-------| |
40 | +|sortId|int |1 |分类id|是| | ||
40 | -------------------------------- | 41 | -------------------------------- |
41 | 42 | ||
42 | ### 返回 | 43 | ### 返回 |
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 | - | 1 | +供应商接口服务定义 |
2 | +--------------------- | ||
3 | +#### 创建供应商页接口 | ||
4 | + | ||
5 | +> 接口名: '/supplier/supplier/getCreateSupplierList' | ||
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 | +> 接口名: '/supplier/supplier/getManageSupplierList' | ||
39 | + | ||
40 | +##### 入参 | ||
41 | +|属性名称|类型|例子|说明| | ||
42 | +|--------|----|----|----| | ||
43 | +|id|int|10|id| | ||
44 | +|status|int|100|供应商状态(100:暂存,200:审核中,300:通过, 900: 驳回)| | ||
45 | +|isFreeze|string|Y,N|生效状态(Y:已冻结, N:生效中)| | ||
46 | +##### 返回 | ||
47 | +> 同创建供应商页接口 | ||
48 | +#### 供应商审核列表页接口 | ||
49 | + | ||
50 | +> 接口名: '/supplier/supplier/getAuditSupplierList' | ||
51 | + | ||
52 | +##### 入参 | ||
53 | +|属性名称|类型|例子|说明| | ||
54 | +|--------|----|----|----| | ||
55 | +|id|int|10|id| | ||
56 | +##### 返回 | ||
57 | + | ||
58 | +> 同创建供应商页接口 | ||
59 | + | ||
60 | +#### 供应商新增编辑接口 | ||
61 | +> 接口名: '/supplier/supplier/addSupplier' | ||
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 | +> 接口名: '/supplier/supplier/updateSupplier' | ||
89 | + | ||
90 | +##### 入参 | ||
91 | +|属性名称|类型|例子|说明| | ||
92 | +|--------|----|----|----| | ||
93 | +|id|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 | +> 接口名: '/supplier/supplier/updateSupplier' | ||
106 | + | ||
107 | +##### 入参 | ||
108 | +|属性名称|类型|例子|说明| | ||
109 | +|--------|----|----|----| | ||
110 | +|id|int|10|供应商名称| | ||
111 | +|isFreeze|string|Y,N|生效状态(Y:已冻结, N:生效中)| | ||
112 | +##### 返回 | ||
113 | +``` json | ||
114 | +{ | ||
115 | + "code": 200, | ||
116 | + "message": "修改成功", | ||
117 | +} | ||
118 | + | ||
119 | +``` | ||
120 | +##### 查看供应商接口 | ||
121 | +> 接口名: '/supplier/supplier/getSupplier' | ||
122 | + | ||
123 | +##### 入参 | ||
124 | +|属性名称|类型|例子|说明| | ||
125 | +|--------|----|----|----| | ||
126 | +|id|int|123|id| | ||
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 | ``` | 178 | ``` |
-
Please register or login to post a comment