本页内容
1. 接口描述 #
接口URL：https://open.datastory.com.cn/api/datastory.ecommerce.spuCommdodity.all
请求方式：POST
描述：通过该接口可查询标品知识码表对应版本号的标品知识数据
2. 输入参数 #
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 默认值 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|---|
| appkey | 否 | string | "predeploy" | 权限校验标识 | |
| filters | 是 | RequestSpuCommodityFilters | (见接口示例) | 查询过滤条件 | |
| openStrategy | 否 | boolean | false | 是否接受缓存 |
3. 输出参数 #
| 参数名称 | 必选 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|
| code | 否 | integer | 0 | 返回状态码，内部定义 |
| data | 否 | ResponseData | (见接口示例) | 返回数据结果，包含meta、dataset |
| message | 否 | string | "接口返回成功！" | 接口返回信息说明，在接口返回失败时会有 |
4. 数据结构 #
4.1 RequestSpuCommodityFilters #
| 参数名 | 必选 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|
| versionNum | 否 | string | VBPK202306007 | 标品版本号，默认不传查最新的Naja版本 |
4.2 ResponseData #
| 参数名 | 必选 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|
| dataset | 否 | ResponseDataset | (见接口请求示例) | 返回数据集，不同接口返回结果的格式不一样 |
| dorisTime | 否 | integer | "458" | 查询Doris耗时，单位毫秒 |
| meta | 否 | object | "list" | 返回数据的描述信息，主要是字段信息，非方舟接口，请忽略 |
| time | 否 | integer | "955" | 查询总耗时，单位毫秒 |
4.2.1 ResponseDataset #
| 参数名 | 必选 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|
| total | 否 | integer | "34500230" | 查询数据总量 |
| currentPage | 否 | integer | 1 | 分页查询的页码 |
| pageSize | 否 | integer | "20" | 分页查询的单页数据条数 |
| rowdata | 否 | BrandVersionVO | (见接口请求示例) | 返回数据集，不同接口返回结果的格式不一样 |
4.2.2 SpuCommodityVersionVO #
| 参数名 | 必选 | 类型 | 参数示例 | 描述 |
|---|---|---|---|---|
| spu | 否 | string | "56" | 标品展示名（业务使用这个） |
| key | 否 | string | "美妆个护" | 标品标准名（标准名） |
| id | 否 | integer | 9 | 标品id |
| brandId | 否 | integer | 9 | 品牌id |
| categoryId | 否 | integer | 9 | 品类id |
| brandName | 否 | string | 9 | 品牌名称 |
| categoryName | 否 | string | 9 | 品类名称 |
| timeToMarket | 否 | string | "2020-01-01" | 上市日期 |
| picUrl | 否 | string | "" | 标品图url |
| keywords | 否 | array | [""] | 标品别名 |
| recallWord | 否 | string | "" | 召回词 |
| recallFilterWord | 否 | string | 2 | 召回过滤词 |
| matchRule | 否 | string | "新闻公关" | 匹配规则 |
| filterRule | 否 | string | 2 | 过滤规则 |
| ruleSentenceScopeLimit | 否 | string | "" | 词距规则范围限制 |
| categoryDomains | 否 | array | ["美妆行业库"] | 行业库 |
5. 示例 #
示例1 查看标品知识数据 #
输入示例
{
"filters": {
"versionNum": "VBPK202306007"
}
}返回示例
{
"code": 20000,
"message": "接口返回成功！",
"data": {
"meta": {
"datasetType": "standard",
"schema": [
{
"name": "key",
"alias": "标品key",
"visibility": "Queryable",
"type": "string"
},
{
"name": "brandId",
"alias": "品牌id",
"visibility": "Queryable",
"type": "number"
},
{
"name": "categoryId",
"alias": "品类id",
"visibility": "Queryable",
"type": "number"
},
{
"name": "timeToMarket",
"alias": "上市日期",
"visibility": "Queryable",
"type": "string"
},
{
"name": "keyword",
"alias": "别名",
"visibility": "Queryable",
"type": "string"
},
{
"name": "spu",
"alias": "spu",
"visibility": "Queryable",
"type": "string"
},
{
"name": "brandName",
"alias": "品牌名称",
"visibility": "Queryable",
"type": "string"
},
{
"name": "categoryName",
"alias": "品类名称",
"visibility": "Queryable",
"type": "string"
},
{
"name": "picUrl",
"alias": "产品图片url",
"visibility": "Queryable",
"type": "string"
},
{
"name": "domain",
"alias": "行业库标签",
"visibility": "Queryable",
"type": "string"
},
{
"name": "id",
"alias": "标品ID",
"visibility": "Queryable",
"type": "number"
},
{
"name": "recallWord",
"alias": "recallWord",
"visibility": "Queryable",
"type": "string"
},
{
"name": "recallFilterWord",
"alias": "recallFilterWord",
"visibility": "Queryable",
"type": "string"
},
{
"name": "matchRule",
"alias": "matchRule",
"visibility": "Queryable",
"type": "string"
},
{
"name": "filterRule",
"alias": "filterRule",
"visibility": "Queryable",
"type": "string"
},
{
"name": "ruleSentenceScopeLimit",
"alias": "ruleSentenceScopeLimit",
"visibility": "Queryable",
"type": "string"
},
{
"name": "categoryDomains",
"alias": "categoryDomains",
"visibility": "Queryable",
"type": "[string]"
},
{
"name": "keywords",
"alias": "keywords",
"visibility": "Queryable",
"type": "[string]"
}
]
},
"dataset": {
"total": 91155,
"rowdata": [
{
"key": "美茜儿鸭嘴接线眉笔",
"brandId": 28622,
"categoryId": 986,
"timeToMarket": "20200101",
"spu": "美茜儿鸭嘴接线眉笔",
"brandName": "美茜儿",
"categoryName": "眉笔",
"picUrl": null,
"id": 4,
"recallWord": "",
"recallFilterWord": "",
"matchRule": "",
"filterRule": "",
"ruleSentenceScopeLimit": "",
"categoryDomains": [
"美妆系统自动"
],
"keywords": [
"美茜儿鸭嘴接线眉笔"
]
},
{
"key": "仙维娜无硅清爽去屑洗发露",
"brandId": 33208,
"categoryId": 778,
"timeToMarket": "20140101",
"spu": "仙维娜无硅清爽去屑洗发露",
"brandName": "仙维娜",
"categoryName": "洗发水",
"picUrl": null,
"id": 8,
"recallWord": "",
"recallFilterWord": "",
"matchRule": "",
"filterRule": "",
"ruleSentenceScopeLimit": "",
"categoryDomains": [
"美妆系统自动"
],
"keywords": [
"仙维娜丝质顺滑去屑洗发露",
"仙维娜无硅清爽去屑洗发露"
]
},
{
"key": "卓尔诗婷雪肌美白精华乳霜",
"brandId": 5628,
"categoryId": 692,
"timeToMarket": "20190101",
"spu": "卓尔诗婷雪肌美白精华乳霜",
"brandName": "卓尔诗婷",
"categoryName": "身体乳",
"picUrl": "https://img.alicdn.com/imgextra/i1/776843310/O1CN012NG5Ok1aK1j3WjTeo_!!0-item_pic.jpg",
"id": 16,
"recallWord": "卓尔诗婷祛斑霜",
"recallFilterWord": "",
"matchRule": "",
"filterRule": "",
"ruleSentenceScopeLimit": "",
"categoryDomains": [
"美妆行业库"
],
"keywords": [
"卓尔诗婷烟酰胺美白身体乳霜",
"卓尔诗婷祛斑霜",
"卓尔诗婷美白身体乳",
"卓尔诗婷雪肌美白精华乳霜"
]
},
{
"key": "蒂迩肌水凝营养保湿霜",
"brandId": 5121,
"categoryId": 812,
"timeToMarket": "20200101",
"spu": "蒂迩肌水凝营养保湿霜",
"brandName": "蒂迩肌",
"categoryName": "面霜其他",
"picUrl": null,
"id": 28,
"recallWord": "",
"recallFilterWord": "",
"matchRule": "",
"filterRule": "",
"ruleSentenceScopeLimit": "",
"categoryDomains": [
"美妆系统自动"
],
"keywords": [
"蒂迩肌水凝营养保湿霜",
"蒂迩肌水凝高保湿补水滋润面霜"
]
},
{
"key": "静芙全身按摩精油",
"brandId": 26353,
"categoryId": 677,
"timeToMarket": "20160101",
"spu": "静芙全身按摩精油",
"brandName": "静芙",
"categoryName": "身体精油",
"picUrl": null,
"id": 39,
"recallWord": "",
"recallFilterWord": "",
"matchRule": "",
"filterRule": "",
"ruleSentenceScopeLimit": "",
"categoryDomains": [
"美妆系统自动"
],
"keywords": [
"静芙全身按摩精油"
]
}
}
}
}
}