Export to GitHub

winxuan-api - APIDocumentVersionOne_search.wiki


新版文轩API文档首页 >> 搜索模块


搜索模块

此模块提供与搜索相关的功能,本接口只需应用授权,关于应用授权请查看应用授权章节.

  • API清单
    1. 商品关键字搜索
    2. 按关键字获取热搜商品或搜索建议
    3. 【新】卖家店铺内搜索
    4. 【新】搜索结果进行分类

商品关键字搜索

本接口只需应用授权,关于应用授权请查看应用授权章节.

接口地址

GET http://api.winxuan.com/v1/search

请求参数

|参数|描述|必选|字段类型|备注| |:-----|:-----|:-----|:-------|:-----| |keyword|关键字 | |String |可以是ISBN,出版社,作者名.默认为文轩网业务规则展示| |categoryId|类别搜索 | |Long |分类搜索,文轩文类( 店铺类搜索,查看店铺类搜索接口.http://api.winxuan.com/v1/search/category)| |sort |排序字段 | |Int |参见排序字段码表| |minPrice|最低价格 | |Int |minPrice=10(整数,大于0)| |maxPrice|最高价格 | |Int |maxPrice=100(整数,大于0)| |minDiscount|最低折扣 | |Float |minDiscount=0.5(保留一位小数)| |maxDiscount|最高折扣 | |Float |maxDiscount=0.7(保留一位小数)| |minRank|评分 | |Int |取值范围(1-5)| |name |商品名称 | |String | | |manufacturer|出版社 | |String | | |author|作者 | |String | | |isbn |国际标准书号| |String | | |yBegin|起始年份 | |int | | |yEnd |结束年份 | |int | | |mBegin|起始月份 | |int | | |mEnd |结束月份 | |int | | |hasStock|库存 | |boolean | |

其它参数请参看通用参数说明

排序字段码表

||含义| |:----|:-----| |1 |价格从低到高| |2 |价格从高到低| |3 |折扣从低到高| |6 |出版时间从近到远| |7 |总销量 | |8 |评分 | |9 |人气 | |12 |最后上架时间|

返回值

{ "productList" :[{ "id":"10999909", "name":"世界上最伟大的推销员(插图本珍藏版)", "manufacturer":"世界知识出版社", "listPrice":16.8, //定价 "salePrice":10.2, //销售价格 "availableQuantity":234, //可用量 "weekSale":323, "monthSale":1922, "onShelf":true, //上架 "rank":5.0, //评分
"hasCover":true, //是否有封面 "coverPath":"http://img1.winxuancdn.com/9909/10999909_3.jpg", //封面路径 "monthVisit":64, "monthComment":0, "content":"多年以后,奥雷连诺上校站在行刑队面前...", "author":"加西亚•马尔克斯" }, … ], "pagination":{ "pageSize":20, //每页的记录数 "count":123456, //记录总数 "pageCount":123 //页数 "currentPage":2 //当前页数 }, "state":{ "code" : 0, "msg" : "", "detail":""
} }

按关键字获取热搜商品或搜索建议

本接口只需应用授权,关于应用授权请查看应用授权章节

接口地址

GET http://api.winxuan.com/v1/search

请求参数

|参数|描述|必选|字段类型|备注| |:-----|:-----|:-----|:-------|:-----| |size |结果数 | |Int |默认值为3,最大为10| |type |请求类型 |√ |String |取值范围:hot/suggestion hot:热搜 suggestion:搜索建议| |keyword|关键字 | |String |如果type是hot则为空,否则为必选项|

其它参数请参看通用参数说明

返回值

  • 当type="hot"时 { "hot": ["张爱玲","寻找弗洛伊德", "地图"], "state":{ "code":0, //返回状态码,见错误码表,0表示没有错误 "msg":"", //返回的消息 "detail":"" //返回的消息详情 } }
  • 当type="suggestion"时 { "suggestionList":[{"hits":6,"name":"1Q84"},…], //搜索建议列表 "state":{
    "code":0, //状态返回信息
    "msg" :"", "detail" :"" } }

卖家店铺内搜索

本接口只需应用授权,关于应用授权请查看应用授权章节

接口地址

GET http://api.winxuan.com/v1/search/shop

请求参数

|参数|描述|必选|字段类型|备注| |:-----|:-----|:-----|:-------|:-----| |shopId|店铺id |√ |Long |调用 获取卖家信息列表接口,选择店铺id | |categoryId|分类id | |Long |分类id(默认为所有分类),调用卖家店铺信息接口获取相关分类| |minPrice|最低价格 | |Int |minPrice=10(整数,大于0)| |maxPrice|最高价格 | |Int |maxPrice=100(整数,大于0)| |minDiscount|最低折扣 | |Float |minDiscount=0.5(保留一位小数)| |maxDiscount|最高折扣 | |Float |maxDiscount=0.7(保留一位小数)| |minRank|评分 | |Int |取值范围(1-5)|

其它参数请参看通用参数说明

返回值

{ "productList": [{ "hasCover": true,//是否有图片 "salePrice": 42,//售价 "monthComment": 0, "weekSale": 0,//周销量 "onShelf": false,//是否商检 "coverPath": "http:img0.winxuancdn.com310411713104_11.jpg",//封面地址 "listPrice": 58,//标价 "availableQuantity": 0,//可用量 "id": "11713104", "rank": 4,//评分 "monthVisit": 1,//月点击 "manufacturer": "昆仑山",//生产商 "name": "@昆仑山和田玉枣四星500G",//商品名称 "monthSale": 0//月销量 }], "state": { "detail": "", "code": 0, "msg": "" } }

搜索结果进行分类

本接口只需应用授权,关于应用授权请查看应用授权章节

接口地址

GET http://api.winxuan.com/v1/search/category

请求参数

|参数|描述|必选|字段类型|备注| |:-----|:-----|:-----|:-------|:-----| |keyword|关键字 | |String |可以是ISBN,出版社,作者名.默认为文轩网业务规则展示| |categoryId|类别搜索 | |Long |分类搜索,文轩文类( 店铺类搜索,查看店铺类搜索接口)| |sort |排序字段 | |Int |参见排序字段码表| |minPrice|最低价格 | |Int |minPrice=10(整数,大于0)| |maxPrice|最高价格 | |Int |maxPrice=100(整数,大于0)| |minDiscount|最低折扣 | |Float |minDiscount=0.5(保留一位小数)| |maxDiscount|最高折扣 | |Float |maxDiscount=0.7(保留一位小数)| |minRank|评分 | |Int |取值范围(1-5)|

返回值

{ "categoryList": [{ "id": 1, "count": 269, "name": "图书", "parent": null, "childrenList": [{ "id": 1042, "count": 7, "name": "小说" }, { "id": 1720, "count": 2, "name": "文学" }, { "id": 3085, "count": 14, "name": "管理" }, { "id": 1088, "count": 7, "name": "少儿" }, { "id": 959, "count": 1, "name": "家庭与育儿" }, { "id": 249, "count": 1, "name": "励志与成功" }, { "id": 4098, "count": 74, "name": "计算机与互联网" }, { "id": 2, "count": 1, "name": "传记" }, { "id": 1964, "count": 2, "name": "时尚" }, { "id": 1333, "count": 1, "name": "心理学" }, { "id": 895, "count": 13, "name": "家居休闲" }, { "id": 232, "count": 4, "name": "动漫与绘本" }, { "id": 2571, "count": 173, "name": "科技" }, { "id": 559, "count": 1, "name": "哲学" }, { "id": 2101, "count": 2, "name": "法律" }, { "id": 804, "count": 9, "name": "娱乐" }, { "id": 123, "count": 3, "name": "健身与保健" }, { "id": 315, "count": 3, "name": "医学" }, { "id": 3863, "count": 6, "name": "英语与其他外语" }, { "id": 3652, "count": 9, "name": "艺术" }, { "id": 4396, "count": 1, "name": "辞典与工具书" }, { "id": 1869, "count": 1, "name": "新闻出版/图书馆/档案学" }, { "id": 42, "count": 8, "name": "体育" }, { "id": 1413, "count": 17, "name": "教材教辅与参考书" }, { "id": 8317, "count": 6, "name": "社会科学" }, { "id": 3438, "count": 2, "name": "考试" }, { "id": 2459, "count": 1, "name": "科学与自然" }] }, { "id": 7786, "count": 8, "name": "音像", "parent": null, "children": [] }, { "id": 7787, "count": 162, "name": "百货", "parent": null, "children": [] }], "state": { "detail": "", "code": 0, "msg": "" } }


新版文轩API文档首页 >> 搜索模块