Authored by chenchao

complete content

1 -# 尺码属性管理接口服务定义  
2 ----------------------  
3 -  
4 -# 添加尺码接口  
5 -  
6 -> 接口名: `/product/addSizeAttribute`  
7 -  
8 -### 入参  
9 -  
10 --------------------------  
11 -|属性名称|类型|例子|说明|是否必填|  
12 -|--------|----|----|----|--------|  
13 -|attributeName|string|后中长|名称|是|  
14 -  
15 ----------------------  
16 -  
17 -### 返回  
18 -  
19 -``` json  
20 -{  
21 - "code":200,  
22 - "message":"添加成功!"  
23 -}  
24 -  
25 -```  
26 -  
27 -  
28 -# 获取尺码属性列表(有分页)  
29 -  
30 -> 接口名: `/product/querySizeAttributeList`  
31 -  
32 -### 入参  
33 -  
34 --------------------------  
35 -|属性名称|类型|例子|说明|是否必填|  
36 -|-------|----|----|----|-------|  
37 -|curPage|int|1|页码|是|  
38 -|pageSize|int|10|条数|是|  
39 ---------------------------------  
40 -  
41 -### 返回  
42 -  
43 -``` json  
44 -{  
45 - "code": 200,  
46 - "data": {  
47 - "list": [  
48 - {  
49 - "attributeName": "衣长",  
50 - "id": 60,  
51 - "orderBy": 0  
52 - },  
53 - {  
54 - "attributeName": "胸底围",  
55 - "id": 61,  
56 - "orderBy": 0  
57 - },  
58 - {  
59 - "attributeName": "防水台",  
60 - "id": 62,  
61 - "orderBy": 1  
62 - },  
63 - {  
64 - "attributeName": "品牌尺寸",  
65 - "id": 63,  
66 - "orderBy": 1  
67 - },  
68 - {  
69 - "attributeName": "半径",  
70 - "id": 64,  
71 - "orderBy": 1  
72 - }  
73 - ],  
74 - "page": 0,-第几页  
75 - "size": 0,-单页记录数  
76 - "total": 437,--总数  
77 - "totalPage": 1--总页数  
78 - },  
79 - "md5": "81531967e3291781f608555ca63ccd28",  
80 - "message": "Product size List."  
81 -}  
82 -  
83 -```  
84 -  
85 -  
86 -# 更新尺码属性接口  
87 -  
88 -> 接口名: `/product/updateSizeAttribute`  
89 -  
90 -### 入参  
91 -  
92 --------------------------  
93 -|属性名称|类型|例子|说明|是否必填|  
94 -|--------|----|----|----|--------|  
95 -|id|int|15|ID|是|  
96 -|attributeName|string|后中长|名称|是|  
97 ----------------------  
98 -  
99 -### 返回  
100 -  
101 -``` json  
102 -{  
103 - "code": 200,  
104 - "data": [],  
105 - "md5": "d751713988987e9331980363e24189ce",  
106 - "message": "size update success."  
107 -}  
108 -  
109 -```  
110 -  
111 -  
112 -  
113 -# 获取单个尺码属性接口  
114 -  
115 -> 接口名: `/product/getSizeAttribute`  
116 -  
117 -### 入参  
118 -  
119 --------------------------  
120 -|属性名称|类型|例子|说明|是否必填|  
121 -|--------|----|----|----|--------|  
122 -|id |int |15 |ID |是|  
123 ----------------------  
124 -  
125 -### 返回  
126 -  
127 -``` json  
128 -{  
129 - "code": 200,  
130 - "data":{  
131 - "attributeName": "半径",  
132 - "id": 64,  
133 - "orderBy": 1  
134 - },  
135 - "md5": "dfc645ecb0c66c8d4771dd2a749047e8",  
136 - "message": "Product size get success."  
137 -}  
138 -  
139 -```  
140 -  
141 -# 根据名称模糊查询获取一组尺码属性接口  
142 -  
143 -> 接口名: `/product/querySizeAttributesByName`  
144 -  
145 -### 入参  
146 -  
147 --------------------------  
148 -|属性名称|类型|例子|说明|是否必填|  
149 -|--------|----|----|----|--------|  
150 -|idName |String |长 |属性名称中包含的字词 |是|  
151 ----------------------  
152 -  
153 -### 返回  
154 -  
155 -``` json  
156 -{  
157 - "code": 200,  
158 - "data": [  
159 - {  
160 - "text": "衣长",  
161 - "id": 60  
162 -  
163 - }  
164 - ],  
165 - "md5": "dfc645ecb0c66c8d4771dd2a749047e8",  
166 - "message": "Product size get success."  
167 -}  
168 -  
169 -``` 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 +--------------------------------
  45 +
  46 +### 返回
  47 +
  48 +``` json
  49 +{
  50 + "code": 200,--若失败为500
  51 + "data": {
  52 + "list": [
  53 + {
  54 + "brandId": 5,
  55 + "id": 48,
  56 + "seriesName": "test-cc-u",
  57 + "shopsId": 5,
  58 + "status": 1,
  59 + "type": 5
  60 + }
  61 + ],
  62 + "page": 0,-第几页
  63 + "size": 0,-单页记录数
  64 + "total": 437,--总数
  65 + "totalPage": 1--总页数
  66 + },
  67 + "md5": "81531967e3291781f608555ca63ccd28",
  68 + "message": "success"
  69 +}
  70 +
  71 +```
  72 +
  73 +
  74 +# 更新品牌款型系列接口
  75 +
  76 +> 接口名: `/brandSeries/update`
  77 +
  78 +### 入参
  79 +
  80 +-------------------------
  81 +|属性名称|类型|例子|说明|是否必填|
  82 +|--------|----|----|----|--------|
  83 +|id|int|15|ID|是|
  84 +|seriesName | string | 羽绒服系列 |名称|否|
  85 +|shopsId | int | 1 | 店铺id | 否|
  86 +|brandId | int | 1 | 店铺id下的某个品牌id | 否|
  87 +|type | int | 1 | 1:"品牌款型";2:"品牌系列" | 否|
  88 +|orderBy | int | 1 | 排序值 | 否|
  89 +---------------------
  90 +
  91 +### 返回
  92 +
  93 +``` json
  94 +{
  95 + "code": 200,--若失败为500
  96 + "data": [],
  97 + "md5": "d751713988987e9331980363e24189ce",
  98 + "message": "success"
  99 +}
  100 +
  101 +```
  102 +
  103 +
  104 +
  105 +# 获取单个品牌款型系列接口
  106 +
  107 +> 接口名: `/brandSeries/queryById/{id}`
  108 +
  109 +{id} 具体的品牌款型系列id值,数据类型:int
  110 +例:/brandSeries/queryById/14
  111 +
  112 +http method : get & post all ok;
  113 +
  114 +### 入参
  115 +
  116 +-------------------------
  117 +|属性名称|类型|例子|说明|是否必填|
  118 +|--------|----|----|----|--------|
  119 +
  120 +---------------------
  121 +
  122 +### 返回
  123 +
  124 +``` json
  125 +{
  126 + "code": 200,--若失败为500
  127 + "data":{
  128 + "brandId": 286,
  129 + "id": 13,
  130 + "orderBy": 4,
  131 + "parentId": 0,
  132 + "seriesName": "Mikio Sakabe",
  133 + "shopsId": 1,
  134 + "status": 1
  135 + },
  136 + "md5": "dfc645ecb0c66c8d4771dd2a749047e8",
  137 + "message": "success"
  138 +}
  139 +
  140 +```
  141 +
  142 +# 打开品牌款型系列接口
  143 +
  144 +> 接口名: `/brandSeries/open/{id}`
  145 +
  146 +{id} 具体的品牌款型系列id值,数据类型:int
  147 +例:/brandSeries/open/14
  148 +
  149 +### 入参
  150 +
  151 +-------------------------
  152 +|属性名称|类型|例子|说明|是否必填|
  153 +|--------|----|----|----|--------|
  154 +
  155 +---------------------
  156 +
  157 +### 返回
  158 +
  159 +``` json
  160 +{
  161 + "code": 200,--若失败为500
  162 + "data": [],
  163 + "md5": "dfc645ecb0c66c8d4771dd2a749047e8",
  164 + "message": "success"
  165 +}
  166 +
  167 +```
  168 +
  169 +# 关闭品牌款型系列接口(restfull 风格)
  170 +
  171 +> 接口名: `/brandSeries/close/{id}`
  172 +
  173 +{id} 具体的品牌款型系列id值,数据类型:int
  174 +例:/brandSeries/close/14
  175 +
  176 +### 入参
  177 +
  178 +-------------------------
  179 +|属性名称|类型|例子|说明|是否必填|
  180 +|--------|----|----|----|--------|
  181 +
  182 +---------------------
  183 +
  184 +### 返回
  185 +
  186 +``` json
  187 +{
  188 + "code": 200,--若失败为500
  189 + "data": [ ],
  190 + "md5": "dfc645ecb0c66c8d4771dd2a749047e8",
  191 + "message": "success"
  192 +}
  193 +
  194 +```