商品搜索
接口路径
POST /api/search/recall
请求方法
POST
频率限制
详见套餐说明
请求体
请求体为json对象
| 参数名 | 参数类型 | 备注 |
|---|---|---|
brand | string | 品牌名称 |
keyword | string | 搜索关键词,例如 "大衣" |
pageNum | integer | 当前页码,从 1 开始 |
pageSize | integer | 每页显示的商品数量,例如 10 |
filters | array | 筛选聚合条件 |
filters[].dimensionName | string | 筛选名称 |
filters[].tagNames | array | 筛选标签名称 |
startPrice | BigDecimal | 筛选开始价格 |
endPrice | BigDecimal | 筛选结束价格 |
sort | string | 默认为分数排序。score=默认排序,priceAsc=价格从低到高,priceDesc=价格从高到低,sales=销量从高到低,newProduct=新品标记从大到小,releaseDate=上架时间从近到远 |
output | integer | 默认为商品对象,1=商品对象,2=spu id,3=sku id |
请求体示例
{
"brand": "",
"keyword": "大衣",
"pageNum": 1,
"pageSize": 10,
"filters": [
{
"dimensionName": "size",
"tagNames": [
"XL",
"XXL"
]
}
]
}
响应体
| 参数名 | 参数类型 | 备注 |
|---|---|---|
code | integer | 状态码,200 表示成功 |
msg | string | 返回消息,成功时为 null |
data | object | 返回的数据 |
data.total | integer | 商品总数 |
data.rows | array | 商品列表 |
data.rows[].brand | string | 商品品牌 |
data.rows[].productId | string | 商品聚合 ID |
data.rows[].productName | string | 商品名称 |
data.rows[].mainImage | string | 商品白底图 |
data.rows[].imageUrls | array | 商品图片 URL 列表 |
data.rows[].description | string | 商品描述 |
data.rows[].gender | string | 商品适用性别 |
data.rows[].series | string | 商品系列 |
data.rows[].category | string | 商品分类 |
data.rows[].style | string | 商品款式 |
data.rows[].color | string | 商品颜色 |
data.rows[].size | string | 商品尺寸 |
data.rows[].material | string | 商品材质 |
data.rows[].design | string | 商品设计 |
data.rows[].price | number | 商品价格 |
data.rows[].discountPrice | number | 商品折扣价 |
data.rows[].status | integer | 商品状态 |
data.rows[].isNew | string | 是否为新商品 |
data.rows[].releaseDate | string | 商品发布日期 |
data.rows[].attr1 | string | 自定义冗余字段 |
data.rows[].attr2 | string | 自定义冗余字段 |
data.rows[].attr3 | string | 自定义冗余字段 |
data.rows[].attr4 | string | 自定义冗余字段 |
data.rows[].attr5 | string | 自定义冗余字段 |
data.rows[].attr6 | string | 自定义冗余字段 |
data.rows[].attr7 | string | 自定义冗余字段 |
data.rows[].attr8 | string | 自定义冗余字段 |
data.rows[].attr9 | string | 自定义冗余字段 |
data.rows[].attr10 | string | 自定义冗余字段 |
data.rows[].colors | Array | 颜色数组对象 |
data.rows[].colors[].colorId | String | 颜色级别的商品id,如果没有可以不填 |
data.rows[].colors[].color | String | 颜色,可用于颜色筛选 |
data.rows[].colors[].rbga | String | 颜色RGBA |
data.rows[].colors[].mainImage | String | 商品白底图 |
data.rows[].colors[].images | Array | 商品图片 URL 列表 |
data.rows[].colors[].price | BigDecimal | 颜色级别的商品价格 |
data.rows[].colors[].attr1 | String | 自定义冗余字段,会在搜索结果中返回,可用于颜色筛选 |
data.rows[].colors[].attr2 | String | 自定义冗余字段,会在搜索结果中返回,可用于颜色筛选 |
data.rows[].colors[].attr3 | String | 自定义冗余字段,会在搜索结果中返回,可用于颜色筛选 |
data.rows[].colors[].sizes | Array | 尺码数组对象 |
data.rows[].colors[].sizes[].sizeId | String | 尺码级别的商品id,如果没有可以不填 |
data.rows[].colors[].sizes[].size | String | 尺码 |
data.rows[].colors[].sizes[].price | BigDecimal | 颜色级别的商品价格 |
data.rows[].colors[].sizes[].attr1 | String | 自定义冗余字段,会在搜索结果中返回,可用于尺码筛选 |
data.rows[].colors[].sizes[].attr2 | String | 自定义冗余字段,会在搜索结果中返回,可用于尺码筛选 |
data.rows[].colors[].sizes[].attr3 | String | 自定义冗余字段,会在搜索结果中返回,可用于尺码筛选 |
data.rows[].mainCategory | string | 商品主分类 |
data.rows[].categories | array | 商品分类列表 |
data.rows[].englishTags | array | 商品英文标签列表 |
data.rows[].tags | array | 商品标签列表 |
data.rows[].score | number | 商品评分 |
data.recommendList | array | 推荐商品列表,结构与rows中的对象相同 |
data.spellCorrection | array | 拼写纠正 |
data.aggregation | array | 聚合数据 |
data.minPrice | BigDecimal | 价格范围筛选最小值 |
data.maxPrice | BigDecimal | 价格范围筛选最大值 |
data.aggregation[].dimensionName | string | 标签维度 |
data.aggregation[].items | array | 标签数组 |
data.aggregation[].items[].tagName | string | 标签名称 |
data.aggregation[].items[].count | number | 商品数量 |