跳到主要内容

商品搜索

接口路径

POST /api/search/recall

请求方法

POST

频率限制

详见套餐说明

请求体

请求体为json对象

参数名参数类型备注
brandstring品牌名称
keywordstring搜索关键词,例如 "大衣"
pageNuminteger当前页码,从 1 开始
pageSizeinteger每页显示的商品数量,例如 10
filtersarray筛选聚合条件
filters[].dimensionNamestring筛选名称
filters[].tagNamesarray筛选标签名称
startPriceBigDecimal筛选开始价格
endPriceBigDecimal筛选结束价格
sortstring默认为分数排序。score=默认排序,priceAsc=价格从低到高,priceDesc=价格从高到低,sales=销量从高到低,newProduct=新品标记从大到小,releaseDate=上架时间从近到远
outputinteger默认为商品对象,1=商品对象,2=spu id,3=sku id

请求体示例

{
"brand": "",
"keyword": "大衣",
"pageNum": 1,
"pageSize": 10,
"filters": [
{
"dimensionName": "size",
"tagNames": [
"XL",
"XXL"
]
}
]
}

响应体

参数名参数类型备注
codeinteger状态码,200 表示成功
msgstring返回消息,成功时为 null
dataobject返回的数据
data.totalinteger商品总数
data.rowsarray商品列表
data.rows[].brandstring商品品牌
data.rows[].productIdstring商品聚合 ID
data.rows[].productNamestring商品名称
data.rows[].mainImagestring商品白底图
data.rows[].imageUrlsarray商品图片 URL 列表
data.rows[].descriptionstring商品描述
data.rows[].genderstring商品适用性别
data.rows[].seriesstring商品系列
data.rows[].categorystring商品分类
data.rows[].stylestring商品款式
data.rows[].colorstring商品颜色
data.rows[].sizestring商品尺寸
data.rows[].materialstring商品材质
data.rows[].designstring商品设计
data.rows[].pricenumber商品价格
data.rows[].discountPricenumber商品折扣价
data.rows[].statusinteger商品状态
data.rows[].isNewstring是否为新商品
data.rows[].releaseDatestring商品发布日期
data.rows[].attr1string自定义冗余字段
data.rows[].attr2string自定义冗余字段
data.rows[].attr3string自定义冗余字段
data.rows[].attr4string自定义冗余字段
data.rows[].attr5string自定义冗余字段
data.rows[].attr6string自定义冗余字段
data.rows[].attr7string自定义冗余字段
data.rows[].attr8string自定义冗余字段
data.rows[].attr9string自定义冗余字段
data.rows[].attr10string自定义冗余字段
data.rows[].colorsArray颜色数组对象
data.rows[].colors[].colorIdString颜色级别的商品id,如果没有可以不填
data.rows[].colors[].colorString颜色,可用于颜色筛选
data.rows[].colors[].rbgaString颜色RGBA
data.rows[].colors[].mainImageString商品白底图
data.rows[].colors[].imagesArray商品图片 URL 列表
data.rows[].colors[].priceBigDecimal颜色级别的商品价格
data.rows[].colors[].attr1String自定义冗余字段,会在搜索结果中返回,可用于颜色筛选
data.rows[].colors[].attr2String自定义冗余字段,会在搜索结果中返回,可用于颜色筛选
data.rows[].colors[].attr3String自定义冗余字段,会在搜索结果中返回,可用于颜色筛选
data.rows[].colors[].sizesArray尺码数组对象
data.rows[].colors[].sizes[].sizeIdString尺码级别的商品id,如果没有可以不填
data.rows[].colors[].sizes[].sizeString尺码
data.rows[].colors[].sizes[].priceBigDecimal颜色级别的商品价格
data.rows[].colors[].sizes[].attr1String自定义冗余字段,会在搜索结果中返回,可用于尺码筛选
data.rows[].colors[].sizes[].attr2String自定义冗余字段,会在搜索结果中返回,可用于尺码筛选
data.rows[].colors[].sizes[].attr3String自定义冗余字段,会在搜索结果中返回,可用于尺码筛选
data.rows[].mainCategorystring商品主分类
data.rows[].categoriesarray商品分类列表
data.rows[].englishTagsarray商品英文标签列表
data.rows[].tagsarray商品标签列表
data.rows[].scorenumber商品评分
data.recommendListarray推荐商品列表,结构与rows中的对象相同
data.spellCorrectionarray拼写纠正
data.aggregationarray聚合数据
data.minPriceBigDecimal价格范围筛选最小值
data.maxPriceBigDecimal价格范围筛选最大值
data.aggregation[].dimensionNamestring标签维度
data.aggregation[].itemsarray标签数组
data.aggregation[].items[].tagNamestring标签名称
data.aggregation[].items[].countnumber商品数量