Authored by ping

update

1 -# 店铺接口服务定义  
2 ----------------------  
3 -  
4 -## 创建店铺  
5 -  
6 -> 接口名:`/shops/createShop`  
7 -  
8 -### 入参  
9 -  
10 --------------------------  
11 -|属性名称|类型|例子|说明|  
12 -|--------|----|----|----|  
13 -|shopName|String|得宝旗舰店|店铺名称|  
14 -|shopNature|int|1|店铺性质(1 旗舰店 2 专卖店)|  
15 -|shopDomain|String|debao|店铺域名|  
16 -|createPid|int|1|创建人ID|  
17 -|shopLogo|String|http://img11.static.yhbimg.com/yhb-img01/2015/09/11/02/01f42dff5d5bd383af1025eea1218cbccc.jpg?imageView/{mode}/w/{width}/h/{height}|店铺logo|  
18 -|shopIntro|String|秉承以设计为核心的创新理念,用专业的思维方式将自然与科技、传统与革新、技艺与时尚三者良好融合,着重面料材质与软式廓型的品质互动,更好的诠释“less is more”的设计理念。|店铺简介|  
19 -|shopAdmin|JSON数组|||  
20 -|shopRelation|JSON数组|||  
21 -|websiteUrl|JSON数组|["www.paperworks.com.cn"]||  
22 -|otherUrl|JSON数组|["www.paperworks.com.cn","https:\/\/jnby.tmall.com\/"]||  
23 -|shopAddress|JSON数组|||  
24 ----------------------  
25 -  
26 -### 返回  
27 -  
28 -``` json  
29 -{  
30 - "code":200,  
31 - "message":"创建成功",  
32 - "data":{  
33 - "shopId":12  
34 - }  
35 -}  
36 -{  
37 - "code":500,  
38 - "message":"创建失败",  
39 - "data":{  
40 - "shopId":-12  
41 - }  
42 -}  
43 -{  
44 - "code":500  
45 - "message":"shop_name is null"  
46 -}  
47 -{  
48 - "code":500  
49 - "message":"Sorry,店铺名已存在"  
50 -}  
51 -{  
52 - "code":500  
53 - "message":"shop_domain is null"  
54 -}  
55 -{  
56 - "code":500  
57 - "message":"Sorry,店铺域名已存在"  
58 -}  
59 -{  
60 - "code":500  
61 - "message":"shop_admin is null"  
62 -}  
63 -{  
64 - "code":500  
65 - "message":"shop_relation is null"  
66 -}  
67 -```  
68 -  
69 -  
70 -## 获取店铺列表  
71 -> 接口名: `/shops/getShopList`  
72 -  
73 -### 入参  
74 -  
75 --------------------------  
76 -|属性名称|类型|例子|说明|  
77 -|--------|----|----|----|  
78 -|page|int|2|第几页|  
79 -|size|int|50|每页条数|  
80 -|shopsId|int|15|店铺ID|  
81 -|shopName|String|得宝旗舰店|店铺名称|  
82 -|shopNature|int|1|店铺性质(1 旗舰店 2 专卖店)|  
83 -|status|int|1|状态(1开启 0 关闭)|  
84 -|checkStatus|int|300|审核状态(100 暂存 200 待审核 300 审核通过 900 驳回)|  
85 -|supplierId|int|950|供应商ID|  
86 -|brandId|int|928|品牌ID|  
87 ----------------------------  
88 -  
89 -### 返回  
90 -  
91 -```json  
92 -  
93 -{  
94 - "code":200  
95 - "message":"ok"  
96 - "data":  
97 - {  
98 - "page":1,  
99 - "totalPage": 10,  
100 - "total": 100  
101 - "size": 10,  
102 - "list":  
103 - {  
104 - "shopsId": 15,  
105 - "shopName": "",  
106 - "shopDomain": "",  
107 - "shopNature": "",  
108 - "shopLogo": "",  
109 - "websiteUrl": "",  
110 - "shopAddress": "",  
111 - "createPid": "",  
112 - "checkStatus": "",  
113 - "createTime": "",  
114 - "updateTime": "",  
115 - "status": "",  
116 - "shopsAdmin": {  
117 - "id": "",  
118 - "shopsId": "",  
119 - "adminPid": "",  
120 - "identity": "",  
121 - "createTime": "",  
122 - "updateTime": ""  
123 - },  
124 - "shopsBrandList": [{  
125 - "id": "",  
126 - "shopsId": "",  
127 - "brandId": "",  
128 - "supplierId": "",  
129 - "createTime": "",  
130 - "updateTime": "",  
131 - "agreementEndTime": ""  
132 - },{  
133 - "id": "",  
134 - "shopsId": "",  
135 - "brandId": "",  
136 - "supplierId": "",  
137 - "createTime": "",  
138 - "updateTime": "",  
139 - "agreementEndTime": ""  
140 - }],  
141 - "shopsSupplierList": [{  
142 - "id": "",  
143 - "shopsId": "",  
144 - "brandId": "",  
145 - "brandName": "",  
146 - "agreementEndTime": ""  
147 - },{  
148 - "id": "",  
149 - "shopsId": "",  
150 - "brandId": "",  
151 - "brandName": "",  
152 - "agreementEndTime": ""  
153 - }]  
154 - }  
155 - }  
156 -}  
157 -```  
158 -  
159 -## 店铺同步  
160 -> 接口名: `/shops/synchronizeShop`  
161 -  
162 -### 入参  
163 -  
164 --------------------------  
165 -|属性名称|类型|例子|说明|  
166 -|--------|----|----|----|  
167 -|shopName|String|得宝旗舰店|店铺名称|  
168 -|shopNature|int|1|店铺性质(1 旗舰店 2 专卖店)|  
169 -|shopDomain|String|debao|店铺域名|  
170 -|createPid|int|1|创建人ID|  
171 -shopLogo|String|http://img11.static.yhbimg.com/yhb-img01/2015/09/11/02/01f42dff5d5bd383af1025eea1218cbccc.jpg?imageView/{mode}/w/{width}/h/{height}|店铺logo|  
172 -|shopIntro|String|秉承以设计为核心的创新理念,用专业的思维方式将自然与科技、传统与革新、技艺与时尚三者良好融合,着重面料材质与软式廓型的品质互动,更好的诠释“less is more”的设计理念。|店铺简介|  
173 -|shopAdmin|JSON数组|||  
174 -|shopRelation|JSON数组|||  
175 -|websiteUrl|JSON数组|["www.paperworks.com.cn"]||  
176 -|otherUrl|JSON数组|["www.paperworks.com.cn","https:\/\/jnby.tmall.com\/"]||  
177 -|shopAddress|JSON数组|||  
178 ----------------------------  
179 -  
180 -### 返回  
181 -  
182 -```json  
183 -  
184 -{  
185 - "code":200  
186 - "message":"修改成功"  
187 -}  
188 -{  
189 - "code":500  
190 - "message":"shops_id is null"  
191 -}  
192 -{  
193 - "code":500  
194 - "message":"shop_name is null"  
195 -}  
196 -{  
197 - "code":500  
198 - "message":"Sorry,店铺名已存在"  
199 -}  
200 -{  
201 - "code":500  
202 - "message":"shop_domain is null"  
203 -}  
204 -{  
205 - "code":500  
206 - "message":"Sorry,域名已存在"  
207 -}  
208 -```  
209 -  
210 -## 根据店铺名查看是否存在  
211 -  
212 -> 接口名:`/shops/checkByShopName`  
213 -  
214 -### 入参  
215 -  
216 --------------------------  
217 -|属性名称|类型|例子|说明|  
218 -|--------|----|----|----|  
219 -|shopName|String|得宝旗舰店|店铺名称|  
220 -|shopsId|int|15|店铺ID|  
221 --------------------  
222 -  
223 -### 返回  
224 -  
225 -```json  
226 -{  
227 - "code":500,  
228 - "message":"shop_name is null"  
229 -}  
230 -{  
231 - "code":500,  
232 - "message":"shops_id is null"  
233 -}  
234 -{  
235 - "code":400,  
236 - "message":"false"  
237 -}  
238 -{  
239 - "code":200,  
240 - "message":"true"  
241 -}  
242 -```  
243 -  
244 -  
245 -## 根据店铺域名查看是否存在  
246 -  
247 -> 接口名: `/shops/checkByShopDomain`  
248 -  
249 -### 入参  
250 -  
251 --------------------------  
252 -|属性名称|类型|例子|说明|  
253 -|--------|----|----|----|  
254 -|shopDomain|String|debao|店铺域名|  
255 -|shopsId|int|15|店铺ID|  
256 ------------------------------  
257 -  
258 -### 返回  
259 -  
260 -```json  
261 -  
262 -{  
263 - "code":500,  
264 - "message":"shop_name is null"  
265 -}  
266 -{  
267 - "code":500,  
268 - "message":"shops_id is null"  
269 -}  
270 -{  
271 - "code":400,  
272 - "message":"false"  
273 -}  
274 -{  
275 - "code":200,  
276 - "message":"true"  
277 -}  
278 -  
279 -```  
280 -  
281 -## 获取店铺详情  
282 -  
283 -> 接口名: `/shops/getDetailByShopId`  
284 -  
285 -### 入参  
286 -  
287 --------------------------  
288 -|属性名称|类型|例子|说明|  
289 -|--------|----|----|----|  
290 -|shopsId|int|15|店铺ID|  
291 ------------------------------  
292 -  
293 -### 返回  
294 -  
295 -```json  
296 -  
297 -{  
298 - "code":400,  
299 - "message":"店铺id有误"  
300 -}  
301 -{  
302 - "code":400,  
303 - "message":"shopInfo is none"  
304 -}  
305 -{  
306 - "code":200  
307 - "message":"ok"  
308 - "data":  
309 - {  
310 - {  
311 - "shopsId": 15,  
312 - "shopName": "",  
313 - "shopDomain": "",  
314 - "shopNature": "",  
315 - "shopLogo": "",  
316 - "websiteUrl": "",  
317 - "shopAddress": "",  
318 - "createPid": "",  
319 - "checkStatus": "",  
320 - "createTime": "",  
321 - "updateTime": "",  
322 - "status": ""  
323 - },  
324 - "shopsAdmin": [{  
325 - "id": "",  
326 - "shopsId": "",  
327 - "adminPid": "",  
328 - "identity": "",  
329 - "createTime": "",  
330 - "updateTime": ""  
331 - },{  
332 - "id": "",  
333 - "shopsId": "",  
334 - "adminPid": "",  
335 - "identity": "",  
336 - "createTime": "",  
337 - "updateTime": ""  
338 - }],  
339 - "shopRelation": [{  
340 - "id": "",  
341 - "shopsId": "",  
342 - "brandId": "",  
343 - "supplierId": "",  
344 - "createTime": "",  
345 - "updateTime": "",  
346 - "agreementEndTime": ""  
347 - },{  
348 - "id": "",  
349 - "shopsId": "",  
350 - "brandId": "",  
351 - "supplierId": "",  
352 - "createTime": "",  
353 - "updateTime": "",  
354 - "agreementEndTime": ""  
355 - }]  
356 - }  
357 - }  
358 -}  
359 -```  
360 -  
361 - 1 +# 店铺接口服务定义
  2 +---------------------
  3 +
  4 +## 创建店铺
  5 +
  6 +> 接口名:`/ShopsRest/addShops`
  7 +
  8 +### 入参
  9 +
  10 +-------------------------
  11 +|属性名称|类型|例子|说明|
  12 +|--------|----|----|----|
  13 +|shopName|String|得宝旗舰店|店铺名称|
  14 +|shopNature|int|1|店铺性质(1 旗舰店 2 专卖店)|
  15 +|shopDomain|String|debao|店铺域名|
  16 +|createPid|int|1|创建人ID|
  17 +|shopsType|int|1|店铺模式(1-单品店;2-多品店)|
  18 +|shopLogo|String|http://img11.static.yhbimg.com/yhb-img01/2015/09/11/02/01f42dff5d5bd383af1025eea1218cbccc.jpg?imageView/{mode}/w/{width}/h/{height}|店铺logo|
  19 +|shopIntro|String|秉承以设计为核心的创新理念,用专业的思维方式将自然与科技、传统与革新、技艺与时尚三者良好融合,着重面料材质与软式廓型的品质互动,更好的诠释“less is more”的设计理念。|店铺简介|
  20 +|websiteUrl|JSON数组|["www.paperworks.com.cn"]||
  21 +|otherUrl|JSON数组|["www.paperworks.com.cn","https:\/\/jnby.tmall.com\/"]||
  22 +|shopAddress|JSON数组|||
  23 +|onCheck|int|1|是否需要审核(1-是;0-否)|
  24 +|shopRelation|JSON数组||品牌与供应商关系[
  25 + {
  26 + "brandId":355,
  27 + "supplierId":310,
  28 + "agreementEndTime":1485792000
  29 + },
  30 + {
  31 + "brandId":1389,
  32 + "supplierId":1226,
  33 + "agreementEndTime":1482076800
  34 + }
  35 + ]|
  36 +---------------------
  37 +
  38 +### 返回
  39 +
  40 +``` json
  41 +{
  42 + "code":200,
  43 + "message":"创建成功",
  44 + "data":{
  45 + "shopId":12
  46 + }
  47 +}
  48 +{
  49 + "code":500,
  50 + "message":"创建失败",
  51 + "data":{
  52 + "shopId":-12
  53 + }
  54 +}
  55 +{
  56 + "code":500
  57 + "message":"shop_name is null"
  58 +}
  59 +{
  60 + "code":500
  61 + "message":"Sorry,店铺名已存在"
  62 +}
  63 +{
  64 + "code":500
  65 + "message":"shop_domain is null"
  66 +}
  67 +{
  68 + "code":500
  69 + "message":"Sorry,店铺域名已存在"
  70 +}
  71 +{
  72 + "code":500
  73 + "message":"shop_admin is null"
  74 +}
  75 +{
  76 + "code":500
  77 + "message":"shop_relation is null"
  78 +}
  79 +```
  80 +
  81 +
  82 +## 获取店铺列表
  83 +> 接口名: `/shops/getShopList`
  84 +
  85 +### 入参
  86 +
  87 +-------------------------
  88 +|属性名称|类型|例子|说明|
  89 +|--------|----|----|----|
  90 +|page|int|2|第几页|
  91 +|size|int|50|每页条数|
  92 +|shopsId|int|15|店铺ID|
  93 +|shopName|String|得宝旗舰店|店铺名称|
  94 +|shopNature|int|1|店铺性质(1 旗舰店 2 专卖店)|
  95 +|status|int|1|状态(1开启 0 关闭)|
  96 +|checkStatus|int|300|审核状态(100 暂存 200 待审核 300 审核通过 900 驳回)|
  97 +|supplierId|int|950|供应商ID|
  98 +|brandId|int|928|品牌ID|
  99 +---------------------------
  100 +
  101 +### 返回
  102 +
  103 +```json
  104 +
  105 +{
  106 + "code":200
  107 + "message":"ok"
  108 + "data":
  109 + {
  110 + "page":1,
  111 + "totalPage": 10,
  112 + "total": 100
  113 + "size": 10,
  114 + "list":
  115 + {
  116 + "shopsId": 15,
  117 + "shopName": "",
  118 + "shopDomain": "",
  119 + "shopNature": "",
  120 + "shopLogo": "",
  121 + "websiteUrl": "",
  122 + "shopAddress": "",
  123 + "createPid": "",
  124 + "checkStatus": "",
  125 + "createTime": "",
  126 + "updateTime": "",
  127 + "status": "",
  128 + "shopsAdmin": {
  129 + "id": "",
  130 + "shopsId": "",
  131 + "adminPid": "",
  132 + "identity": "",
  133 + "createTime": "",
  134 + "updateTime": ""
  135 + },
  136 + "shopsBrandList": [{
  137 + "id": "",
  138 + "shopsId": "",
  139 + "brandId": "",
  140 + "supplierId": "",
  141 + "createTime": "",
  142 + "updateTime": "",
  143 + "agreementEndTime": ""
  144 + },{
  145 + "id": "",
  146 + "shopsId": "",
  147 + "brandId": "",
  148 + "supplierId": "",
  149 + "createTime": "",
  150 + "updateTime": "",
  151 + "agreementEndTime": ""
  152 + }],
  153 + "shopsSupplierList": [{
  154 + "id": "",
  155 + "shopsId": "",
  156 + "brandId": "",
  157 + "brandName": "",
  158 + "agreementEndTime": ""
  159 + },{
  160 + "id": "",
  161 + "shopsId": "",
  162 + "brandId": "",
  163 + "brandName": "",
  164 + "agreementEndTime": ""
  165 + }]
  166 + }
  167 + }
  168 +}
  169 +```
  170 +
  171 +## 店铺同步
  172 +> 接口名: `/shops/synchronizeShop`
  173 +
  174 +### 入参
  175 +
  176 +-------------------------
  177 +|属性名称|类型|例子|说明|
  178 +|--------|----|----|----|
  179 +|shopName|String|得宝旗舰店|店铺名称|
  180 +|shopNature|int|1|店铺性质(1 旗舰店 2 专卖店)|
  181 +|shopDomain|String|debao|店铺域名|
  182 +|createPid|int|1|创建人ID|
  183 +shopLogo|String|http://img11.static.yhbimg.com/yhb-img01/2015/09/11/02/01f42dff5d5bd383af1025eea1218cbccc.jpg?imageView/{mode}/w/{width}/h/{height}|店铺logo|
  184 +|shopIntro|String|秉承以设计为核心的创新理念,用专业的思维方式将自然与科技、传统与革新、技艺与时尚三者良好融合,着重面料材质与软式廓型的品质互动,更好的诠释“less is more”的设计理念。|店铺简介|
  185 +|shopAdmin|JSON数组|||
  186 +|shopRelation|JSON数组|||
  187 +|websiteUrl|JSON数组|["www.paperworks.com.cn"]||
  188 +|otherUrl|JSON数组|["www.paperworks.com.cn","https:\/\/jnby.tmall.com\/"]||
  189 +|shopAddress|JSON数组|||
  190 +---------------------------
  191 +
  192 +### 返回
  193 +
  194 +```json
  195 +
  196 +{
  197 + "code":200
  198 + "message":"修改成功"
  199 +}
  200 +{
  201 + "code":500
  202 + "message":"shops_id is null"
  203 +}
  204 +{
  205 + "code":500
  206 + "message":"shop_name is null"
  207 +}
  208 +{
  209 + "code":500
  210 + "message":"Sorry,店铺名已存在"
  211 +}
  212 +{
  213 + "code":500
  214 + "message":"shop_domain is null"
  215 +}
  216 +{
  217 + "code":500
  218 + "message":"Sorry,域名已存在"
  219 +}
  220 +```
  221 +
  222 +## 根据店铺名查看是否存在
  223 +
  224 +> 接口名:`/shops/checkByShopName`
  225 +
  226 +### 入参
  227 +
  228 +-------------------------
  229 +|属性名称|类型|例子|说明|
  230 +|--------|----|----|----|
  231 +|shopName|String|得宝旗舰店|店铺名称|
  232 +|shopsId|int|15|店铺ID|
  233 +-------------------
  234 +
  235 +### 返回
  236 +
  237 +```json
  238 +{
  239 + "code":500,
  240 + "message":"shop_name is null"
  241 +}
  242 +{
  243 + "code":500,
  244 + "message":"shops_id is null"
  245 +}
  246 +{
  247 + "code":400,
  248 + "message":"false"
  249 +}
  250 +{
  251 + "code":200,
  252 + "message":"true"
  253 +}
  254 +```
  255 +
  256 +
  257 +## 根据店铺域名查看是否存在
  258 +
  259 +> 接口名: `/shops/checkByShopDomain`
  260 +
  261 +### 入参
  262 +
  263 +-------------------------
  264 +|属性名称|类型|例子|说明|
  265 +|--------|----|----|----|
  266 +|shopDomain|String|debao|店铺域名|
  267 +|shopsId|int|15|店铺ID|
  268 +-----------------------------
  269 +
  270 +### 返回
  271 +
  272 +```json
  273 +
  274 +{
  275 + "code":500,
  276 + "message":"shop_name is null"
  277 +}
  278 +{
  279 + "code":500,
  280 + "message":"shops_id is null"
  281 +}
  282 +{
  283 + "code":400,
  284 + "message":"false"
  285 +}
  286 +{
  287 + "code":200,
  288 + "message":"true"
  289 +}
  290 +
  291 +```
  292 +
  293 +## 获取店铺详情
  294 +
  295 +> 接口名: `/shops/getDetailByShopId`
  296 +
  297 +### 入参
  298 +
  299 +-------------------------
  300 +|属性名称|类型|例子|说明|
  301 +|--------|----|----|----|
  302 +|shopsId|int|15|店铺ID|
  303 +-----------------------------
  304 +
  305 +### 返回
  306 +
  307 +```json
  308 +
  309 +{
  310 + "code":400,
  311 + "message":"店铺id有误"
  312 +}
  313 +{
  314 + "code":400,
  315 + "message":"shopInfo is none"
  316 +}
  317 +{
  318 + "code":200
  319 + "message":"ok"
  320 + "data":
  321 + {
  322 + {
  323 + "shopsId": 15,
  324 + "shopName": "",
  325 + "shopDomain": "",
  326 + "shopNature": "",
  327 + "shopLogo": "",
  328 + "websiteUrl": "",
  329 + "shopAddress": "",
  330 + "createPid": "",
  331 + "checkStatus": "",
  332 + "createTime": "",
  333 + "updateTime": "",
  334 + "status": ""
  335 + },
  336 + "shopsAdmin": [{
  337 + "id": "",
  338 + "shopsId": "",
  339 + "adminPid": "",
  340 + "identity": "",
  341 + "createTime": "",
  342 + "updateTime": ""
  343 + },{
  344 + "id": "",
  345 + "shopsId": "",
  346 + "adminPid": "",
  347 + "identity": "",
  348 + "createTime": "",
  349 + "updateTime": ""
  350 + }],
  351 + "shopRelation": [{
  352 + "id": "",
  353 + "shopsId": "",
  354 + "brandId": "",
  355 + "supplierId": "",
  356 + "createTime": "",
  357 + "updateTime": "",
  358 + "agreementEndTime": ""
  359 + },{
  360 + "id": "",
  361 + "shopsId": "",
  362 + "brandId": "",
  363 + "supplierId": "",
  364 + "createTime": "",
  365 + "updateTime": "",
  366 + "agreementEndTime": ""
  367 + }]
  368 + }
  369 + }
  370 +}
  371 +```
  372 +
  373 +