Toggle navigation
Toggle navigation
This project
Loading...
Sign in
michaelcao
/
yohobuy-doc
·
Commits
Go to a project
GitLab
Go to dashboard
Project
Activity
Files
Commits
Pipelines
0
Builds
0
Graphs
Milestones
Issues
0
Merge Requests
0
Members
Labels
Wiki
Forks
Network
Create a new issue
Download as
Email Patches
Plain Diff
Browse Files
Authored by
caoyan
9 years ago
Commit
0483b3837380d83c3006325d7ef3b395fc7f83c5
1 parent
57798b25
update
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
165 additions
and
157 deletions
inferface-document/product.md
inferface-document/product.md
View file @
0483b38
# 产品管理接口服务定义
---------------------
# 添加(更新)品类接口
> 接口名: `/product/update`
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|categoryName|string|nike|品类名称|是|
|categoryAbbr|string|n|品类缩写|是|
|firstCategory|string|根目录|一级分类|否|
|secondCategory|string|根目录|二级分类|否|
|thirdCategory|string|根目录|三级分类|否|
|categorySort|number|0|排序|否|
|categoryStatus|boolean|true|状态|否|
|id|int|1|品类ID|
---------------------
### 返回
```
json
{
"code"
:
200
,
"message"
:
"添加成功!"
}
```
# 获取品类列表
> 接口名: `/product/getClassList`
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|
|-------|----|----|----|-------|
--------------------------------
### 返回
```
json
{
code:200,
message:
""
,
data
:
{
list:
[{
categoryName:
'',
//品类名称
categoryAbbr:
'',
//品类缩写
firstCategory:
'',
//一级分类
secondCategory:
'',
//二级分类
thirdCategory:
'',
//三级分类
categorySort:
'',
//排序
categoryStatus:
'',//状态,
id:
'',
//品类ID
}
]
page:
''
,
//当前第几页
size
:
''
,
//每页多少条
}
}
```
# 添加(更新)产品属性接口
> 接口名: `/product/updateAttr`
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|attrName|string|衣长|属性名称|未知|
|saleType|string|非销售属性|销售类型|未知|
|inputType|string|单选按钮|输入类型|未知|
|enableSearch|boolean|true|启用搜索|未知|
|maxVal|number|50|最大输入值|未知|
|hasAlias|boolean|true|是否允许别名|未知|
|attrSort|number|0|排序|未知|
|attrAttr|string|abc|属性值|未知|
|attrComment|string|abc|备注|否|
|id|int|1|商品属性ID|
---------------------
### 返回
```
json
{
"code"
:
200
,
"message"
:
"添加成功!"
}
```
# 获取产品属性列表接口
> 接口名: `/product/getAttr`
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|id|int|1|商品属性ID|
---------------------
### 返回
```
json
{
code:200,
message:
""
,
data
:
{
list:
[{
attrName:
'',
//属性名称
saleType:
'',
//销售类型
inputType:
'',
//输入类型
enableSearch:
'',
//启用搜索
id:
'',
//品类ID
}
]
page:
''
,
//当前第几页
size
:
''
,
//每页多少条
}
}
```
# 获取产品列表
> 接口名: `/product/getList`
-------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
| | | | | |
---------------------
### 返回
```
json
{
code:200,
message:
""
,
data
:
{
list:
[{
//...
}
]
page:
''
,
//当前第几页
size
:
''
,
//每页多少条
}
}
# 产品管理接口服务定义
---------------------
# 添加(更新)品类接口
> 接口名: `/product/update`
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|categoryName|string|nike|品类名称|是|
|categoryAbbr|string|n|品类缩写|是|
|firstCategory|string|根目录|一级分类|否|
|secondCategory|string|根目录|二级分类|否|
|thirdCategory|string|根目录|三级分类|否|
|categorySort|number|0|排序|否|
|categoryStatus|boolean|true|状态|否|
|id|int|1|品类ID|
---------------------
### 返回
```
json
{
"code"
:
200
,
"message"
:
"添加成功!"
}
```
# 获取品类列表
> 接口名: `/product/getClassList`
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|
|-------|----|----|----|-------|
--------------------------------
### 返回
```
json
{
code:200,
message:
""
,
data
:
{
list:
[{
categoryName:
'',
//品类名称
categoryAbbr:
'',
//品类缩写
firstCategory:
'',
//一级分类
secondCategory:
'',
//二级分类
thirdCategory:
'',
//三级分类
categorySort:
'',
//排序
categoryStatus:
'',//状态,
id:
'',
//品类ID
}
]
page:
''
,
//当前第几页
size
:
''
,
//每页多少条
}
}
```
# 添加产品属性接口
> 接口名: `/product/addProductAttribute`
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|attributeName|string|衣长|属性名称|未知|
|categoryId|number|6|属性名称|未知|
|saleType|number|1|销售类型|未知|
|inputType|string|checkbox|输入类型|未知|
|attributeType|number|2|属性类型|未知|
|isMust|String|N|不是必选|未知|
|isSearch|String|Y|启动搜索|未知|
|maxValueLen|number|50|最大输入值|未知|
|isColor|String|N|没有颜色|未知|
|isAllowAlias|String|N|是否允许别名|未知|
|orderBy|number|0|排序|未知|
|state|number|1|状态|未知|
|remark|string|abc|备注|否|
|attributeValues|string|反光,毛呢,网布,皮革,麻,帆布|属性值|未知|
|belong|number|1|未知|未知|
|displayPosition|int|1|展示位置|
---------------------
### 返回
```
json
{
"code"
:
200
,
"data"
:
[],
"md5"
:
"d751713988987e9331980363e24189ce"
,
"message"
:
"Product Attribute Add success."
}
```
# 获取产品属性列表接口
> 接口名: `/product/getAttr`
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|id|int|1|商品属性ID|
---------------------
### 返回
```
json
{
code:200,
message:
""
,
data
:
{
list:
[{
attrName:
'',
//属性名称
saleType:
'',
//销售类型
inputType:
'',
//输入类型
enableSearch:
'',
//启用搜索
id:
'',
//品类ID
}
]
page:
''
,
//当前第几页
size
:
''
,
//每页多少条
}
}
```
# 获取产品列表
> 接口名: `/product/getList`
-------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
| | | | | |
---------------------
### 返回
```
json
{
code:200,
message:
""
,
data
:
{
list:
[{
//...
}
]
page:
''
,
//当前第几页
size
:
''
,
//每页多少条
}
}
```
\ No newline at end of file
...
...
Please
register
or
login
to post a comment