Showing
1 changed file
with
165 additions
and
157 deletions
1 | -# 产品管理接口服务定义 | ||
2 | ---------------------- | ||
3 | - | ||
4 | -# 添加(更新)品类接口 | ||
5 | - | ||
6 | -> 接口名: `/product/update` | ||
7 | - | ||
8 | -### 入参 | ||
9 | - | ||
10 | -------------------------- | ||
11 | -|属性名称|类型|例子|说明|是否必填| | ||
12 | -|--------|----|----|----|--------| | ||
13 | -|categoryName|string|nike|品类名称|是| | ||
14 | -|categoryAbbr|string|n|品类缩写|是| | ||
15 | -|firstCategory|string|根目录|一级分类|否| | ||
16 | -|secondCategory|string|根目录|二级分类|否| | ||
17 | -|thirdCategory|string|根目录|三级分类|否| | ||
18 | -|categorySort|number|0|排序|否| | ||
19 | -|categoryStatus|boolean|true|状态|否| | ||
20 | -|id|int|1|品类ID| | ||
21 | ---------------------- | ||
22 | - | ||
23 | -### 返回 | ||
24 | - | ||
25 | -``` json | ||
26 | -{ | ||
27 | - "code":200, | ||
28 | - "message":"添加成功!" | ||
29 | -} | ||
30 | - | ||
31 | -``` | ||
32 | - | ||
33 | -# 获取品类列表 | ||
34 | - | ||
35 | -> 接口名: `/product/getClassList` | ||
36 | - | ||
37 | -### 入参 | ||
38 | - | ||
39 | -------------------------- | ||
40 | -|属性名称|类型|例子|说明|是否必填| | ||
41 | -|-------|----|----|----|-------| | ||
42 | --------------------------------- | ||
43 | - | ||
44 | -### 返回 | ||
45 | - | ||
46 | -``` json | ||
47 | -{ | ||
48 | - code:200, | ||
49 | - message:"", | ||
50 | - data: { | ||
51 | - list: [{ | ||
52 | - categoryName: '', //品类名称 | ||
53 | - categoryAbbr: '', //品类缩写 | ||
54 | - firstCategory: '', //一级分类 | ||
55 | - secondCategory: '', //二级分类 | ||
56 | - thirdCategory: '', //三级分类 | ||
57 | - categorySort: '', //排序 | ||
58 | - categoryStatus: '',//状态, | ||
59 | - id: '', //品类ID | ||
60 | - }] | ||
61 | - page: '', //当前第几页 | ||
62 | - size: '', //每页多少条 | ||
63 | - } | ||
64 | -} | ||
65 | - | ||
66 | -``` | ||
67 | - | ||
68 | - | ||
69 | -# 添加(更新)产品属性接口 | ||
70 | - | ||
71 | -> 接口名: `/product/updateAttr` | ||
72 | - | ||
73 | -### 入参 | ||
74 | - | ||
75 | -------------------------- | ||
76 | -|属性名称|类型|例子|说明|是否必填| | ||
77 | -|--------|----|----|----|--------| | ||
78 | -|attrName|string|衣长|属性名称|未知| | ||
79 | -|saleType|string|非销售属性|销售类型|未知| | ||
80 | -|inputType|string|单选按钮|输入类型|未知| | ||
81 | -|enableSearch|boolean|true|启用搜索|未知| | ||
82 | -|maxVal|number|50|最大输入值|未知| | ||
83 | -|hasAlias|boolean|true|是否允许别名|未知| | ||
84 | -|attrSort|number|0|排序|未知| | ||
85 | -|attrAttr|string|abc|属性值|未知| | ||
86 | -|attrComment|string|abc|备注|否| | ||
87 | -|id|int|1|商品属性ID| | ||
88 | ---------------------- | ||
89 | - | ||
90 | -### 返回 | ||
91 | - | ||
92 | -``` json | ||
93 | -{ | ||
94 | - "code":200, | ||
95 | - "message":"添加成功!" | ||
96 | -} | ||
97 | - | ||
98 | -``` | ||
99 | - | ||
100 | -# 获取产品属性列表接口 | ||
101 | - | ||
102 | -> 接口名: `/product/getAttr` | ||
103 | - | ||
104 | -### 入参 | ||
105 | - | ||
106 | -------------------------- | ||
107 | -|属性名称|类型|例子|说明|是否必填| | ||
108 | -|--------|----|----|----|--------| | ||
109 | -|id|int|1|商品属性ID| | ||
110 | ---------------------- | ||
111 | - | ||
112 | -### 返回 | ||
113 | - | ||
114 | -``` json | ||
115 | -{ | ||
116 | - code:200, | ||
117 | - message:"", | ||
118 | - data: { | ||
119 | - list: [{ | ||
120 | - attrName: '', //属性名称 | ||
121 | - saleType: '', //销售类型 | ||
122 | - inputType: '', //输入类型 | ||
123 | - enableSearch: '', //启用搜索 | ||
124 | - id: '', //品类ID | ||
125 | - }] | ||
126 | - page: '', //当前第几页 | ||
127 | - size: '', //每页多少条 | ||
128 | - } | ||
129 | -} | ||
130 | - | ||
131 | -``` | ||
132 | - | ||
133 | -# 获取产品列表 | ||
134 | - | ||
135 | -> 接口名: `/product/getList` | ||
136 | - | ||
137 | -------------------------- | ||
138 | -|属性名称|类型|例子|说明|是否必填| | ||
139 | -|--------|----|----|----|--------| | ||
140 | -| | | | | | | ||
141 | ---------------------- | ||
142 | - | ||
143 | -### 返回 | ||
144 | - | ||
145 | -``` json | ||
146 | -{ | ||
147 | - code:200, | ||
148 | - message:"", | ||
149 | - data: { | ||
150 | - list: [{ | ||
151 | - //... | ||
152 | - }] | ||
153 | - page: '', //当前第几页 | ||
154 | - size: '', //每页多少条 | ||
155 | - } | ||
156 | -} | ||
157 | - | 1 | +# 产品管理接口服务定义 |
2 | +--------------------- | ||
3 | + | ||
4 | +# 添加(更新)品类接口 | ||
5 | + | ||
6 | +> 接口名: `/product/update` | ||
7 | + | ||
8 | +### 入参 | ||
9 | + | ||
10 | +------------------------- | ||
11 | +|属性名称|类型|例子|说明|是否必填| | ||
12 | +|--------|----|----|----|--------| | ||
13 | +|categoryName|string|nike|品类名称|是| | ||
14 | +|categoryAbbr|string|n|品类缩写|是| | ||
15 | +|firstCategory|string|根目录|一级分类|否| | ||
16 | +|secondCategory|string|根目录|二级分类|否| | ||
17 | +|thirdCategory|string|根目录|三级分类|否| | ||
18 | +|categorySort|number|0|排序|否| | ||
19 | +|categoryStatus|boolean|true|状态|否| | ||
20 | +|id|int|1|品类ID| | ||
21 | +--------------------- | ||
22 | + | ||
23 | +### 返回 | ||
24 | + | ||
25 | +``` json | ||
26 | +{ | ||
27 | + "code":200, | ||
28 | + "message":"添加成功!" | ||
29 | +} | ||
30 | + | ||
31 | +``` | ||
32 | + | ||
33 | +# 获取品类列表 | ||
34 | + | ||
35 | +> 接口名: `/product/getClassList` | ||
36 | + | ||
37 | +### 入参 | ||
38 | + | ||
39 | +------------------------- | ||
40 | +|属性名称|类型|例子|说明|是否必填| | ||
41 | +|-------|----|----|----|-------| | ||
42 | +-------------------------------- | ||
43 | + | ||
44 | +### 返回 | ||
45 | + | ||
46 | +``` json | ||
47 | +{ | ||
48 | + code:200, | ||
49 | + message:"", | ||
50 | + data: { | ||
51 | + list: [{ | ||
52 | + categoryName: '', //品类名称 | ||
53 | + categoryAbbr: '', //品类缩写 | ||
54 | + firstCategory: '', //一级分类 | ||
55 | + secondCategory: '', //二级分类 | ||
56 | + thirdCategory: '', //三级分类 | ||
57 | + categorySort: '', //排序 | ||
58 | + categoryStatus: '',//状态, | ||
59 | + id: '', //品类ID | ||
60 | + }] | ||
61 | + page: '', //当前第几页 | ||
62 | + size: '', //每页多少条 | ||
63 | + } | ||
64 | +} | ||
65 | + | ||
66 | +``` | ||
67 | + | ||
68 | + | ||
69 | +# 添加产品属性接口 | ||
70 | + | ||
71 | +> 接口名: `/product/addProductAttribute` | ||
72 | + | ||
73 | +### 入参 | ||
74 | + | ||
75 | +------------------------- | ||
76 | +|属性名称|类型|例子|说明|是否必填| | ||
77 | +|--------|----|----|----|--------| | ||
78 | +|attributeName|string|衣长|属性名称|未知| | ||
79 | +|categoryId|number|6|属性名称|未知| | ||
80 | +|saleType|number|1|销售类型|未知| | ||
81 | +|inputType|string|checkbox|输入类型|未知| | ||
82 | +|attributeType|number|2|属性类型|未知| | ||
83 | +|isMust|String|N|不是必选|未知| | ||
84 | +|isSearch|String|Y|启动搜索|未知| | ||
85 | +|maxValueLen|number|50|最大输入值|未知| | ||
86 | +|isColor|String|N|没有颜色|未知| | ||
87 | +|isAllowAlias|String|N|是否允许别名|未知| | ||
88 | +|orderBy|number|0|排序|未知| | ||
89 | +|state|number|1|状态|未知| | ||
90 | +|remark|string|abc|备注|否| | ||
91 | +|attributeValues|string|反光,毛呢,网布,皮革,麻,帆布|属性值|未知| | ||
92 | +|belong|number|1|未知|未知| | ||
93 | +|displayPosition|int|1|展示位置| | ||
94 | +--------------------- | ||
95 | + | ||
96 | +### 返回 | ||
97 | + | ||
98 | +``` json | ||
99 | +{ | ||
100 | + "code": 200, | ||
101 | + "data": [], | ||
102 | + "md5": "d751713988987e9331980363e24189ce", | ||
103 | + "message": "Product Attribute Add success." | ||
104 | +} | ||
105 | + | ||
106 | +``` | ||
107 | + | ||
108 | +# 获取产品属性列表接口 | ||
109 | + | ||
110 | +> 接口名: `/product/getAttr` | ||
111 | + | ||
112 | +### 入参 | ||
113 | + | ||
114 | +------------------------- | ||
115 | +|属性名称|类型|例子|说明|是否必填| | ||
116 | +|--------|----|----|----|--------| | ||
117 | +|id|int|1|商品属性ID| | ||
118 | +--------------------- | ||
119 | + | ||
120 | +### 返回 | ||
121 | + | ||
122 | +``` json | ||
123 | +{ | ||
124 | + code:200, | ||
125 | + message:"", | ||
126 | + data: { | ||
127 | + list: [{ | ||
128 | + attrName: '', //属性名称 | ||
129 | + saleType: '', //销售类型 | ||
130 | + inputType: '', //输入类型 | ||
131 | + enableSearch: '', //启用搜索 | ||
132 | + id: '', //品类ID | ||
133 | + }] | ||
134 | + page: '', //当前第几页 | ||
135 | + size: '', //每页多少条 | ||
136 | + } | ||
137 | +} | ||
138 | + | ||
139 | +``` | ||
140 | + | ||
141 | +# 获取产品列表 | ||
142 | + | ||
143 | +> 接口名: `/product/getList` | ||
144 | + | ||
145 | +------------------------- | ||
146 | +|属性名称|类型|例子|说明|是否必填| | ||
147 | +|--------|----|----|----|--------| | ||
148 | +| | | | | | | ||
149 | +--------------------- | ||
150 | + | ||
151 | +### 返回 | ||
152 | + | ||
153 | +``` json | ||
154 | +{ | ||
155 | + code:200, | ||
156 | + message:"", | ||
157 | + data: { | ||
158 | + list: [{ | ||
159 | + //... | ||
160 | + }] | ||
161 | + page: '', //当前第几页 | ||
162 | + size: '', //每页多少条 | ||
163 | + } | ||
164 | +} | ||
165 | + | ||
158 | ``` | 166 | ``` |
-
Please register or login to post a comment