lingmin / yohobuy-doc · Commits

Go to a project

Authored by lijian
Commit 3fc78829eb1372b88f44850b77371fcda7787c6b 2 parents 6f0d3127 b3bcf707 master ... develop patch-1 patch-2 patch-3

Merge branch 'develop' of http://git.dev.yoho.cn/platform/yohobuy-doc into develop

Inline Side-by-side
Showing 17 changed files with 2518 additions and 236 deletions
平台服务接口公共参数
======
###### 平台页面端在向平台服务发起请求时应该携带以下参数，
###### 便于后台问题定位和操作回溯
---
页面传入参数（参数通过扩展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..
平台服务接口公共参数
======
###### 平台页面端在向平台服务发起请求时应该携带以下参数，
###### 便于后台问题定位和操作回溯
---
页面传入参数（参数通过扩展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..
```
... ...
# 品牌款型系列管理接口服务定义
---------------------
# 添加品牌款型系列接口
> 接口名： `/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":"操作成功"
}
```
... ...
# 文件上传接口服务定义
# 七牛云图片上传服务接口定义
---------------------
# 添加颜色接口
# 七牛云图片上传服务接口
> 接口名： `/fileupload/upload/`
... ... @@ -9,11 +9,11 @@
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|file|file|-|颜色名称|是|
|userId|int|543883|用户id|是|
|bucket|string|smart|bucket|是|
|属性名称|类型|例子|说明
|--------|----|----|----|
|file|file|-|图片文件
|userId|string|54|用户id|
|bucket|string|yhb-img02|bucket空间，可选（默认为yhb-img01）但值只能是yhb-img01或yhb-img02|
---------------------
... ... @@ -21,9 +21,9 @@
``` json
{
"code":200,
"data" : "url", --图片URL
"message":"success"
"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": "",
“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": "",
"name":""
}
]
}
```
## 获取所有分类接口
> 接口名： 'article/getSortList'
### 入参
无
### 返回
``` json
{
"code":200,
"message":"操作成功",
"data": [
{
"id": "",
"name":""
}
]
}
```
## 编辑时资讯详情接口
> 接口名： '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|int|1432188073|定时发布时间|
---------------------
### 返回
``` json
{
"code":200,
"message":"定时发布成功！"
}
```
## 资讯获取选择选项的枚举接口
> 接口名： 'EnumListRest/getEnumList'
### 返回
``` json
{
"code":200,
"message":"请求成功",
"data": {
"genderItems": [{ //性别
"id": "",
"name": ""
}],
"publishStatusItems": [{ //发布状态
"id": "",
"name": ""
}],
"articleTypeItems": [{ //文章类型
"id": "",
"name": ""
}],
"coverImageTypeItems": [{ //封面图片类型
"id": "",
"name": ""
}],
"adsImgSizeItems": [{ //广告尺寸
"id": "",
"name": ""
}]
}
}
```
```
\ No newline at end of file
... ...
文章分类管理接口服务定义
---------------------
## 文章分类列表查询
> 接口名： 'article/sort/getList'
### 入参
无
### 返回
``` json
{
"code":200,
"message":"操作成功",
"data": {
"list": [
{
"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": "",
“parentId": "", //父分类ID
"name": "", //分类名称
"status": "", //状态,0关闭,1开启
"orderBy": "", //排序
"advertCode": "", //广告码
}
}
```
## 删除分类接口
> 接口名： 'article/sort/delSort'
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|id|intr|43|分类id|
---------------------
### 返回
``` json
{
"code":200,
"message":"删除成功！"
}
```
```
\ No newline at end of file
... ...
... ... @@ -114,6 +114,42 @@
"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."
}
... ... @@ -233,7 +269,7 @@
"all": "2"
},
"md5": "f29559d3d32c56f9cd94c892128cbae8",
"message": "deleteLimitCode success."
"message": "getLimitCodeCountByStatus success."
}
```
... ...
... ... @@ -36,8 +36,8 @@
|属性名称|类型|例子|说明|是否必填|
|-------|----|----|----|-------|
|sortId |int|1 |品类id |是 |
|pageNumber|int|2|页码，默认1|是|
|pageSize|int|20|记录数，默认10|是|
|page|int|2|页码，默认1|是|
|size|int|20|记录数，默认10|是|
--------------------------------
### 返回
... ...
... ... @@ -22,16 +22,16 @@
|size|Number|10|每页显示条数，默认10|
---------------------
### 返回
### 返回(备注： ("1", "男")("2", "女")("3", "通用")
``` json
{
"code": 200,
"data": {
"content": [
"list": [
{
"brand_id": 175,
"brand_name": "团一",
"brand_name": "品牌名称",
"founder": 9278,
"max_sort_id": 10,
"max_sort_name": "创意生活",
... ... @@ -46,12 +46,17 @@
"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
"vip_price": 0，
"shop_id":1,
"shop_name":"店铺名称",
"gender":"1"，
"founderName":"操作人姓名"
},
{
"brand_id": 187,
... ... @@ -70,18 +75,23 @@
"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
"vip_price": 0，
"shop_id":1,
"shop_name":"店铺名称",
"gender":"1"，
"founderName":"操作人姓名"
}
],
"number": 1,
"page": 1,
"size": 2,
"totalElements": 2,
"totalPages": 1
"total": 2,
"totalPage": 1
},
"md5": "9a92b3c94d9676a8089169ee46ebce4a",
"message": "Product Price List."
... ... @@ -457,14 +467,156 @@
|vip3_price|float|22.33|折扣类型为5时必填|
---------------------
### 返回 (备注 ：code 为200代表成功 )
### 返回 (备注 ：code 为200代表成功 , data表示成功记录的表格所处相对路径)
``` json
{
"code": 200,
"data": [],
"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
... ...
... ... @@ -16,7 +16,7 @@
|属性名称|类型|例子|说明|
|--------|----|----|----|
|page|int|2|第几页|
|size|int|50|每页条数|
|size|int|12|每页条数|
---------------------
### 返回
... ...
# 店铺装修接口
## 保存店铺装修系信息
> POST `/ShopsDecoratorRest/saveShopsDecorator`
### 入参
```json
{
"shopsId":1,
"platform": "APP",
"templateName": "BASE",
"resources": [
{
"id":7,
"name": "shopTopBanner",
"data": {
"src": "http://img10.static.yhbimg.com/taobaocms/2016/01/25/12/0155598441256e46ec285a8ea64e762394.png",
"isShowShopName": "Y"
}
},
{
"id":8,
"name": "productDetailTopBanner",
"data": {
"src": "http://img10.static.yhbimg.com/taobaocms/2016/01/25/12/015}5598441256e46ec285a8ea64e762394.png"
}
},
{
"id":9,
"name": "oneRowTwoColImages",
"data": [
{
"position": 1,
"src": "http://img10.static.yhbimg.com/taobaocms/2016/01/25/12/0155598441256e46ec285a8ea64e762394.png",
"url": {},
"startTime": 1309514897,
"endTime": 1309514967,
"publishStatus": 0
}
]
},
{
"id":10,
"name": "hotProducts",
"data": [
50000881,
50000882,
50000883,
50000884,
50000885,
50000886,
50000887,
50000888
]
}
]
}
```
|参数名 |必填 |类型 |示例值 |描述 |
|------ |---- |---- |------ |---- |
|shopsId |是 |int |1 |店铺编号 |
|platform |否 |string |APP |平台名称 |
|templateName|否 |string |BASE |模板名称 |
|resources |否 |json | |资源 |
#### 资源描述-店铺头部横幅
|参数名 |必填 |类型 |示例值 |描述 |
|------ |---- |---- |------ |---- |
|id |否 |int |7 |资源编号 |
|name |是 |string |shopTopBanner |资源名称 |
|data |是 |json | |资源内容 |
|src |是 |string |http://img10.static.yhbimg.com/taobaocms/2016/01/25/12/0155598441256e46ec285a8ea64e762394.png|店铺头部横幅图片|
|isShowShopName |否 |string |Y |是否显示店铺名称|
#### 资源描述-商品详情头部横幅
|参数名 |必填 |类型 |示例值 |描述 |
|------ |---- |---- |------ |---- |
|id |否 |int |8 |资源编号 |
|name |是 |string |productDetailTopBanner |资源名称 |
|data |是 |json | |资源内容 |
|src |是 |string |http://img10.static.yhbimg.com/taobaocms/2016/01/25/12/0155598441256e46ec285a8ea64e762394.png|商品详情头部横幅图片|
### 返回
```json
{
"code": 200,
"message": "操作成功",
"data":{
"id":1,
"platform":"APP",
"templateName":"BASE",
"resources":[]
}
}
```
|参数名 |必填 |类型 |示例值 |描述 |
|------ |---- |---- |------ |---- |
|id |是 |int |1 |店铺装修编号 |
|platform |是 |string |APP |平台名称 |
|templateName|是 |string |BASE |模板名称 |
|resources |是 |json | |资源 |
## 查询店铺装修信息
> POST `/ShopsDecoratorRest/findShopsDecorator`
### 入参
```json
{
"page":1,
"size":20,
"shopsId":1,
"checkStatus": 100,
"supplierId": 1,
"brandId": 1
}
```
|参数名 |必填 |类型 |示例值 |描述 |
|------ |---- |---- |------ |---- |
|page |否 |int |1 |页数 |
|size |否 |int |20 |每页大小 |
|shopsId |否 |int |1 |店铺编号 |
|checkStatus |否 |int |100 |审核状态 |
|supplierId |否 |int |1 |供应商编号 |
|brandId |否 |int |1 |品牌编号 |
### 返回
```json
{
"code": 200,
"message": "操作成功",
"data":{
"page":1,
"size":20,
"total":101,
"totalPage":6,
"list":[{
"id":1,
"shopsId":1,
"shopsName":"T.U.K",
"checkStatus":100,
"createTime":1454551897,
"updateTime":1454551897,
"status":1,
"brands":[{
"id":517,
"brandName":"T.U.K",
"brandNameCn":"",
"brandNameEn":"T.U.K"
}]
}]
}
}
```
|参数名 |必填 |类型 |示例值 |描述 |
|------ |---- |---- |------ |---- |
|page |是 |int |1 |页数 |
|size |是 |int |20 |每页大小 |
|total |是 |int |1 |总记录数 |
|totalPage |是 |int |100 |总页数 |
|list |是 |json | |店铺装修信息 |
|id |否 |int |1 |店铺装修编号 |
|shopsId |是 |int |1 |店铺编号 |
|shopsName |是 |string |T.U.K |店铺名称 |
|checkStatus |否 |int |100 |店铺装修审核状态|
|createTime |否 |int |1454551897 |店铺创建时间 |
|updateTime |否 |int |1454551897 |店铺更新时间 |
|status |否 |int |1 |店铺装修状态 |
|brands |否 |json | |品牌信息 |
|id |否 |int |517 |品牌编号 |
|brandName |否 |string |T.U.K |品牌名称 |
|brandNameCn |否 |string | |品牌中文名称 |
|brandNameEn |否 |string |T.U.K |品牌英文名称 |
## 查询店铺装修详细信息
> POST `/ShopsDecoratorRest/findShopsDecoratorDetail`
### 入参
```json
{
"id":2,
"platform": "APP",
"templateName": "BASE"
}
```
|参数名 |必填 |类型 |示例值 |描述 |
|------ |---- |---- |------ |---- |
|id |是 |int |1 |页数 |
|platform |否 |string |APP |平台名称（默认：APP） |
|templateName|否 |string |BASE |模板名称（默认：启用的模板）|
### 返回
```json
{
"code": 200,
"message": "操作成功",
"data":{
"id":1,
"platform":"APP",
"templateName":"BASE",
"resources":[]
}
}
```
|参数名 |必填 |类型 |示例值 |描述 |
|------ |---- |---- |------ |---- |
|id |是 |int |1 |店铺装修编号 |
|platform |是 |string |APP |平台名称 |
|templateName|是 |string |BASE |模板名称 |
|resources |是 |json | |资源 |
\ No newline at end of file
... ...
... ... @@ -34,8 +34,8 @@
-------------------------
|属性名称|类型|例子|说明|是否必填|
|-------|----|----|----|-------|
|curPage|int|1|页码|是|
|pageSize|int|10|条数|是|
|page|int|1|页码|是|
|size|int|10|条数|是|
--------------------------------
### 返回
... ... @@ -157,9 +157,9 @@
"code": 200,
"data": [
{
"attributeName": "衣长",
"id": 60,
"orderBy": 0
"text": "衣长",
"id": 60
}
],
"md5": "dfc645ecb0c66c8d4771dd2a749047e8",
... ...
... ... @@ -72,8 +72,8 @@
-------------------------
|属性名称|类型|例子|说明|是否必填|
|-------|----|----|----|-------|
|curPage|int|1|页码|是|
|pageSize|int|10|条数|是|
|page|int|1|页码|是|
|size|int|10|条数|是|
--------------------------------
### 返回
... ... @@ -169,4 +169,45 @@
}
```
# 根据名称获取尺码接口
> 接口名： `/product/querySizeByNameForSelect/`
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|
|--------|----|----|----|--------|
|idName |String |码 |名称 |否|
---------------------
### 返回
``` json
{
"code": 200,
"data": {
{
"id": "2",
"text": "10#"
},
{
"id": "3",
"text": "10.5码"
},
{
"id": "4",
"text": "10000"
},
{
"id": "5",
"text": "105"
}
},
"md5": "dfc645ecb0c66c8d4771dd2a749047e8",
"message": "success"
}
```
... ...
... ... @@ -35,8 +35,9 @@
-------------------------
|属性名称|类型|例子|说明|是否必填|
|sortId|int |1 |分类id|是|
|-------|----|----|----|-------|
|sortId|int |1 |分类id|是|
--------------------------------
### 返回
... ...
供应商接口服务定义
---------------------
#### 创建供应商页接口
> 接口名： ''
##### 入参
|属性名称|类型|例子|说明|
|--------|----|----|----|
|id|int|10|id|
|status|int|100|供应商状态(100:暂存,200:审核中,300:通过, 900: 驳回)|
|timeSort|string|asc,desc|排序(asc:正序, desc:倒序)|
#### 返回
``` json
{
"code": 200,
"message": "请求成功",
"dade":[{
//id
"id":10,
//供应商名称
"supplierName":"南京新与力广告传媒",
// 更新时间
"updateTime":"2016-01-14 16:30:23",
// 供应商状态
"status":100,
// 是否冻结
"isFreeze":"Y",
// 最近操作
"operations":"1"
}]
}
```
#### 供应商列表页接口
> 接口名： ''
##### 入参
|属性名称|类型|例子|说明|
|--------|----|----|----|
|supplierId|int|10|供应商名称|
|status|int|100|供应商状态(100:暂存,200:审核中,300:通过, 900: 驳回)|
|isFreeze|string|Y,N|生效状态(Y:已冻结, N:生效中)|
##### 返回
> 同创建供应商页接口
#### 供应商审核列表页接口
> 接口名： ''
##### 入参
|属性名称|类型|例子|说明|
|--------|----|----|----|
|supplierId|int|100|供应商名称|
##### 返回
> 同创建供应商页接口
#### 供应商新增编辑接口
> 接口名： ''
##### 入参
|属性名称|类型|例子|说明|
|--------|----|----|----|
|status|int|100|供应商状态(100:暂存,200:提交审核)|
|supplierName|String|nike|供应商名称|
|supplierCode|String|123456|营业执照号|
|foundTime|Date|2012-12-12|成立日期|
|beginOperateTime|Date|2012-12-12|经营开始时间|
|endOperateTime|Date|2012-12-12|经营结束时间|
|registeredAddress|string|澳门|公司注册地址|
|legalPerson|string|张三|法人代表姓名|
|registeredCapital|string|nike|注册资本|
|contactPhone|string|nike|公司联系电话|
|contactAddress|string|xx省xx市|公司联系地址|
||||必填项,选填项不在其中|
##### 返回
``` json
{
"code": 200,
"message": "保存成功",
}
```
#### 供应商审核接口
> 接口名： ''
##### 入参
|属性名称|类型|例子|说明|
|--------|----|----|----|
|supplierId|int|10|供应商名称|
|status|int|100|供应商状态(100:暂存,200:审核中,300:通过, 900: 驳回)|
##### 返回
``` json
{
"code": 200,
"message": "提交成功",
}
```
#### 供应商冻结解冻接口
> 接口名： ''
##### 入参
|属性名称|类型|例子|说明|
|--------|----|----|----|
|supplierId|int|10|供应商名称|
|isFreeze|string|Y,N|生效状态(Y:已冻结, N:生效中)|
##### 返回
``` json
{
"code": 200,
"message": "修改成功",
}
```
##### 查看供应商接口
> 接口名： ''
##### 入参
|属性名称|类型|例子|说明|
|--------|----|----|----|
|id|int|123|供应商信息查询|
##### 返回
``` json
{
//公司名称
"supplierName":"南京新与力广告传媒",
// 营业执照号
"supplierCode":"1234567890",
// 成立日期
"foundTime":"2015-1-1",
// 营业期限-start
"beginOperateTime":"2015-1-1",
// 营业期限-end
"endOperateTime":"2020-1-1",
// 注册所在地
"registeredAddress":"中华民国",
// 法人代表姓名
"legalPerson":"XXX",
// 法人身份证电子版
"legalIdentityCard":"https://www.baidu.com/img/baidu_jgylogo3.gif",
// 注册资本
"registeredCapital":"1W",
// 营业执照电子版
"":"https://www.baidu.com/img/baidu_jgylogo3.gif",
// 经营许可证
"":"https://www.baidu.com/img/baidu_jgylogo3.gif",
// 税务登记证
"":"https://www.baidu.com/img/baidu_jgylogo3.gif",
// 经营范围
"businessRange":"小吃",
// 公司联系电话
"contactPhone":"00100100",
// 公司联系地址
"contactAddress":"XX省XX市XXX街道10号",
// 联系人
"linkman":"XXX",
// 联系电话
"phone":"001001001001",
// 传真
"fax":"00100100",
// 邮件地址
"email":"XXX@qq.com",
// 网址
"url":"www.google.cn",
// 开户行
"bankName":"ICBC",
// 开户账号
"bankAccount":"001010001001"
}
供应商接口服务定义
---------------------
#### 创建供应商页接口
> 接口名： '/supplier/supplier/getCreateSupplierList'
##### 入参
|属性名称|类型|例子|说明|
|--------|----|----|----|
|id|int|10|id|
|status|int|100|供应商状态(100:暂存,200:审核中,300:通过, 900: 驳回)|
|timeSort|string|asc,desc|排序(asc:正序, desc:倒序)|
#### 返回
``` json
{
"code": 200,
"message": "请求成功",
"dade":[{
//id
"id":10,
//供应商名称
"supplierName":"南京新与力广告传媒",
// 更新时间
"updateTime":"2016-01-14 16:30:23",
// 供应商状态
"status":100,
// 是否冻结
"isFreeze":"Y",
// 最近操作
"operations":"1"
}]
}
```
#### 供应商列表页接口
> 接口名： '/supplier/supplier/getManageSupplierList'
##### 入参
|属性名称|类型|例子|说明|
|--------|----|----|----|
|id|int|10|id|
|status|int|100|供应商状态(100:暂存,200:审核中,300:通过, 900: 驳回)|
|isFreeze|string|Y,N|生效状态(Y:已冻结, N:生效中)|
##### 返回
> 同创建供应商页接口
#### 供应商审核列表页接口
> 接口名： '/supplier/supplier/getAuditSupplierList'
##### 入参
|属性名称|类型|例子|说明|
|--------|----|----|----|
|id|int|10|id|
##### 返回
> 同创建供应商页接口
#### 供应商新增编辑接口
> 接口名： '/supplier/supplier/addSupplier'
##### 入参
|属性名称|类型|例子|说明|
|--------|----|----|----|
|status|int|100|供应商状态(100:暂存,200:提交审核)|
|supplierName|String|nike|供应商名称|
|supplierCode|String|123456|营业执照号|
|foundTime|Date|2012-12-12|成立日期|
|beginOperateTime|Date|2012-12-12|经营开始时间|
|endOperateTime|Date|2012-12-12|经营结束时间|
|registeredAddress|string|澳门|公司注册地址|
|legalPerson|string|张三|法人代表姓名|
|registeredCapital|string|nike|注册资本|
|contactPhone|string|nike|公司联系电话|
|contactAddress|string|xx省xx市|公司联系地址|
||||必填项,选填项不在其中|
##### 返回
``` json
{
"code": 200,
"message": "保存成功",
}
```
#### 供应商审核接口
> 接口名： '/supplier/supplier/updateSupplier'
##### 入参
|属性名称|类型|例子|说明|
|--------|----|----|----|
|id|int|10|供应商名称|
|status|int|100|供应商状态(100:暂存,200:审核中,300:通过, 900: 驳回)|
##### 返回
``` json
{
"code": 200,
"message": "提交成功",
}
```
#### 供应商冻结解冻接口
> 接口名： '/supplier/supplier/updateSupplier'
##### 入参
|属性名称|类型|例子|说明|
|--------|----|----|----|
|id|int|10|供应商名称|
|isFreeze|string|Y,N|生效状态(Y:已冻结, N:生效中)|
##### 返回
``` json
{
"code": 200,
"message": "修改成功",
}
```
##### 查看供应商接口
> 接口名： '/supplier/supplier/getSupplier'
##### 入参
|属性名称|类型|例子|说明|
|--------|----|----|----|
|id|int|123|id|
##### 返回
``` json
{
//公司名称
"supplierName":"南京新与力广告传媒",
// 营业执照号
"supplierCode":"1234567890",
// 成立日期
"foundTime":"2015-1-1",
// 营业期限-start
"beginOperateTime":"2015-1-1",
// 营业期限-end
"endOperateTime":"2020-1-1",
// 注册所在地
"registeredAddress":"中华民国",
// 法人代表姓名
"legalPerson":"XXX",
// 法人身份证电子版
"legalIdentityCard":"https://www.baidu.com/img/baidu_jgylogo3.gif",
// 注册资本
"registeredCapital":"1W",
// 营业执照电子版
"":"https://www.baidu.com/img/baidu_jgylogo3.gif",
// 经营许可证
"":"https://www.baidu.com/img/baidu_jgylogo3.gif",
// 税务登记证
"":"https://www.baidu.com/img/baidu_jgylogo3.gif",
// 经营范围
"businessRange":"小吃",
// 公司联系电话
"contactPhone":"00100100",
// 公司联系地址
"contactAddress":"XX省XX市XXX街道10号",
// 联系人
"linkman":"XXX",
// 联系电话
"phone":"001001001001",
// 传真
"fax":"00100100",
// 邮件地址
"email":"XXX@qq.com",
// 网址
"url":"www.google.cn",
// 开户行
"bankName":"ICBC",
// 开户账号
"bankAccount":"001010001001"
}
```
\ No newline at end of file
... ...