platform / yohobuy-doc · Commits

Go to a project

Authored by chenchao
Commit 7a63723cbd1e5ff8370053787b8d968c22da61a9 1 parent ef7d4581

complete content

Inline Side-by-side
Showing 1 changed file with 172 additions and 277 deletions
# 产品管理接口服务定义
---------------------
# 添加（更新）品类接口
> 接口名： `/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|目录ID|是|
|saleType|number|1|销售类型|是|
|inputType|string|checkbox|输入类型|是|
|attributeType|number|2|属性类型|否|
|isMust|String|N|是否必选|否|
|isSearch|String|Y|是否启动搜索|否|
|maxValueLen|number|50|最大输入值|否|
|isAllowAlias|String|N|是否允许别名|否|
|orderBy|number|0|排序|否|
|state|number|1|状态|否|
|remark|string|abc|备注|否|
|attributeValues|string|反光,毛呢,网布,皮革,麻,帆布|属性值|是|
|displayPosition|int|1|展示位置|是
---------------------
### 返回
``` json
{
"code": 200,
"data": [],
"md5": "d751713988987e9331980363e24189ce",
"message": "Product Attribute Add success."
}
```
# 更新产品属性接口
> 接口名： `/product/updateProductAttribute`
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|attributId|int|15|属性ID|是|
|attributeName|string|衣长|属性名称|是|
|categoryId|number|6|目录ID|是|
|saleType|number|1|销售类型|是|
|inputType|string|checkbox|输入类型|是|
|attributeType|number|2|属性类型|否|
|isMust|String|N|是否必选|否|
|isSearch|String|Y|是否启动搜索|否|
|maxValueLen|number|50|最大输入值|否|
|isAllowAlias|String|N|是否允许别名|否|
|orderBy|number|0|排序|否|
|state|number|1|状态|否|
|remark|string|abc|备注|否|
|attributeValues|string|反光,毛呢,网布,皮革,麻,帆布|属性值|是|
|displayPosition|int|1|展示位置|是
---------------------
### 返回
``` json
{
"code": 200,
"data": [],
"md5": "d751713988987e9331980363e24189ce",
"message": "Product Attribute update success."
}
```
# 获取产品属性列表接口
> 接口名： `/product/queryProductAttributeList`
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|categoryId|int|1|目录ID|是
---------------------
### 返回
``` json
{
"code": 200,
"data": [
{
"attributeId": 15,
"attributeName": "防风外套属性",
"attributeType": 2,
"attributeValues": "11",
"belong": 1,
"categoryId": 454,
"createTime": 1453951139,
"displayPosition": 1,
"inputType": "checkbox",
"isAllowAlias": "Y",
"isColor": "N",
"isMust": "Y",
"isSearch": "Y",
"maxValueLen": 50,
"orderBy": 0,
"remark": "备注",
"saleType": 0,
"state": 0
},
{
"attributeId": 16,
"attributeName": "纹理",
"attributeType": 2,
"attributeValues": "条纹,豹纹",
"belong": 1,
"categoryId": 454,
"createTime": 1453966719,
"displayPosition": 2,
"inputType": "checkbox",
"isAllowAlias": "N",
"isColor": "N",
"isMust": "N",
"isSearch": "N",
"maxValueLen": 50,
"orderBy": 0,
"remark": "备注",
"saleType": 0,
"state": 1
}
],
"md5": "b4a7dec9fb1b236e4aec02ba40411e42",
"message": "Product Attribute List."
}
```
# 获取产品单个属性列表接口
> 接口名： `/product/getProductAttribute`
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|attributeId|int|1|属性ID|是
---------------------
### 返回
``` json
{
"code": 200,
"data": {
"attributeId": 22,
"attributeName": "材质",
"attributeType": 2,
"attributeValues": "反光,毛呢,网布,皮革,麻,帆布",
"belong": 1,
"categoryId": 6,
"createTime": 1453970276,
"displayPosition": 1,
"inputType": "checkbox",
"isAllowAlias": "N",
"isColor": "N",
"isMust": "N",
"isSearch": "N",
"maxValueLen": 50,
"orderBy": 0,
"remark": "备注",
"saleType": 1,
"state": 1
},
"md5": "dfc645ecb0c66c8d4771dd2a749047e8",
"message": "Product Attribute get success."
}
```
# 获取产品列表
> 接口名： `/product/getList`
-------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
| | | | | |
---------------------
### 返回
``` json
{
code:200,
message:"",
data: {
list: [{
//...
}]
page: '', //当前第几页
size: '', //每页多少条
}
}
```
\ No newline at end of file
# 尺码管理接口服务定义
---------------------
# 添加尺码接口
> 接口名： `/product/addSize`
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|sizeName|string|L|名称|是|
---------------------
### 返回
``` json
{
"code":200,
"message":"添加成功！"
}
```
# 获取尺码列表(没有分页)
> 接口名： `/product/queryAllSizeList`
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|
|-------|----|----|----|-------|
--------------------------------
### 返回
``` json
{
"code": 200,
"data": [
{
"id": 1,
"sizeName": "1"
},
{
"id": 2,
"sizeName": "10#"
},
{
"id": 3,
"sizeName": "10.5码"
},
{
"id": 4,
"sizeName": "10000"
}],
"md5": "4ebf5e614102a54b0025164d794f8032",
"message": "Product size List."
}
```
# 获取尺码列表(有分页)
> 接口名： `/product/querySizeList`
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|
|-------|----|----|----|-------|
|curPage|int|1|页码|是|
|pageSize|int|10|条数|是|
--------------------------------
### 返回
``` json
{
"code": 200,
"data": {
"content": [
{
"id": 1,
"sizeName": "1"
},
{
"id": 2,
"sizeName": "10#"
},
{
"id": 3,
"sizeName": "10.5码"
},
{
"id": 4,
"sizeName": "10000"
},
{
"id": 5,
"sizeName": "105"
}
],
"number": 0,-第几页
"size": 0,-单页记录数
"totalElements": 437,--总数
"totalPages": 1--总页数
},
"md5": "81531967e3291781f608555ca63ccd28",
"message": "Product size List."
}
```
# 更新尺码接口
> 接口名： `/product/updateSize`
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|id|int|15|ID|是|
|sizeName|string|L|名称|是|
---------------------
### 返回
``` json
{
"code": 200,
"data": [],
"md5": "d751713988987e9331980363e24189ce",
"message": "size update success."
}
```
# 获取单个尺码接口
> 接口名： `/product/getSize`
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|id |int |15 |ID |是|
---------------------
### 返回
``` json
{
"code": 200,
"data": {
"id": 9,
"sizeName": "10.5码"
},
"md5": "dfc645ecb0c66c8d4771dd2a749047e8",
"message": "Product size get success."
}
```
... ...