Showing
2 changed files
with
365 additions
and
0 deletions
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/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 | +``` |
-
Please register or login to post a comment