Authored by chenchao

Merge branch 'master' of http://git.yoho.cn/platform/yohobuy-doc

Too many changes to show.

To preserve performance only 22 of 22+ files are displayed.

# 添加尺码接口
> 接口名: `/product/addSize`
### 方法
> POST JSONRAW
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|长度限制|
|--------|----|----|---|----|--------|
|sizeName|string|L|名称|是|10
### 对应SQL的操作库表
```xml
<insert id="insert" parameterType="com.yohobuy.platform.dal.product.model.Size" >
insert into size (id, size_name, sort_id,
attribute_id, order_by, create_time,
update_time)
values (#{id,jdbcType=SMALLINT}, #{sizeName,jdbcType=VARCHAR}, #{sortId,jdbcType=SMALLINT},
#{attributeId,jdbcType=VARCHAR}, #{orderBy,jdbcType=INTEGER}, #{createTime,jdbcType=INTEGER},
#{updateTime,jdbcType=INTEGER})
</insert>
```
### 错误编码
-------------------------
|错误码code|消息|说明|
|--------|----|----|
|200| 添加成功!| |
|400| 操作失败!| |
### 返回
``` json
{
"code":200,
"message":"添加成功!"
}
```
\ No newline at end of file
... ...
平台服务接口公共参数
======
###### 平台页面端在向平台服务发起请求时应该携带以下参数,
###### 便于后台问题定位和操作回溯
---
页面传入参数(参数通过扩展HTTP头方式提供)
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|x-user-id|string|0|用户ID|
|x-user-name|string|admin|用户名|
|x-site-type|string|1|站点类型:1-运营平台 2-商家平台|
|x-client-ip|string|192.168.0.1|客户端IP|
---
服务调用传入参数示例:
```
POST /xx/xx HTTP/1.1\r\n
... http standard headers...
x-user-id:0\r\n
x-user-name:admin\r\n
x-size-type:1\r\n
x-client-ip:192.168.0.1\r\n
\r\n
...json body..
```
... ...
批量导入导出操作接口
======
### 批量导入
> 接口名: `/batch/import`
#### 入参
-------------------------
|属性名称|类型|例子|说明|
|----|----|----|----|
|file|multpart|无|批量导入的文件,必填字段|
|type|string|product_price|批量导入业务类型,必填字段|
#### 返回
``` json
{
"code":200,
"message":"导入成功",
"data":{
...由业务详细给出..
}
}
```
### 批量导入
> 接口名: '/batch/download'
#### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|path|string|123231123.xlsx|文件路径,必填字段|
---------------------
#### 返回
```
文件流
```
... ...
... ... @@ -58,7 +58,6 @@
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|status|String|add|状态|
|brandName|string|nike|品牌名称|
|brandNameEn|string|aaaa|英文名称|
|brandDomain|string|yoho|二级域名|
... ... @@ -68,6 +67,7 @@
|mainCategory|int|2|主营类目|
|brandHeadstream|int|2|发源地|
|brandTypes|int|2|品牌类型|
|saleType|int|2|合作模式|
|brandUrl|string|www.baidu.com|品牌网址|
|brandIntro|string|xxxxxx|品牌介绍|
|brandOutline|string|xxxxxx|品牌简述|
... ... @@ -98,7 +98,7 @@
|属性名称|类型|例子|说明|
|--------|----|----|----|
|brandId|Number|43|品牌id|
|status|String|edit|状态,关闭传0,开启传1|
|status|String|0|关闭传0,开启传1|
|brandName|string|nike|品牌名称|
|brandNameEn|string|aaaa|英文名称|
|brandDomain|string|yoho|二级域名|
... ... @@ -108,6 +108,7 @@
|mainCategory|int|2|主营类目|
|brandHeadstream|int|2|发源地|
|brandTypes|int|2|品牌类型|
|saleType|int|2|合作模式|
|brandUrl|string|www.baidu.com|品牌网址|
|brandIntro|string|xxxxxx|品牌介绍|
|brandOutline|string|xxxxxx|品牌简述|
... ... @@ -155,6 +156,7 @@
"mainCategory": "",
"brandHeadstream": "",
"brandTypes": "",
"saleType": "",
"brandUrl": "",
"brandIntro": "",
"brandOutline": "",
... ... @@ -218,7 +220,7 @@
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|idOrName|Number|43|品牌id或者名称|
|idName|Number|43|品牌id或者名称|
---------------------
### 返回
... ... @@ -227,14 +229,12 @@
{
"code":200,
"message":"请求成功",
"data": {
"list": [
{
"id": "",
“name”:""
}
]
}
"data": [
{
"id": "",
"name":""
}
]
}
... ...
# 品牌合作模式管理
---------------------
## 新增修改品牌合作模式管理
> 接口名:`/brandCooperation/saveBrandCooperation`
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|id|int|12|品牌合作模式主键id:修改时非空 |
|cooperateTypeId|int|2| 合作模式id 0未设置 1 代销 2 经销 3 自主|
|brandId|int|13|品牌id,新增时需要|
|addUid|int|22|添加人id|
|addUserName|string|李建|添加人名称|
|updateUid|int|2323|修改人id|
|updateUserName|String|李建|修改人名称|
---------------------
### 返回
``` json
新增请求样例:
{
"brandId": 19,
"cooperateTypeId":1,
"addUid":234,
"addUserName":"李建"
}
修改请求样例:
{
"id": 19,
"cooperateTypeId":2,
"updateUid":234,
"updateUserName":"李建"
}
正常返回:
{
"code": 200,
"data": [],
"md5": "d751713988987e9331980363e24189ce",
"message": "保存品牌合作模式信息成功"
}
异常返回:
{
"code": 403,
"data": [],
"md5": "d751713988987e9331980363e24189ce",
"message": "请求参数异常"
}
```
## 查询品牌合作模式管理
> 接口名:`/brandCooperation/queryBrandCooperationList`
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|page|int|2|第几页|
|size|int|50|每页条数|
|cooperateTypeId|int|2| 合作模式id 0未设置 1 代销 2 经销 3 自主|
|brandName|string|nike|品牌名称 模糊查询|
|setFlag|int|0|是否设置 0未设置 1已设置|
---------------------
### 返回
``` json
请求样例:
{
"page": 1,
"size": 10,
"setFlag":1
}
修改请求样例:
正常返回:
{
"code": 200,
"data": {
"list": [
{
"addUid": 234,
"addUserName": "李建",
"brandId": 15,
"brandName": "BORDERLINE",
"cooperateTypeId": 2,
"cooperateTypeName": "经销",
"createTime": 1455763569,
"delFlag": 0,
"id": 17,
"updateTime": 1455763569
},
{
"addUid": 234,
"addUserName": "李建",
"brandId": 15,
"brandName": "BORDERLINE",
"cooperateTypeId": 2,
"cooperateTypeName": "经销",
"createTime": 1455763608,
"delFlag": 0,
"id": 18,
"updateTime": 1455763608
},
{
"addUid": 234,
"addUserName": "李建",
"brandId": 15,
"brandName": "BORDERLINE",
"cooperateTypeId": 2,
"cooperateTypeName": "经销",
"createTime": 1455764083,
"delFlag": 0,
"id": 19,
"updateTime": 1455764083
},
{
"addUid": 234,
"addUserName": "李建",
"brandId": 15,
"brandName": "BORDERLINE",
"cooperateTypeId": 2,
"cooperateTypeName": "经销",
"createTime": 1455764084,
"delFlag": 0,
"id": 20,
"updateTime": 1455764084
}
],
"page": 1,
"size": 10,
"total": 11,
"totalPage": 2
},
"md5": "007961848bbafa4389f0b72e74efe362",
"message": "品牌合作模式信息列表"
}
异常返回:
{
"code": 405,
"data": [],
"md5": "d751713988987e9331980363e24189ce",
"message": "查询品牌合作模式信息失败"
}
```
## 批量导入品牌合作模式管理
> 接口名:`/batch/import`
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|file|文件|文件|xls文件 |
|type|int|2| 上传业务类型 必传:brandCooperation|
---------------------
### 返回
``` json
请求样例:
{
"type": brandCooperation
}
正常返回:
{
"code": 200,
"data": {
"failFileReason": [
"第3行:[23.0]:品牌名称不存在"
]
},
"message": "导入成功"
}
异常返回:
{
"code": 500,
"message": "第2行数据个数不匹配"
}
```
\ No newline at end of file
... ...
# 品牌款型系列管理接口服务定义
---------------------
# 添加品牌款型系列接口
> 接口名: `/brandSeries/add`
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|seriesName | string | 羽绒服系列 |名称|是|
|shopsId | int | 1 | 店铺id | 是|
|brandId | int | 1 | 店铺id下的某个品牌id | 是|
|type | int | 1 | 1:"品牌款型";2:"品牌系列" | 是|
|orderBy | int | 1 | 排序值 | 否|
---------------------
### 返回
``` json
{
"code":200,--若失败为500
"message":"success"
}
```
# 获取品牌款型系列列表(有分页)
> 接口名: `/brandSeries/queryAll`
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|
|-------|----|----|----|-------|
|seriesName | string | 羽绒服系列 |名称|是|
|shopsId | int | 1 | 店铺id | 是|
|brandId | int | 1 | 店铺id下的某个品牌id | 是|
|type | int | 1 | 1:"品牌款型";2:"品牌系列" | 是|
|page | int | 1 | 页码数,默认1 | 否|
|size | int | 10 | 记录数,默认10条 | 否|
--------------------------------
### 返回
``` json
{
"code": 200,--若失败为500
"data": {
"list": [
{
"brandId": 5,
"id": 48,
"seriesName": "test-cc-u",
"shopsId": 5,
"status": 1,
"type": 5
}
],
"page": 0,-第几页
"size": 0,-单页记录数
"total": 437,--总数
"totalPage": 1--总页数
},
"md5": "81531967e3291781f608555ca63ccd28",
"message": "success"
}
```
# 更新品牌款型系列接口
> 接口名: `/brandSeries/update`
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|id|int|15|ID|是|
|seriesName | string | 羽绒服系列 |名称|否|
|shopsId | int | 1 | 店铺id | 否|
|brandId | int | 1 | 店铺id下的某个品牌id | 否|
|type | int | 1 | 1:"品牌款型";2:"品牌系列" | 否|
|orderBy | int | 1 | 排序值 | 否|
---------------------
### 返回
``` json
{
"code": 200,--若失败为500
"data": [],
"md5": "d751713988987e9331980363e24189ce",
"message": "success"
}
```
# 获取单个品牌款型系列接口
> 接口名: `/brandSeries/queryById/{id}`
{id} 具体的品牌款型系列id值,数据类型:int
例:/brandSeries/queryById/14
http method : get & post all ok;
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
---------------------
### 返回
``` json
{
"code": 200,--若失败为500
"data":{
"brandId": 286,
"id": 13,
"orderBy": 4,
"parentId": 0,
"seriesName": "Mikio Sakabe",
"shopsId": 1,
"status": 1
},
"md5": "dfc645ecb0c66c8d4771dd2a749047e8",
"message": "success"
}
```
# 打开品牌款型系列接口
> 接口名: `/brandSeries/open/{id}`
{id} 具体的品牌款型系列id值,数据类型:int
例:/brandSeries/open/14
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
---------------------
### 返回
``` json
{
"code": 200,--若失败为500
"data": [],
"md5": "dfc645ecb0c66c8d4771dd2a749047e8",
"message": "success"
}
```
# 关闭品牌款型系列接口(restfull 风格)
> 接口名: `/brandSeries/close/{id}`
{id} 具体的品牌款型系列id值,数据类型:int
例:/brandSeries/close/14
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
---------------------
### 返回
``` json
{
"code": 200,--若失败为500
"data": [ ],
"md5": "dfc645ecb0c66c8d4771dd2a749047e8",
"message": "success"
}
```
... ...
# 活动模板接口服务定义
----------------------
# 查询模板列表接口
> 接口名:`activityTemplate/selectTemplateList`
### 入参
----------------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|status|integer|1|状态:0 不启用 ,1 启用 |否|
----------------------------------
### 返回
``` json
{
"code":200,
"message":"请求成功",
"data": [
{
"createTime": 1453966206,
"id": 1,
"image": "", // 图片链接
"shareId": 0,
"status": 1, // 0 不启用 ,1 启用
"title": "",
"url": ""
}
]
}
```
# 添加模板接口
> 接口名:`activityTemplate/addTemplate`
### 入参
----------------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|title|string|新人专享活动模板|模板标题|是|
|image|string|http://yoho.cn/18282.jpg|图片地址|否|
|url|string|http://yoho.cn/18282.template|模板地址|否|
|shareId|integer|1|共享ID|否|
----------------------------------
### 返回
``` json
{
"code":200,
"message":"添加成功!"
}
```
# 更新模板接口
> 接口名:`activityTemplate/updateTeplate`
### 入参
----------------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|id|integer|1|主键|是|
|title|string|新人专享活动模板|模板标题|是|
|image|string|http://yoho.cn/18282.jpg|图片地址|否|
|url|string|http://yoho.cn/18282.template|模板地址|否|
|shareId|integer|1|共享ID|否|
----------------------------------
### 返回
``` json
{
"code":200,
"message":"添加成功!"
}
```
# 开启模板接口
> 接口名:`activityTemplate/publishTemplate`
### 入参
----------------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|id|integer|1|主键|是|
----------------------------------
### 返回
``` json
{
"code":200,
"message":"操作成功!"
}
```
# 关闭模板接口
> 接口名:`activityTemplate/closeTemplate`
### 入参
----------------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|id|integer|1|主键|是|
----------------------------------
### 返回
``` json
{
"code":200,
"message":"操作成功!"
}
```
# 根据条件查询活动商品列表接口
> 接口名:`activityTemplate/getProductListByCondition`
### 入参
----------------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|templateId|integer|1|模板ID|是|
|productSkn|integer|1|商品SKN|否|
----------------------------------
### 返回
``` json
{
"code": 200,
"data": {
"list": [
{
"id": 1,
"isRecommend": true,
"orderBy": 110,
"productSkn": 51125277,
"status": 1,
"templateId": 2
}
],
"page": 1,
"size": 10,
"total": 1,
"totalPage": 1
},
"message": "Temp SKN list"
}
```
# 插入活动商品信息接口
> 接口名:`activityTemplate/insertProduct`
### 入参
----------------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|templateId|integer|1|模板ID|是|
|productSkn|integer|1|商品SKN|是|
----------------------------------
### 返回
``` json
{
"code": 200,
"message": "添加成功",
}
```
# 更新商品信息接口
> 接口名:`activityTemplate/updateProduct`
### 入参
----------------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|id|integer|1|商品ID|是|
|orderBy|integer|1|排序号|否|
|isRecommend|integer|1|是否推荐|否|
|status|integer|1|是否启用|否|
----------------------------------
### 返回
``` json
{
"code": 200,
"message": "操作成功",
}
```
# 删除商品信息接口
> 接口名:`activityTemplate/delOneProduct`
### 入参
----------------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|id|integer|1|主键|是|
----------------------------------
### 返回
如果删除失败,可能是没有删除权限。
``` json
{
"code":200,
"message":"操作成功!"
}
```
... ...
# 帮助内容接口服务定义
---------------------
## 添加帮助内容
> 接口名:`/HelpContentRest/addHelpContent`
### 入参
``` json
{
"title":"补开发票",
"categoryId":13,
"content":"如订单未选择发票需要补寄,请您联系有货客服,我们可以为您补开三个自然月内订单的发票,但是需运费到付。",
"platform":"iphone,android"
}
```
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|title|String|补开发票|帮助标题|
|categoryId|int|13|分类ID|
|content|String|如订单未选择发票需要补寄,请您联系有货客服,我们可以为您补开三个自然月内订单的发票,但是需运费到付。|帮助内容|
|platform|String|iphone,android|显示平台|
---------------------
### 返回
``` json
{
"code": 200,
"message": "Add Help Content Success"
}
{
"code":400
"message":"帮助标题不能为空"
}
{
"code":400
"message":"分类ID无效"
}
{
"code":400
"message":"内容无效"
}
{
"code":400
"message":"显示平台无效"
}
{
"code":500
"message":"Add Help Content Fail"
}
```
## 修改帮助内容
> 接口名:`/HelpContentRest/updateHelpContent`
### 入参
``` json
{
"id":44,
"title":"补开发票",
"categoryId":13,
"platform":"iphone,android,h5",
"content":"如订单未选择发票需要补寄,请您联系有货客服,我们可以为您补开三个自然月内订单的发票,但是需运费到付。"
}
```
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|id|int|44|帮助内容记录ID|
|title|String|补开发票|帮助标题|
|categoryId|int|13|分类ID|
|content|String|如订单未选择发票需要补寄,请您联系有货客服,我们可以为您补开三个自然月内订单的发票,但是需运费到付。|帮助内容|
|platform|String|iphone,android|显示平台|
---------------------
### 返回
``` json
{
"code": 200,
"message": "Update Help Content Success"
}
{
"code":400
"message":"Id is null"
}
{
"code":400
"message":"帮助标题不能为空"
}
{
"code":400
"message":"分类ID无效"
}
{
"code":400
"message":"内容无效"
}
{
"code":400
"message":"显示平台无效"
}
{
"code":500
"message":"Upodate Help Content Fail"
}
```
## 根据ID获得帮助内容
> 接口名:`/HelpContentRest/getHelpContentById`
### 入参
``` json
{
"id":44
}
```
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|id|int|44|帮助内容记录ID|
---------------------
### 返回
``` json
{
"code": 200,
"data": {
"categoryId": 13,
"content": "如订单未选择发票需要补寄,请您联系有货客服,我们可以为您补开三个自然月内订单的发票,但是需运费到付。",
"createTime": 1455438073,
"id": 44,
"platform": [
"iphone",
"android",
"h5"
],
"title": "补开发票",
"updateTime": 1455438842
},
"message": "Help Content"
}
{
"code":400
"message":"Id is null"
}
```
## 获取所有帮助内容
> 接口名:`/HelpContentRest/getAllHelpContent`
### 入参
``` json
{
"categoryId":13,
"platform":"iphone,android"
}
or
{
"categoryId":13,
}
or
{
"platform":"iphone,android"
}
or
{ }
```
注意:如果不传入参数,必须传入`{}`
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|categoryId|int|13|分类ID(可选)|
|platform|String|iphone,android|显示平台(可选)|
---------------------
### 返回
``` json
{
"code": 200,
"data": [
{
"categoryId": 13,
"content": "如订单未选择发票需要补寄,请您联系有货客服,我们可以为您补开三个自然月内订单的发票,但是需运费到付。",
"createTime": 1455438073,
"id": 44,
"platform": "iphone,android,h5",
"status": 1,
"title": "补开发票",
"updateTime": 1455438842
},
{
"categoryId": 13,
"content": "4",
"createTime": 1437566047,
"id": 17,
"platform": "iphone,android",
"status": 1,
"title": "3",
"updateTime": 0
},
{
"categoryId": 13,
"content": "3",
"createTime": 1437566035,
"id": 16,
"platform": "iphone,android",
"status": 1,
"title": "2",
"updateTime": 0
},
{
"categoryId": 13,
"content": "订单生成后无法修改收货人信息,请您联系有货客服处理。",
"createTime": 1437562842,
"id": 13,
"platform": "iphone,android",
"status": 1,
"title": "修改订单地址/电话",
"updateTime": 0
},
{
"categoryId": 13,
"content": "因为网络问题,信息更新有所延迟,导致无法显示,请您保持网络顺畅情况下,重新登录进入再查看。",
"createTime": 1437562792,
"id": 11,
"platform": "iphone,android",
"status": 1,
"title": "下单后看不到订单",
"updateTime": 0
},
{
"categoryId": 13,
"content": "目前暂不支持订单修改功能,请您联系有货客服为您处理。",
"createTime": 1437562767,
"id": 10,
"platform": "iphone,android",
"status": 1,
"title": "订单内容的修改",
"updateTime": 0
},
{
"categoryId": 13,
"content": "在线支付订单未付款2小时内会自动取消,付款成功后需联系有货客服取消订单,货到付款订单未发货前可以进入“我的订单”自行取消订单。",
"createTime": 1437545220,
"id": 1,
"platform": "iphone,android",
"status": 1,
"title": "取消订单",
"updateTime": 1437548510
}
],
"message": "All Help Content Platform List"
}
```
## 删除帮助内容
> 接口名:`/HelpContentRest/deleteHelpContent`
### 入参
``` json
{
"id":44
}
```
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|id|int|44|帮助内容记录ID|
---------------------
### 返回
``` json
{
"code": 200,
"message": "删除成功"
}
or
{
"code": 400,
"message": "Id is null"
}
or
{
"code": 500,
"message": "删除失败"
}
```
## 分页显示帮助内容
> 接口名:`/HelpContentRest/getHelpContentList`
### 入参
``` json
{
"page":2,
"size":12
}
```
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|page|int|2|第几页(可选) 默认为1|
|size|int|12|每页条数(可选)默认为10|
---------------------
### 返回
``` json
{
"code": 200,
"data": {
"list": [
{
"categoryId": 0,
"content": "目前暂不支持订单修改功能,请您联系有货客服为您处理。",
"createTime": 0,
"id": 0,
"platform": "iphone,android",
"title": "订单内容的修改",
"updateTime": 0
},
{
"categoryId": 0,
"content": "优惠券是有货线上品牌商城针对不同品牌或商品向消费者发送的虚拟券,优惠券可直接用于指定品牌或商品消费,不可转让他人,不可兑换为现金。",
"createTime": 0,
"id": 0,
"platform": "iphone,android",
"title": "什么是优惠券?",
"updateTime": 0
},
{
"categoryId": 0,
"content": "Yoho币是有货商城全场针对不同商品向已激活用户返还的虚拟购物币。Yoho!币可直接用于有货线上购物使用,不可转让他人,不可兑换为现金。使用YOHO币支付的金额将不计入消费金额用以计算返还金额。",
"createTime": 0,
"id": 0,
"platform": "iphone,android",
"title": "Yoho币是什么,有什么用?",
"updateTime": 0
},
{
"categoryId": 0,
"content": "银卡会员需年度累计消费满600元,金卡会员需年度累计消费满2000元,白金会员需年度累计消费满5000元。年度指连续的365天内(数字年),而非2011,2012这样的自然年。",
"createTime": 0,
"id": 0,
"platform": "iphone,android",
"title": "消费多少可以成为银卡会员、金卡会员、白金会员?",
"updateTime": 0
},
{
"categoryId": 0,
"content": "您可进入“我的订单”,点击”确认收货”后,申请退换货,按页面提示填写相关信息,提交申请。我们会在24小时内以短信或电话的方式告知您审核结果,审核通过后,请您将商品连同发货单一并寄回,请您寄回时不要选择平邮或到付。",
"createTime": 0,
"id": 0,
"platform": "iphone,android",
"title": "如何办理退换货",
"updateTime": 0
},
{
"categoryId": 0,
"content": "有货与配送公司签订先验货后签收协议,请在配送人员还在场的情况下,当面验收您的商品,货到付款订单可以开箱验货但是未签收情况下不能试穿。",
"createTime": 0,
"id": 0,
"platform": "iphone,android",
"title": "可以开箱验货吗",
"updateTime": 0
},
{
"categoryId": 0,
"content": "浦发,深发,民生等银行只要客户设了密码,都是不可以进行交易的;工,农,建等全国性银行中,只有工行肯定是不能交易,别的银行是可以的。如在支付中有任何疑问,请联系有货客服为您处理",
"createTime": 0,
"id": 0,
"platform": "iphone,android",
"title": "为什么信用卡无法支付",
"updateTime": 0
},
{
"categoryId": 0,
"content": "如订单未选择发票需要补寄,请您联系有货客服,我们可以为您补开三个自然月内订单的发票,但是需运费到付。",
"createTime": 0,
"id": 0,
"platform": "iphone,android",
"title": "补开发票",
"updateTime": 0
},
{
"categoryId": 0,
"content": "您可进入“我的订单”中查询订单状态,有货会在订单审核通过后24小时内为您发出包裹。(温馨提示:预售商品发货时间以商品页面标注为准)。",
"createTime": 0,
"id": 0,
"platform": "iphone,android",
"title": "发货时间",
"updateTime": 0
},
{
"categoryId": 0,
"content": "在线支付订单未付款2小时内会自动取消,付款成功后需联系有货客服取消订单,货到付款订单未发货前可以进入“我的订单”自行取消订单。",
"createTime": 0,
"id": 0,
"platform": "iphone,android",
"title": "取消订单",
"updateTime": 0
}
],
"page": 2,
"size": 12,
"total": 0,
"totalPage": 0
},
"message": "Help Content List"
}
```
## 获取帮助内容总记录数
> 接口名:`/HelpContentRest/getHelpContentCount`
### 入参
---------------------
### 返回
``` json
{
"code": 200,
"data": 22,
"message": "成功"
}
```
## 根据分类ID查帮助内容
> 接口名:`/HelpContentRest/getHelpContentByCategoryId`
### 入参
``` json
{
"categoryId": 13
}
```
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|categoryId|int|13|分类ID|
---------------------
### 返回
``` json
{
"code": 200,
"data": [
{
"categoryId": 13,
"content": "在线支付订单未付款2小时内会自动取消,付款成功后需联系有货客服取消订单,货到付款订单未发货前可以进入“我的订单”自行取消订单。",
"createTime": 1437545220,
"id": 1,
"platform": "iphone,android",
"status": 1,
"title": "取消订单",
"updateTime": 1437548510
},
{
"categoryId": 13,
"content": "目前暂不支持订单修改功能,请您联系有货客服为您处理。",
"createTime": 1437562767,
"id": 10,
"platform": "iphone,android",
"status": 1,
"title": "订单内容的修改",
"updateTime": 0
},
{
"categoryId": 13,
"content": "因为网络问题,信息更新有所延迟,导致无法显示,请您保持网络顺畅情况下,重新登录进入再查看。",
"createTime": 1437562792,
"id": 11,
"platform": "iphone,android",
"status": 1,
"title": "下单后看不到订单",
"updateTime": 0
},
{
"categoryId": 13,
"content": "订单生成后无法修改收货人信息,请您联系有货客服处理。",
"createTime": 1437562842,
"id": 13,
"platform": "iphone,android",
"status": 1,
"title": "修改订单地址/电话",
"updateTime": 0
},
{
"categoryId": 13,
"content": "3",
"createTime": 1437566035,
"id": 16,
"platform": "iphone,android",
"status": 1,
"title": "2",
"updateTime": 0
},
{
"categoryId": 13,
"content": "4",
"createTime": 1437566047,
"id": 17,
"platform": "iphone,android",
"status": 1,
"title": "3",
"updateTime": 0
}
],
"message": "Help Content List by CategoryId"
}
or
{
"code":400
"message":"分类ID无效"
}
```
## 根据平台查帮助内容
> 接口名:`/HelpContentRest/getHelpContentByPlatform`
### 入参
``` json
{
"platform": "iphone,android"
}
```
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|platform|String|iphone,android|显示平台|
---------------------
### 返回
``` json
{
"code": 200,
"data": [
{
"categoryId": 13,
"content": "在线支付订单未付款2小时内会自动取消,付款成功后需联系有货客服取消订单,货到付款订单未发货前可以进入“我的订单”自行取消订单。",
"createTime": 1437545220,
"id": 1,
"platform": "iphone,android",
"status": 1,
"title": "取消订单",
"updateTime": 1437548510
},
{
"categoryId": 14,
"content": "您可进入“我的订单”中查询订单状态,有货会在订单审核通过后24小时内为您发出包裹。(温馨提示:预售商品发货时间以商品页面标注为准)。",
"createTime": 1437546597,
"id": 2,
"platform": "iphone,android",
"status": 1,
"title": "发货时间",
"updateTime": 1437548685
},
{
"categoryId": 15,
"content": "如订单未选择发票需要补寄,请您联系有货客服,我们可以为您补开三个自然月内订单的发票,但是需运费到付。",
"createTime": 1437546640,
"id": 3,
"platform": "iphone,android",
"status": 1,
"title": "补开发票",
"updateTime": 1437548679
},
{
"categoryId": 17,
"content": "浦发,深发,民生等银行只要客户设了密码,都是不可以进行交易的;工,农,建等全国性银行中,只有工行肯定是不能交易,别的银行是可以的。如在支付中有任何疑问,请联系有货客服为您处理",
"createTime": 1437546674,
"id": 4,
"platform": "iphone,android",
"status": 1,
"title": "为什么信用卡无法支付",
"updateTime": 1437548673
},
{
"categoryId": 18,
"content": "有货与配送公司签订先验货后签收协议,请在配送人员还在场的情况下,当面验收您的商品,货到付款订单可以开箱验货但是未签收情况下不能试穿。",
"createTime": 1437546710,
"id": 5,
"platform": "iphone,android",
"status": 1,
"title": "可以开箱验货吗",
"updateTime": 1437548665
},
{
"categoryId": 19,
"content": "您可进入“我的订单”,点击”确认收货”后,申请退换货,按页面提示填写相关信息,提交申请。我们会在24小时内以短信或电话的方式告知您审核结果,审核通过后,请您将商品连同发货单一并寄回,请您寄回时不要选择平邮或到付。",
"createTime": 1437546751,
"id": 6,
"platform": "iphone,android",
"status": 1,
"title": "如何办理退换货",
"updateTime": 1437548659
},
{
"categoryId": 21,
"content": "银卡会员需年度累计消费满600元,金卡会员需年度累计消费满2000元,白金会员需年度累计消费满5000元。年度指连续的365天内(数字年),而非2011,2012这样的自然年。",
"createTime": 1437546777,
"id": 7,
"platform": "iphone,android",
"status": 1,
"title": "消费多少可以成为银卡会员、金卡会员、白金会员?",
"updateTime": 1437548651
},
{
"categoryId": 22,
"content": "Yoho币是有货商城全场针对不同商品向已激活用户返还的虚拟购物币。Yoho!币可直接用于有货线上购物使用,不可转让他人,不可兑换为现金。使用YOHO币支付的金额将不计入消费金额用以计算返还金额。",
"createTime": 1437546798,
"id": 8,
"platform": "iphone,android",
"status": 1,
"title": "Yoho币是什么,有什么用?",
"updateTime": 1437548645
},
{
"categoryId": 23,
"content": "优惠券是有货线上品牌商城针对不同品牌或商品向消费者发送的虚拟券,优惠券可直接用于指定品牌或商品消费,不可转让他人,不可兑换为现金。",
"createTime": 1437546819,
"id": 9,
"platform": "iphone,android",
"status": 1,
"title": "什么是优惠券?",
"updateTime": 1437552970
},
{
"categoryId": 13,
"content": "目前暂不支持订单修改功能,请您联系有货客服为您处理。",
"createTime": 1437562767,
"id": 10,
"platform": "iphone,android",
"status": 1,
"title": "订单内容的修改",
"updateTime": 0
},
{
"categoryId": 13,
"content": "因为网络问题,信息更新有所延迟,导致无法显示,请您保持网络顺畅情况下,重新登录进入再查看。",
"createTime": 1437562792,
"id": 11,
"platform": "iphone,android",
"status": 1,
"title": "下单后看不到订单",
"updateTime": 0
},
{
"categoryId": 14,
"content": "货到付款订单提交后为待审核状态的正常的,我们会在您成功下单后24小时内审核您的订单。",
"createTime": 1437562820,
"id": 12,
"platform": "iphone,android",
"status": 1,
"title": "订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核订单还没有审核",
"updateTime": 1437815593
},
{
"categoryId": 13,
"content": "订单生成后无法修改收货人信息,请您联系有货客服处理。",
"createTime": 1437562842,
"id": 13,
"platform": "iphone,android",
"status": 1,
"title": "修改订单地址/电话",
"updateTime": 0
},
{
"categoryId": 13,
"content": "3",
"createTime": 1437566035,
"id": 16,
"platform": "iphone,android",
"status": 1,
"title": "2",
"updateTime": 0
},
{
"categoryId": 13,
"content": "4",
"createTime": 1437566047,
"id": 17,
"platform": "iphone,android",
"status": 1,
"title": "3",
"updateTime": 0
},
{
"categoryId": 17,
"content": "测试",
"createTime": 1438219772,
"id": 35,
"platform": "iphone,android",
"status": 1,
"title": "这个是常见支付的问题",
"updateTime": 0
},
{
"categoryId": 22,
"content": "测试",
"createTime": 1438219938,
"id": 36,
"platform": "iphone,android",
"status": 1,
"title": "这是yoho币的问题",
"updateTime": 0
}
],
"message": "Help Content List by CategoryId"
}
or
{
"code":400
"message":"显示平台无效"
}
```
## 帮助列表
> 接口名:`/HelpContentRest/getHelp`
### 入参
``` json
{
"categoryId":13,
"platform":"iphone,android"
}
or
{
"categoryId":13,
}
```
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|categoryId|int|13|分类ID|
|platform|String|iphone,android|显示平台(可选)默认h5|
---------------------
### 返回
``` json
{
"categoryId":13,
"platform":"iphone,android"
}
or
{
"code":400
"message":"帮助分类不能为空"
}
```
## 帮助内容
> 接口名:`/HelpContentRest/getHelpContent`
### 入参
``` json
{
"id": 42
}
```
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|id|int|42|帮助内容记录ID|
---------------------
### 返回
``` json
{
"code": 200,
"data": {
"categoryId": 14,
"content": "这个是物流问题",
"createTime": 1449038392,
"id": 42,
"platform": [
"h5"
],
"title": "物流问题",
"updateTime": 0
},
"message": "帮助内容"
}
or
{
"code":400
"message":"请选择要查看的帮助"
}
or
{
"code":400
"message":"内容不存在"
}
```
... ...
# 热门标签接口服务定义
----------------------
# 查询热门标签接口
> 接口名:`hotRankTag/selectTagList`
### 入参
----------------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|platform|string|iphone|平台|否|
|channel|string|1|频道|否|
|status|integer|1|状态:0 不启用 ,1 启用 |否|
----------------------------------
### 返回
``` json
{
"code": 200,
"data": [
{
"categoryId": "134,135",
"channel": "2",
"createTime": 1442233441,
"id": 17,
"orderBy": 0,
"platform": "iphone,ipad,android,androidpad,web",
"status": 1,
"tagName": "裙装",
"updateTime": 1448000665
}
],
"message": "Tag List"
}
```
# 添加标签接口
> 接口名:`hotRankTag/addTag`
### 入参
----------------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|tagName|string|智能装备|标签名称|是|
|categoryId|string|33,34|分类ID,多个分类用逗号隔开|否|
|platform|string|iphone|平台|是|
|channel|string|1|频道|是|
|orderBy|integer|1|序号|否|
----------------------------------
### 返回
``` json
{
"code":200,
"message":"添加标签信息成功"
}
```
# 更新标签接口
> 接口名:`hotRankTag/updateTag`
### 入参
----------------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|id|integer|33|主键|是|
|tagName|string|智能装备|标签名称|是|
|categoryId|string|33,34|分类ID,多个分类用逗号隔开|否|
|platform|string|iphone|平台|是|
|channel|string|1|频道|是|
|orderBy|integer|1|序号|否|
----------------------------------
### 返回
``` json
{
"code":200,
"message":"修改标签信息成功"
}
```
# 发布标签接口
> 接口名:`hotRankTag/updateTag`
### 入参
----------------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|id|integer|33|主键|是|
----------------------------------
### 返回
``` json
{
"code":200,
"message":"操作成功"
}
```
# 关闭标签接口
> 接口名:`hotRankTag/updateTag`
### 入参
----------------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|id|integer|33|主键|是|
----------------------------------
### 返回
``` json
{
"code":200,
"message":"操作成功"
}
```
... ...
支付中心管理接口定义
**1、获取支付管理列表**
获取支付管理列表(/PayManageController/findPayManageList)
**请求参数**
**请求示例**
注意,通用的头部没有列出
http://localhost:8080/platform/PayManageController/findPayManageList
**响应**
code为200即为成功,否则是失败。 响应JSON格式如下所示:
{
"code": 200,
"data": {
"list": [
{
"createTime": "2016-07-18 16:01:20",
"id": 36,
"payName": "QQ钱包",
"recommendOrderPage": 0,
"recommendText1": "需安装QQ客户端",
"recommendWords": "",
"sortNumber": 1,
"status": 1,
"updateTime": ""
},
{
"createTime": "2016-07-18 16:00:32",
"id": 34,
"payName": "微信",
"recommendOrderPage": 0,
"recommendText1": "需安装微信客户端",
"recommendWords": "",
"sortNumber": 3,
"status": 1,
"updateTime": ""
},
{
"createTime": "2016-07-18 15:59:27",
"id": 32,
"payName": "支付宝",
"recommendOrderPage": 1,
"recommendText1": "",
"recommendWords": "推荐文案",
"sortNumber": 2,
"status": 1,
"updateTime": "2016-07-18 16:06:01"
}
],
"page": 1,
"size": 10,
"total": 3,
"totalPage": 1
},
"message": "操作成功"
}
**2、获取支付方式详情**
获取支付方式详情(/PayManageController/findPayInfoById)
**请求参数**
| 参数名称 | 参数类型 |可否为空 |示例 |默认值 | 备注 |
| ---------|:--------:| --------:|-----:|------:|-----:|
|id |int | 否 |1 | | |
**请求示例**
注意,通用的头部没有列出
http://localhost:8080/platform/PayManageController/findPayInfoById
{
"id":34
}
**响应**
{
"code": 200,
"data": {
"createTime": "2016-07-18 16:00:32",
"id": 34,
"payName": "微信",
"recommendOrderPage": 0,
"recommendText1": "需安装微信客户端",
"recommendWords": "",
"sortNumber": 3,
"status": 1,
"updateTime": ""
},
"message": "操作成功"
}
其他相应
{
"code": 201,
"message": "请求查询id为空"
}
{
"code": 201,
"message": "请求查询id不存在"
}
**3、新增支付方式**
新增支付方式(/PayManageController/createPayMode)
**请求参数**
| 参数名称 | 参数类型 |可否为空 |示例 |默认值 | 备注 |
| ---------|:--------:| --------:|-----:|------:|-----:|
|payName |String | 否 |支付宝 | | 支付方式名称 |
|recommendOrderPage |int | 否 |0 | 0 |是否推荐到确认订单页,0-否;1-是|
|recommendWords |String | 是 | | | 推荐文案 |
|sortNumber |int | 否 |1 | 0 | 前端排序值,数字越大越靠前 |
|recommendText1 |String | 是 | | |推荐语1 |
|recommendText2 |String | 是 | | | 推荐语2 |
**请求示例**
注意,通用的头部没有列出
http://localhost:8080/platform/PayManageController/createPayMode
{
"payName":"银联支付",
"recommendOrderPage":1,
"recommendWords":"推荐文案",
"sortNumber":7,
"recommendText1":""
}
**响应**
{
"code": 200,
"message": "操作成功"
}
其他响应情况
{
"code": 201,
"message": "支付方式名称为空"
}
{
"code": 202,
"message": "该支付方式名称已存在"
}
{
"code": 201,
"message": "前端排序值无效"
}
{
"code": 201,
"message": "该前端排序值已存在"
}
{
"code": 201,
"message": "推荐文案为空"
}
**4、编辑支付方式详情**
编辑支付方式(/PayManageController/updatePayInfoById)
**请求参数**
| 参数名称 | 参数类型 |可否为空 |示例 |默认值 | 备注 |
| ---------|:--------:| --------:|-----:|------:|-----:|
|id |int | 否 |1 | | |
|payName |String | 否 |支付宝 | | 支付方式名称,不可修改 |
|recommendOrderPage |int | 否 |0 | 0 |是否推荐到确认订单页,0-否;1-是|
|recommendWords |String | 是 | | | 推荐文案 |
|sortNumber |int | 否 |1 | 0 | 前端排序值,数字越大越靠前 |
|recommendText1 |String | 是 | | |推荐语1 |
|recommendText2 |String | 是 | | | 推荐语2 |
**请求示例**
注意,通用的头部没有列出
http://localhost:8080/platform/PayManageController/updatePayInfoById
{
"id":2,
"recommendOrderPage":1,
"recommendWords":"推荐文案",
"sortNumber":2
}
**响应**
{
"code": 200,
"message": "操作成功"
}
其他相应
{
"code": 201,
"message": "请求编辑id为空"
}
{
"code": 201,
"message": "前端排序值无效"
}
{
"code": 201,
"message": "该前端排序值已存在"
}
{
"code": 201,
"message": "推荐文案为空"
}
**5、开启支付方式**
开启支付方式(/PayManageController/openPayModeById)
**请求参数**
| 参数名称 | 参数类型 |可否为空 |示例 |默认值 | 备注 |
| ---------|:--------:| --------:|-----:|------:|-----:|
|id |int | 否 |1 | | |
**请求示例**
注意,通用的头部没有列出
http://localhost:8080/platform/PayManageController/openPayModeById
{
"id":2
}
**响应**
{
"code": 200,
"message": "操作成功"
}
其他响应
{
"code": 201,
"message": "开启请求id为空"
}
**6、关闭支付方式**
关闭支付方式(/PayManageController/closePayModeById)
**请求参数**
| 参数名称 | 参数类型 |可否为空 |示例 |默认值 | 备注 |
| ---------|:--------:| --------:|-----:|------:|-----:|
|id |int | 否 |1 | | |
**请求示例**
注意,通用的头部没有列出
http://localhost:8080/platform/PayManageController/closePayModeById
{
"id":2
}
**响应**
{
"code": 200,
"message": "操作成功"
}
其他响应
{
"code": 201,
"message": "关闭请求id为空"
}
\ No newline at end of file
... ...
... ... @@ -10,8 +10,8 @@
|参数名 |必填 |类型 |示例值 |描述 |
|------ |---- |---- |------ |---- |
|name |否 |string |男首页 |资源名称 |
|sort_id |否 |int |2 |分类编号 |
|platform_id|否 |int |1 |平台编号 |
|sortId |否 |int |2 |分类编号 |
|platformId |否 |int |1 |平台编号 |
|page |否 |int |1 |页数 |
#### 返回
... ... @@ -28,31 +28,13 @@
{
"id":8,
"name":"男首页",
"sort_id":2,
"sort_name":"男首",
"platform_id":1,
"platform_name":"yohoApp",
"sortId":2,
"sortName":"男首",
"platformId":1,
"platformName":"yohoApp",
"code":"201504091403001",
"match_code":"",
"create_time":1430378310,
"sort_list":[
{
"sort_id":2,
"sort_name":"男首",
"platform_id":"1",
"create_time":1430304722,
"status":1
}
],
"plat_list":[
{
"platform_id":1,
"platform_name":"yohoApp",
"platform_flag":"iphone",
"create_time":1430300615,
"status":1
}
]
"matchCode":"",
"createTime":1430378310
}
]
}
... ... @@ -69,12 +51,67 @@
|content |内容 |
|id |资源编号 |
|name |资源名称 |
|sort_id |分类编号 |
|sort_name |分类名称 |
|platform_id|平台编号 |
|platform_name|平台名称 |
|sortId |分类编号 |
|sortName |分类名称 |
|platformId |平台编号 |
|platformName|平台名称 |
|code |资源码 |
|match_code |配对码 |
|create_time|创建时间 |
|sort_list |分类列表 |
|plat_list |平台列表 |
\ No newline at end of file
|matchCode |配对码 |
|createTime |创建时间 |
### 查询所有的平台
> GET `/resources/platforms`
#### 返回
``` json
{
"code":200
"data":{
"platformId":1,
"platformName":"yohoApp",
"platformFlag":"iphone",
"createTime":1430300615,
"status":1
}
}
```
-----------------------------
|参数名 |描述 |
|------ |---- |
|platformId |平台编号 |
|platformName|平台名称 |
|platformFlag|平台标识 |
|createTime |创建时间 |
|status |状态码 |
### 查询所有的资源分类
> GET `/resources/sorts`
#### 返回
``` json
{
"code":200
"data":{
"sortId":2,
"sortName":"男首",
"platformId":1,
"createTime":1430304722,
"status":1
}
}
```
-----------------------------
|参数名 |描述 |
|------ |---- |
|sortId |分类编号 |
|sortName |分类名称 |
|platformId |平台编号 |
|createTime |创建时间 |
|status |状态码 |
\ No newline at end of file
... ...
# 七牛云图片上传服务接口定义
---------------------
# 七牛云图片上传服务接口
> 接口名: `/fileupload/upload/`
### 入参
-------------------------
|属性名称|类型|例子|说明
|--------|----|----|----|
|file|file|-|图片文件
|userId|string|54|用户id|
|bucket|string|yhb-img02|bucket空间,可选(默认为yhb-img01)但值只能是yhb-img01或yhb-img02|
---------------------
### 返回
``` json
{
"code": 200,
"data": "http://yhfair.qiniudn.com/yhb-img01/2016/02/16/22/01575e9f268f8e9f2357a6105f0e707536.png",
"message": "上传成功"
}
```
... ...
资讯管理接口服务定义
---------------------
## 资讯列表查询
> 接口名: 'article/getList'
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|articleTitle|String|尖货盘点|资讯标题|
|articleGender|String|1|性别|
|authorId|int|2890|作者ID|
|maxSortId|int|12|分类ID|
|status|int|1|资讯状态|
|orderBy|String|1|时间方式|
|startTime|String|2016-01-01|开始时间|
|endTime|String|2016-02-01|结束时间|
---------------------
### 返回
``` json
{
"code":200,
"message":"操作成功",
"data": {
"list": [
{
"id": "", //资讯ID
"coverImage": "", //封面图
"articleTitle": "", //资讯标题
"maxSortId": "", //分类
"articleGender": "", //性别
"authorId": "", //作者
"status": "", //状态,-1已关闭,0 未发布,1 已发布
"createTime": "", //创建时间
"publishTime": "", //发布时间
}
],
"page": 0,
"size": 50,
"total": 1000,
"totalPage":20
}
}
```
## 获取作者列表接口
> 接口名: 'article/getAuthorList'
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|idName|String|1054|作者ID或姓名|
---------------------
### 返回
``` json
{
"code":200,
"message":"操作成功",
"data": [
{
"id": "",
"text":""
}
]
}
```
## 获取所有分类接口
> 接口名: 'article/getSortList'
### 入参
### 返回
``` json
{
"code":200,
"message":"操作成功",
"data": [
{
"id": "",
"text":""
}
]
}
```
## 编辑时资讯详情接口
> 接口名: 'article/getArticleDetail'
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|id|int|43|资讯id|
---------------------
### 返回
``` json
{
"code":200,
"message":"操作成功",
"data": {
"id": "",
“coverImage": "", //封面图
"articleTitle": "", //资讯标题
"maxSortId": "", //一级分类
"minSortId": "", //二级分类
"articleSummary": "",//摘要
"coverImageType": "",//图片类型
"articleType": "", //文章类型
"adsImgSize": "", //广告尺寸
"url": "", //链接
"articleGender": "", //性别
"authorId": "", //作者
"status": "", //状态,-1已关闭,0 未发布,1 已发布
"createTime": "", //创建时间
"publishTime": "", //发布时间
}
}
```
## 新增资讯接口
> 接口名: 'article/addArticle'
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|articleTitle|String|尖货盘点|资讯标题|
|articleGender|String|0|性别|
|authorId|int|3098|作者ID|
|maxSortId|int|12|一级分类ID|
|minSortId|int|35|二级分类ID|
|articleSummary|String|御寒首选|摘要|
|coverImage|String||封面图|
|coverImageType|int|1|图片类型|
|articleType|int|1|文章类型|
|adsImgSize|String|10881088|广告尺寸|
|url|String|{"action":"go.activity","url":"http://feature.yohobuy.com/0/0/373/index.html"|链接|
---------------------
### 返回
``` json
{
"code":200,
"message":"添加成功!"
}
```
## 修改/发布(关闭)/推荐(取消推荐)资讯接口
> 接口名: 'article/updateArticle'
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|id|int|1054|资讯ID|
|articleTitle|String|尖货盘点|资讯标题|
|articleGender|String|0|性别|
|authorId|int|3098|作者ID|
|maxSortId|int|12|一级分类ID|
|minSortId|int|35|二级分类ID|
|articleSummary|String|御寒首选|摘要|
|coverImage|String||封面图|
|coverImageType|int|1|图片类型|
|articleType|int|1|文章类型|
|adsImgSize|String|10881088|广告尺寸|
|url|String|{"action":"go.activity","url":"http://feature.yohobuy.com/0/0/373/index.html"|链接|
---------------------
### 返回
``` json
{
"code":200,
"message":"修改成功!"
}
```
## 删除资讯接口
> 接口名: 'article/delArticle'
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|id|int|43|资讯id|
---------------------
### 返回
``` json
{
"code":200,
"message":"删除成功!"
}
```
## 定时发布资讯接口
> 接口名: 'article/timePublish'
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|id|int|43|资讯id|
|publishTime|String|2016-02-19 16:17|定时发布时间|
---------------------
### 返回
``` json
{
"code":200,
"message":"定时发布成功!"
}
```
## 资讯获取选择选项的枚举接口
> 接口名: 'EnumListRest/getEnumList'
### 返回
``` json
{
"code":200,
"message":"请求成功",
"data": {
"genderItems": [{ //性别
"value": "",
"name": ""
}],
"publishStatusItems": [{ //发布状态
"value": "",
"name": ""
}],
"articleTypeItems": [{ //文章类型
"value": "",
"name": ""
}],
"coverImageTypeItems": [{ //封面图片类型
"value": "",
"name": ""
}],
"adsImgSizeItems": [{ //广告尺寸
"value": "",
"name": ""
}]
}
}
```
```
\ No newline at end of file
... ...
文章分类管理接口服务定义
---------------------
## 文章分类列表查询
> 接口名: 'article/sort/getList'
### 入参
### 返回
``` json
{
"code":200,
"message":"操作成功",
"data": {
"list": [
{
"id": "", //分类ID
"parentId": "", //父分类ID
"name": "", //分类名称
"status": "", //状态,0关闭,1开启
"orderBy": "", //排序
"advertCode": "",//广告码
"sub": "", //子分类
}
]
}
}
```
## 添加分类接口
> 接口名: 'article/sort/addSort'
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|parentId|int|0|父分类ID|
|name|string|欧美风|分类名称|
|status|int|1|是否启用|
|advertCode|string|180a31250622f11180f808d4404d0e78|广告码|
|orderBy|int|5|排序|
---------------------
### 返回
``` json
{
"code":200,
"message":"添加成功!"
}
```
## 编辑分类接口
> 接口名: 'article/sort/updateSort'
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|id|int|10231|分类ID|
|parentId|int|0|父分类ID|
|name|string|欧美风|分类名称|
|status|int|1|是否启用|
|advertCode|string|180a31250622f11180f808d4404d0e78|广告码|
|orderBy|int|5|排序|
---------------------
### 返回
``` json
{
"code":200,
"message":"修改成功!"
}
```
## 编辑时分类详情接口
> 接口名: 'article/sort/getDetail'
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|id|int|43|分类id|
---------------------
### 返回
``` json
{
"code":200,
"message":"操作成功",
"data": {
"id": "", //分类ID
"parentId": "", //父分类ID
"name": "", //分类名称
"status": "", //状态,0关闭,1开启
"orderBy": "", //排序
"advertCode": "", //广告码
}
}
```
## 删除分类接口
> 接口名: 'article/sort/delSort'
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|id|int|43|分类id|
---------------------
### 返回
``` json
{
"code":200,
"message":"删除成功!"
}
```
```
\ No newline at end of file
... ...
标签分类管理接口服务定义
---------------------
## 标签分类列表查询
> 接口名: '/tags/sort/getList'
### 入参
### 返回
``` json
{
"code":200,
"message":"操作成功",
"data": {
"list": [
{
"id": "", //分类ID
"classifyName": "", //分类名称
"status": "", //是否启用
"orderBy": "", //排序
"createTime": "", //创建时间
}
]
}
}
```
## 添加分类接口
> 接口名: '/tags/sort/addSort'
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|classifyName|String|搭配风格|分类名称|
|status|int|1|是否启用|
|orderBy|int|5|排序|
---------------------
### 返回
``` json
{
"code":200,
"message":"添加成功!"
}
```
## 编辑分类接口
> 接口名: '/tags/sort/updateSort'
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|id|int|1023|分类ID|
|classifyName|String|搭配风格|分类名称|
|status|int|1|是否启用|
|orderBy|int|5|排序|
---------------------
### 返回
``` json
{
"code":200,
"message":"修改成功!"
}
```
## 编辑时分类详情接口
> 接口名: '/tags/sort/getDetail'
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|id|int|43|分类id|
---------------------
### 返回
``` json
{
"code":200,
"message":"操作成功",
"data": {
"id": "",
"classifyName": "", //分类名称
"status": "", //是否启用
"orderBy": "", //排序
"createTime": "", //创建时间
}
}
```
## 删除分类接口
> 接口名: '/tags/sort/delSort'
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|id|int|43|分类id|
---------------------
### 返回
``` json
{
"code":200,
"message":"删除成功!"
}
```
```
\ No newline at end of file
... ...
# 限购码管理接口服务定义
---------------------
# 添加限购码接口
> 接口名: `/limitCode/addLimitCode`
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|name|string|潮流尖货限购码|限购码名称|是|
|limitTimes|int|100|数量|是|
|reqDepartment|string|运营部|申请部门|否|
|limitDateFrom|string|2016-02-01 14:00:00|起始时间|是|
|limitDateTo|string|2016-02-20 14:00:00|失效时间|是|
|describe|string|耐克新款|限购码描述|否|
|userUseLimit|int|1|用户使用次数|否|
|userTypeLimit|int|1|用户类型|否
|limitSkn|string|50012345|限购商品skn|否
|creatorName|string|张三|创建者名称|否
|creatorId|int|12401|创建者ID|否
|createTime|string|2016-01-29 15:00:00|创建时间|否
|status|int|0|限购码状态0:待审核 1:审核通过 2:驳回 3:过期 4:作废|否
|reason|string|预算不够|驳回原因|否
|batchNo|string|201602021023|批次号|是
|auditTime|string|2016-01-30 15:00:00|审核时间|否
---------------------
### 返回
``` json
{
"code": 200,
"data": [],
"md5": "d751713988987e9331980363e24189ce",
"message": "addLimitCode success."
}
```
# 获取限购码列表
> 接口名: `/limitCode/getLimitCodeList`
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|
|-------|----|----|----|-------|
--------------------------------
### 返回
``` json
{
"code": 200,
"data": {
"list": [
{
"batchNo": "201602031002",
"createTime": "2016-02-03 17:33:08",
"describe": "",
"id": 7,
"limitDateFrom": "2016-01-01",
"limitDateTo": "2016-01-31",
"limitTimes": 10,
"name": "第一批次限购码",
"reqDepartment": "运营部",
"status": 0,
"userUseLimit": 1
},
{
"auditTime": "2016-01-29 18:15:01",
"batchNo": "201601291001",
"createTime": "2016-02-03 15:12:51",
"creatorId": 1111,
"creatorName": "test",
"describe": "第1批次限购码",
"id": 6,
"limitDateFrom": "2016-01-01",
"limitDateTo": "2016-01-31",
"limitSkn": "5123456",
"limitTimes": 10,
"name": "第1批次限购码",
"reqDepartment": "运营部",
"status": 1,
"userTypeLimit": "1",
"userUseLimit": 1
},
{
"auditTime": "2016-01-29 17:56:02",
"batchNo": "201601291002",
"createTime": "2016-01-29 17:56:02",
"creatorId": 1111,
"creatorName": "test",
"describe": "第6批次限购码",
"id": 5,
"limitDateFrom": "2016-01-01",
"limitDateTo": "2016-01-31",
"limitSkn": "5123456",
"limitTimes": 10,
"name": "第6批次限购码",
"reqDepartment": "运营部",
"status": 1,
"userTypeLimit": "1",
"userUseLimit": 1
}
],
"page": 1,
"size": 20,
"total": 3,
"totalPage": 1
},
"md5": "6d6052f3afcec10ba4d4c8490cd8e5eb",
"message": "getLimitCodeList success."
}
```
# 获取限购码详情
> 接口名: `/limitCode/getLimitCode`
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|
|-------|----|----|----|-------|
|id|int|7|限购码ID|是|
--------------------------------
### 返回
``` json
{
"code": 200,
"data": {
"batchNo": "201602031002",
"createTime": "2016-02-03 17:33:08",
"describe": "",
"id": 7,
"limitDateFrom": "2016-01-01",
"limitDateTo": "2016-01-31",
"limitTimes": 10,
"name": "第一批次限购码",
"reqDepartment": "运营部",
"status": 0,
"userUseLimit": 1
}
"md5": "6d6052f3afcec10ba4d4c8490cd8e5eb",
"message": "getLimitCode success."
}
```
# 更新限购码接口
> 接口名: `/limitCode/updateLimitCode`
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|id|int|6|限购码ID|是|
|name|string|潮流尖货限购码|限购码名称|是|
|limitTimes|int|100|数量|是|
|reqDepartment|string|运营部|申请部门|否|
|limitDateFrom|string|2016-02-01 14:00:00|起始时间|是|
|limitDateTo|string|2016-02-20 14:00:00|失效时间|是|
|describe|string|耐克新款|限购码描述|否|
|userUseLimit|int|1|用户使用次数|否|
|userTypeLimit|int|1|用户类型|否
|limitSkn|string|50012345|限购商品skn|否
|creatorName|string|张三|创建者名称|否
|creatorId|int|12401|创建者ID|否
|createTime|string|2016-01-29 15:00:00|创建时间|否
|status|int|0|限购码状态0:待审核 1:审核通过 2:驳回 3:过期 4:作废|否
|reason|string|预算不够|驳回原因|否
|batchNo|string|201602021023|批次号|是
|auditTime|string|2016-01-30 15:00:00|审核时间|否
---------------------
### 返回
``` json
{
"code": 500,
"data": [],
"md5": "d751713988987e9331980363e24189ce",
"message": "updateLimitCode success."
}
```
# 审核限购码接口
> 接口名: `/limitCode/auditLimitCode`
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|id|int|6|限购码ID|是
|status|int|0|限购码状态0:待审核 1:审核通过 2:驳回 3:过期 4:作废|否
|reason|string|预算不够|驳回原因|否
|auditTime|string|2016-01-30 15:00:00|审核时间|否
---------------------
### 返回
``` json
{
"code": 500,
"data": [],
"md5": "d751713988987e9331980363e24189ce",
"message": "auditLimitCode success."
}
```
# 删除限购码接口
> 接口名: `/limitCode/deleteLimitCode`
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|id|int|6|限购码ID|是
---------------------
### 返回
``` json
{
"code": 200,
"data": [],
"md5": "d751713988987e9331980363e24189ce",
"message": "deleteLimitCode success."
}
```
# 获取各种状态限购码数量接口
> 接口名: `/limitCode/getLimitCodeCountByStatus`
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
---------------------
### 返回
``` json
{
"code": 200,
"data": {
"0": "1",
"1": "1",
"all": "2"
},
"md5": "f29559d3d32c56f9cd94c892128cbae8",
"message": "getLimitCodeCountByStatus success."
}
```
... ...
# 产品管理接口服务定义
---------------------
# 添加(更新)品类接口
> 接口名: `/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: '', //每页多少条
}
}
```
\ No newline at end of file
# 产品颜色管理接口服务定义
---------------------
# 添加颜色接口
> 接口名: `/productColor/addProductColor/`
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|colorName|string|X色|颜色名称|是|
|colorCode|string|FFFF|RGB code|是|
|colorValue|string|www.io.png|图片URL|是|
---------------------
### 返回
``` json
{
"code":200,
"message":"success"
}
```
# 获取颜色列表
> 接口名: `/productColor/queryProductColors`
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|
|-------|----|----|----|-------|
--------------------------------
### 返回
``` json
{
"code": 200,
"data":{
"list" :[
{
"colorCode": "FFFFFF",
"colorName": "白色",
"colorValue": "",
"id": 1
},
{
"colorCode": "333333",
"colorName": "黑色",
"colorValue": "",
"id": 2
},
{
"colorCode": "b9b7af",
"colorName": "灰色",
"colorValue": "",
"id": 3
},
{
"colorCode": "8b5402",
"colorName": "棕色",
"colorValue": "",
"id": 4
},
{
"colorCode": "47ba17",
"colorName": "绿色",
"colorValue": "",
"id": 6
},
{
"colorCode": "0000fe",
"colorName": "蓝色",
"colorValue": "",
"id": 7
},
{
"colorCode": "710098",
"colorName": "紫色",
"colorValue": "",
"id": 8
},
{
"colorCode": "ffeb00",
"colorName": "黄色",
"colorValue": "",
"id": 9
},
{
"colorCode": "ee0000",
"colorName": "红色",
"colorValue": "",
"id": 11
},
{
"colorCode": "ff5c01",
"colorName": "橙色",
"colorValue": "",
"id": 12
},
{
"colorCode": "#ccccc",
"colorName": "银色",
"colorValue": "http://img02.static.yohobuy.com/adpic/2014/01/27/13/02c286ddb8f5c6824a64a45ef6c8e2d18d.png",
"id": 13
},
{
"colorCode": "FFD83D",
"colorName": "金色",
"colorValue": "http://img01.static.yohobuy.com/adpic/2014/01/27/13/011443440339c06843acfd2f62fda68770.png",
"id": 14
},
{
"colorCode": "#fffff",
"colorName": "彩色",
"colorValue": "http://img02.static.yohobuy.com/adpic/2014/01/27/13/0272608508f09e2bf7eb5543bf5cc70d31.png",
"id": 15
}
]
"page": 0,-第几页
"size": 0,-单页记录数
"total": 437,--总数
"totalPage": 1--总页数},
"md5": "a05b6b224e8d517720865f0060b484ad",
"message": "success"
}
```
# 更新产品颜色接口
> 接口名: `/productColor/updateProductColor`
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|id |int|1 |id |是 |
|colorName|string|X色|颜色名称|是|
|colorCode|string|000fff|RGB code|是|
|colorValue|string|www.meili.png|图片URL|是|
---------------------
### 返回
``` json
{
"code": 200,
"data": [],
"md5": "d751713988987e9331980363e24189ce",
"message": " success."
}
```
# 获取单个产品颜色接口
> 接口名: `/productColor/queryProductColor`
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|param|int|1|颜色ID|是
---------------------
### 返回
``` json
{
"code": 200,
"data": {
"colorCode": "cc",
"colorName": "彩色",
"colorValue": "cc-value",
"id": 16
},
"md5": "d08f272cd425a5a89528299e5ab9ebdf",
"message": "success"
}
```
... ...
# 品类关联尺码属性管理接口服务定义
---------------------
# 添加品类关联尺码属性接口
> 接口名: `/sortAttribute/add/`
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|sortId |int|1 |品类id |是 |
|attributeId|int|2|尺码属性id|是|
|orderBy|int|2|排序|否|
---------------------
### 返回
``` json
{
"code":200,
"message":"success"
}
```
# 获取品类关联尺码属性列表
> 接口名: `sortAttribute/queryList/`
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|
|-------|----|----|----|-------|
|sortId |int|1 |品类id |是 |
|page|int|2|页码,默认1|是|
|size|int|20|记录数,默认10|是|
--------------------------------
### 返回
``` json
{
"code": 200,
"data": {
"content": [
{
"attributeId": 26,
"attributeName": "直径",
"orderBy": 0,
"sortId": 74,
"sortName": "戒指"
},
{
"attributeId": 44,
"attributeName": "周长",
"orderBy": 0,
"sortId": 74,
"sortName": "戒指"
},
{
"attributeId": 45,
"attributeName": "周长",
"orderBy": 0,
"sortId": 74,
"sortName": "戒指"
}
],
"number": 1,
"size": 30,
"totalElements": 3,
"totalPages": 1
},
"md5": "9d7cb51564aa667059932b0e4be237e9",
"message": "success"
}
```
# 更新品类关联尺码属性接口
> 接口名: `/sortAttribute/update`
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|sortId |int|1 |品类id |是 |
|attributeId|int|2|尺码属性id|是|
|preAttributeId |int|1 |修改前尺码属性id |是 |
|orderBy|int|2|排序|否|
---------------------
### 返回
``` json
{
"code": 200,
"data": [],
"md5": "d751713988987e9331980363e24189ce",
"message": " success."
}
```
# 删除品类关联尺码属性接口
> 接口名: `/sortAttribute/delete`
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|sortId |int|1 |品类id |是 |
|attributeId|int|2|尺码属性id|是|
---------------------
### 返回
``` json
{
"code": 200,
"data": [],
"md5": "d751713988987e9331980363e24189ce",
"message": " success."
}
```
# 获取单个品类关联尺码属性接口
> 接口名: `/sortAttribute/queryBySortAttr`
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|sortId |int|1 |品类id |是 |
|attributeId|int|2|尺码属性id|是|
---------------------
### 返回
``` json
{
"code": 200,
"data": {
"attributeId": 26,
"attributeName": "直径",
"orderBy": 0,
"sortId": 74,
"sortName": "戒指"
},
"md5": "354b1dbdc27b1d285dd2fc6743906f84",
"message": "success"
}
```
... ...
# 产品管理接口服务定义
---------------------
# 添加(更新)品类接口
> 接口名: `/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|是
|page|int|1|当前第几页|否
|size|int|1|每页多少条|否
---------------------
### 返回
``` json
{
"code": 200,
"data":
"list":[
{
"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/queryProductPriceList'
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|product_skn|Number|60000050|商品的skn|
|shop_id|Number|43|店铺Id|
|brand_id|Number|43|品牌id|
|supplier_id|Number|43|供应商Id|
|is_jit|String|"N"|是否是代销不入库 Y 或者 N|
|is_auditing|Number|200|商品状态|
|stock|Number|1|有库存为1 无填写 0|
|gender|Number|1|性别 1代表男性,2代表女性 3代表通用|
|max_sort_id|Number|1|大分类的Id|
|middle_sort_id|Number|12|中分类Id|
|small_sort_id|Number|111|小分类的Id|
|page|Number|1|当前页数 从1开始|
|size|Number|10|每页显示条数,默认10|
---------------------
### 返回(备注: ("1", "男")("2", "女")("3", "通用")
``` json
{
"code": 200,
"data": {
"list": [
{
"brand_id": 175,
"brand_name": "品牌名称",
"founder": 9278,
"max_sort_id": 10,
"max_sort_name": "创意生活",
"middle_sort_id": 101,
"middle_sort_name": "文具",
"product_name": "团一复古花纹满本图案牛皮纸笔记本",
"product_pic_url": "http://img12.static.yhbimg.com/goodsimg/2011/06/24/13/02e571a64cea3ea8e734f8f0aae790fb4f.jpg?imageView/0/w/60/h/60",
"product_skn": 50000055,
"retail_price": 29,
"return_coin": 300,
"sales_price": 29,
"small_sort_id": 111,
"small_sort_name": "本子",
"supplier_id": 0,
"supplier_name":"供应商名称",
"updateTime": "2016-02-02 10:37:43",
"vip1_price": 0,
"vip2_price": 0,
"vip3_price": 0,
"vip_discount_type": 1,
"vip_price": 0
"shop_id":1,
"shop_name":"店铺名称",
"gender":"1"
"founderName":"操作人姓名"
},
{
"brand_id": 187,
"brand_name": "顽",
"founder": 9278,
"max_sort_id": 8,
"max_sort_name": "服配",
"middle_sort_id": 66,
"middle_sort_name": "配饰",
"product_name": "PLAY顽植物大战僵尸坚果墙挂饰",
"product_pic_url": "http://img10.static.yhbimg.com/goodsimg/2011/06/23/05/01bda4fc443c96aa3a2e9287c3c17be87a.jpg?imageView/0/w/60/h/60",
"product_skn": 50000056,
"retail_price": 18,
"return_coin": 0,
"sales_price": 18,
"small_sort_id": 305,
"small_sort_name": "挂饰",
"supplier_id": 0,
"supplier_name":"供应商名称",
"updateTime": "2016-02-02 10:37:43",
"vip1_price": 0,
"vip2_price": 0,
"vip3_price": 0,
"vip_discount_type": 1,
"vip_price": 0
"shop_id":1,
"shop_name":"店铺名称",
"gender":"1"
"founderName":"操作人姓名"
}
],
"page": 1,
"size": 2,
"total": 2,
"totalPage": 1
},
"md5": "9a92b3c94d9676a8089169ee46ebce4a",
"message": "Product Price List."
}
```
## 查询所有的店铺信息
> 接口名: '/ShopsRest/queryAllShops'
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
---------------------
### 返回
``` json
{
"code": 200,
"data": [
{
"checkStatus": 0,
"shopName": "得宝旗舰店",
"shopsId": 15,
"status": 0
},
{
"checkStatus": 0,
"shopName": ":CHOCOOLATEQ",
"shopsId": 16,
"status": 0
}
],
"message": "操作成功"
}
```
## 查询所有的品牌列表
> 接口名: '/erpproduct/brands/queryAllBrands'
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
---------------------
### 返回
``` json
{
"code": 200,
"data": [
{
"brandDomain": "lily",
"brandName": "lily",
"brandNameEn": "lily",
"id": 1431,
"status": 1
},
{
"brandDomain": "test",
"brandName": "test",
"brandNameCn": "",
"brandNameEn": "test",
"id": 1430,
"status": 1
}
],
"md5": "03098c8c158c8405117daadb91ed792a",
"message": "Product Brand List."
}
```
## 查询所有的供应商列表信息
> 接口名: '/supplier/supplier/queryAllSupplier'
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
---------------------
### 返回
``` json
{
"code": 200,
"data": [
{
"brandId": 0,
"supplierId": 1,
"supplierName": "10*1"
},
{
"brandId": 0,
"supplierId": 2,
"supplierName": "广派商业(上海)有限公司"
},
{
"brandId": 0,
"supplierId": 3,
"supplierName": "广州市海珠区艺柏时装经营部"
}
],
"message": "操作成功"
}
```
## 查询商品是否是JIT配置
> 接口名: '/product/queryJitConfigList'
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
---------------------
### 返回
``` json
{
"code": 200,
"data": {
"N": "非JIT",
"Y": "是JIT"
},
"md5": "47b9033a2b45f1f51739d7c8ca2b2e29",
"message": "Jit Config List."
}
```
## 查询商品是否是JIT配置
> 接口名: '/product/queryProductStatusConfigList'
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
---------------------
### 返回
``` json
{
"code": 200,
"data": {
"0": "下架",
"200": "上架"
},
"md5": "3e1f4e393d82140086f3b11342196cb6",
"message": "Status Config List."
}
```
## 查询商品库存情况的配置
> 接口名: '/product/queryProductStockConfigList'
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
---------------------
### 返回
``` json
{
"code": 200,
"data": {
"0": "无库存",
"1": "有库存"
},
"md5": "b5fdee6640106a6eff445b8181a7e96b",
"message": "Stock Config List."
}
```
## 查询商品所属 性别分类信息
> 接口名: '/product/queryGenderConfigList'
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
---------------------
### 返回
``` json
{
"code": 200,
"data": {
"1": "男",
"2": "女",
"3": "通用"
},
"md5": "454312b4aadbcd602078c175631f20ea",
"message": "Gender Config List."
}
```
## 查询所有的一级分类列表
> 接口名: '/product/queryAllMaxSortList'
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
---------------------
### 返回(备注: id 和 sortName 有用)
``` json
{
"code": 200,
"data": [
{
"booleanStatus": true,
"createTime": 0,
"gender": 3,
"id": 365,
"isHot": "N",
"orderBy": 0,
"parentId": 0,
"sortCode": "365,0,0",
"sortInitials": "潮童",
"sortLevel": 1,
"sortName": "潮童",
"status": 1,
"updateTime": 1454060643
},
{
"booleanStatus": false,
"createTime": 0,
"gender": 3,
"id": 241,
"isHot": "N",
"orderBy": 0,
"parentId": 0,
"sortCode": "241,0,0",
"sortInitials": "数码周边",
"sortLevel": 1,
"sortName": "数码周边",
"status": 0,
"updateTime": 0
}
],
"md5": "dc2b4caace98d678cf688edcdd204675",
"message": "Product Sort List."
}
```
## 根据skn获取价格信息
> 接口名: '/product/getProductPrice'
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|param|number|5000060|商品的Skn|
---------------------
### 返回 (备注 : costPrice 成本价 purchasePrice 进货价 purchaseDiscount 进货折扣 )
``` json
{
"code": 200,
"data": {
"cost_price": 0,
"founder": 9278,
"product_skn": 50000063,
"purchase_discount": 0,
"purchase_price": 0,
"retail_price": 50,
"return_coin": 9999,
"sales_price": 211.22,
"updateTime": "2016-02-03 13:33:15",
"vip1_price": 200.66,
"vip2_price": 190.1,
"vip3_price": 185.87,
"vip_discount_type": 1,
"vip_price": 9999
},
"md5": "cfb9c7b74370346f4bd55fabb7f1deae",
"message": "Product Price get success."
}
```
## 单个商品变价
> 接口名: '/product/updateProductPrice'
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|product_skn|number|5000060|商品的Skn|
|sales_price|float|22.22|销售价格|
|vip_discount_type|number|5000060|商品的Skn|
|founder|number|2262|操作人标识|
|return_coin|number|200|返回币数|
|vip_price|float|22.33|vip价格 vipDiscountType 为4时必填|
|vip1_price|float|22.33|折扣类型为5时必填|
|vip2_price|float|22.33|折扣类型为5时必填|
|vip3_price|float|22.33|折扣类型为5时必填|
---------------------
### 返回 (备注 :code 为200代表成功 )
``` json
{
"code": 200,
"data": [],
"md5": "d751713988987e9331980363e24189ce",
"message": "Product Price update success."
}
```
## 批量商品变价
> 接口名: '/product/batchUpdateProductPrice'
### 入参 例子:[{"product_skn": 50000060, "sales_price" :211.22, "vip_discount_type":1, "founder":9278, "return_coin":88, "vip_price":99},
{"product_skn": 50000063, "sales_price" :211.22, "vip_discount_type":1, "founder":9278, "return_coin":88, "vip_price":99}]
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|product_skn|number|5000060|商品的Skn|
|sales_price|float|22.22|销售价格|
|vip_discount_type|number|5000060|商品的Skn|
|founder|number|2262|操作人标识|
|return_coin|number|200|返回币数|
|vip_price|float|22.33|vip价格 vipDiscountType 为4时必填|
|vip1_price|float|22.33|折扣类型为5时必填|
|vip2_price|float|22.33|折扣类型为5时必填|
|vip3_price|float|22.33|折扣类型为5时必填|
---------------------
### 返回 (备注 :code 为200代表成功 , data表示成功记录的表格所处相对路径)
``` json
{
"code": 200,
"data": "1455604702941.xlsx",
"md5": "d751713988987e9331980363e24189ce",
"message": "Product Price update success."
}
```
## 下载文件
> 接口名: '/batch/download?path= ***'
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|path|字符串|文件链接|必填|
---------------------
### 返回
```
文件流
```
## 批量上传变价文本
> 接口名: '/batch/import'
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|file|文件|文件流|必填|
|type|字符串|price|必填|
---------------------
### 返回 (备注:failFileReason 是失败的原因, succesList成功的列表 newProductPriceBo代表表格中的新数据 oldProductPriceBo代表数据库中的旧记录 )
```
{
"code": 200,
"data": {
"failFileReason": [
"第2行:对应的skn不存在数据库中;",
"第3行:非代销商品;",
"第5行:固定折扣,填写VIP价;",
"第7行:固定折扣,填写VIP价;",
"第9行:固定折扣,填写VIP价;",
"第10行:固定折扣,填写VIP价;",
"第11行:固定折扣,填写VIP价;",
"第12行:固定折扣,填写VIP价;"
],
"succesList": [
{
"newProductPriceBo": {
"product_skn": 50000082,
"retail_price": 298,
"return_coin": 1111,
"sales_price": 22,
"vip_discount_type": 4,
"vip_price": 260
},
"oldProductPriceBo": {
"product_skn": 50000082,
"retail_price": 298,
"return_coin": 0,
"sales_price": 149,
"vip1_price": 0,
"vip2_price": 0,
"vip3_price": 0,
"vip_discount_type": 3,
"vip_price": 0
}
},
{
"newProductPriceBo": {
"product_skn": 50000082,
"retail_price": 298,
"return_coin": 1111,
"sales_price": 22,
"vip_discount_type": 4,
"vip_price": 260
},
"oldProductPriceBo": {
"product_skn": 50000082,
"retail_price": 298,
"return_coin": 0,
"sales_price": 149,
"vip1_price": 0,
"vip2_price": 0,
"vip3_price": 0,
"vip_discount_type": 3,
"vip_price": 0
}
},
{
"newProductPriceBo": {
"product_skn": 50000082,
"retail_price": 298,
"return_coin": 1111,
"sales_price": 22,
"vip_discount_type": 4,
"vip_price": 260
},
"oldProductPriceBo": {
"product_skn": 50000082,
"retail_price": 298,
"return_coin": 0,
"sales_price": 149,
"vip1_price": 0,
"vip2_price": 0,
"vip3_price": 0,
"vip_discount_type": 3,
"vip_price": 0
}
},
{
"newProductPriceBo": {
"product_skn": 50000082,
"retail_price": 298,
"return_coin": 1111,
"sales_price": 22,
"vip_discount_type": 4,
"vip_price": 260
},
"oldProductPriceBo": {
"product_skn": 50000082,
"retail_price": 298,
"return_coin": 0,
"sales_price": 149,
"vip1_price": 0,
"vip2_price": 0,
"vip3_price": 0,
"vip_discount_type": 3,
"vip_price": 0
}
}
]
},
"message": "导入成功"
}
```
\ No newline at end of file
... ...
This diff could not be displayed because it is too large.