本页内容
1. 接口描述 #
接口URL:https://open.datastory.com.cn/api/datastory.ecommerce.commodity_list
请求方式:POST
描述:通过该接口可查标准商品数据详情,包括:标准商品名称、标准商品ID、备案号、备案类型、上市日期等等,具体输出内容可查看输出参数示例。
2. 输入参数 #
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 默认值 | 类型 | 参数示例 | 描述 |
---|---|---|---|---|---|
appkey | 否 | string | "predeploy" | 权限校验标识 | |
filters | 是 | Array of RequestCommodityListFilters | (见接口示例) | 查询过滤条件 | |
openStrategy | 否 | boolean | false | 是否接受缓存 | |
page | 否 | integer | 1 | 分页查询的页码,默认1 | |
pageSize | 否 | integer | "20" | 分页查询的单页数据条数,默认20 |
3. 输出参数 #
参数名称 | 必选 | 类型 | 参数示例 | 描述 |
---|---|---|---|---|
code | 否 | integer | 0 | 返回状态码,内部定义 |
data | 否 | Array of ResponseDataOfCommodityListVo | (见接口示例) | 查询过滤条件 |
msg | 否 | string | "接口返回成功!" | 接口返回信息说明,在接口返回失败时会有 |
openStrategy | 否 | boolean | false | 是否接受缓存 |
success | 否 | boolean | true | 接口返回是否成功 |
4. 数据结构 #
4.1 RequestCommodityListFilters #
参数名 | 必选 | 类型 | 参数示例 | 描述 |
---|---|---|---|---|
brandId | 否 | integer | 68 | 品牌名ID |
brandName | 否 | string | "小米" | 品牌名 |
categoryId | 否 | integer | "68" | 品类id |
categoryName | 否 | string | "手机其他" | 品类名称 |
commodityId | 否 | integer | "951" | 标品id |
commodityName | 否 | string | "黛珂黛珂莹润粹白透亮菁华面膜" | 标品名称 |
shopName | 否 | string | "修丽可官方旗舰店" | 店铺名称 |
marketTimestamp | 否 | integer | "1640966400000" | 上市日期 |
4.2 ResponseDataOfCommodityListVo #
参数名 | 必选 | 类型 | 参数示例 | 描述 |
---|---|---|---|---|
dataset | 否 | [Array of CommodityListVo,Array of CommodityListVo] | (见接口示例) | 查询过滤条件 |
meta | 否 | array | "list" | 返回数据格式:list、aggregation、graph |
page | 否 | integer | 1 | 分页查询的页码 |
pageSize | 否 | integer | "20" | 分页查询的单页数据条数 |
time | 否 | integer | "955" | 查询总耗时,单位毫秒 |
total | 否 | integer | "34500230" | 查询数据总量 |
4.2.1 CommodityListVo #
参数名 | 必选 | 类型 | 参数示例 | 描述 |
---|---|---|---|---|
brandId | 否 | integer | "68" | 品牌ID |
brandName | 否 | string | "华为" | 品牌名称 |
categoryId | 否 | integer | "68" | 品类ID |
categoryName | 否 | string | "手机其他" | 品类名称 |
commodityId | 否 | integer | 951 | 标品id |
commodityName | 否 | string | 黛珂黛珂莹润粹白透亮菁华面膜 | 标品名称 |
remarkNumber | 否 | string | "云G妆网备字2019000853" | 备案号 |
remarkType | 否 | string | " 化妆品备案编号" | 备案类型 |
5. 示例 #
示例1 查看标品的详情 #
输入示例
{
"appkey": "predeploy",
"filters": {
"brandName": "华为"
},
"openStrategy": false,
"page": 1,
"pageSize": 20
}
输出示例
{
"success": true,
"openStrategy": false,
"code": 0,
"msg": "接口返回成功!",
"data": {
"meta": {
"datasetType": "list"
},
"dataset": [
{
"brandName": "华为",
"categoryName": "手机",
"brandId": 68,
"categoryId": 11463,
"commodityName": "Huawei/华为 nova 9 SE",
"remarkNumber": "2022011606446446",
"remarkType": "3C认证编号",
"commodityId": 160,
"marketTimeStamp": 1640966400000
},
{
"brandName": "华为",
"categoryName": "手机",
"brandId": 68,
"categoryId": 11463,
"commodityName": "Huawei/华为 Mate Xs 2",
"remarkNumber": "2022011606458598",
"remarkType": "3C认证编号",
"commodityId": 178,
"marketTimeStamp": 1640966400000
},
{
"brandName": "华为",
"categoryName": "手机",
"brandId": 68,
"categoryId": 11463,
"commodityName": "Huawei/华为 P50 Pro",
"remarkNumber": "2021011606397877",
"remarkType": "3C认证编号",
"commodityId": 112,
"marketTimeStamp": 1609430400000
},
{
"brandName": "华为",
"categoryName": "手机",
"brandId": 68,
"categoryId": 11463,
"commodityName": "Huawei/华为 Mate X2 4G版",
"remarkNumber": "2021011606392960",
"remarkType": "3C认证编号",
"commodityId": 105,
"marketTimeStamp": 1609430400000
},
{
"brandName": "华为",
"categoryName": "手机",
"brandId": 68,
"categoryId": 11463,
"commodityName": "Huawei/华为 nova 9 SE",
"remarkNumber": "2021011606414044",
"remarkType": "3C认证编号",
"commodityId": 130,
"marketTimeStamp": 1609430400000
},
{
"brandName": "华为",
"categoryName": "手机",
"brandId": 68,
"categoryId": 11463,
"commodityName": "Huawei/华为 Mate 40E",
"remarkNumber": "2021011606367203",
"remarkType": "3C认证编号",
"commodityId": 84,
"marketTimeStamp": 1609430400000
},
{
"brandName": "华为",
"categoryName": "手机",
"brandId": 68,
"categoryId": 11463,
"commodityName": "Huawei/华为 nova 9 SE",
"remarkNumber": "2021011606416098",
"remarkType": "3C认证编号",
"commodityId": 131,
"marketTimeStamp": 1609430400000
},
{
"brandName": "华为",
"categoryName": "手机",
"brandId": 68,
"categoryId": 11463,
"commodityName": "Huawei/华为 nova 9 SE",
"remarkNumber": "2021011606418946",
"remarkType": "3C认证编号",
"commodityId": 135,
"marketTimeStamp": 1609430400000
},
{
"brandName": "华为",
"categoryName": "手机",
"brandId": 68,
"categoryId": 11463,
"commodityName": "Huawei/华为 mate x2",
"remarkNumber": "2020011606345914",
"remarkType": "3C认证编号",
"commodityId": 56,
"marketTimeStamp": 1577808000000
},
{
"brandName": "华为",
"categoryName": "手机",
"brandId": 68,
"categoryId": 11463,
"commodityName": "Huawei/华为 WGR-W09",
"remarkNumber": "2020011606275248",
"remarkType": "3C认证编号",
"commodityId": 27,
"marketTimeStamp": 1577808000000
},
{
"brandName": "华为",
"categoryName": "手机",
"brandId": 68,
"categoryId": 11463,
"commodityName": "Huawei/华为 麦芒 9 5G",
"remarkNumber": "2020011606306663",
"remarkType": "3C认证编号",
"commodityId": 42,
"marketTimeStamp": 1577808000000
},
{
"brandName": "华为",
"categoryName": "手机",
"brandId": 68,
"categoryId": 11463,
"commodityName": "Huawei/华为 畅享20 Pro",
"remarkNumber": "2020011606297103",
"remarkType": "3C认证编号",
"commodityId": 38,
"marketTimeStamp": 1577808000000
},
{
"brandName": "华为",
"categoryName": "手机",
"brandId": 68,
"categoryId": 11463,
"commodityName": "Huawei/华为 畅享20 SE",
"remarkNumber": "2020011606355066",
"remarkType": "3C认证编号",
"commodityId": 65,
"marketTimeStamp": 1577808000000
},
{
"brandName": "华为",
"categoryName": "手机",
"brandId": 68,
"categoryId": 11463,
"commodityName": "Huawei/华为 nova 8 Pro",
"remarkNumber": "2020011606353953",
"remarkType": "3C认证编号",
"commodityId": 63,
"marketTimeStamp": 1577808000000
},
{
"brandName": "华为",
"categoryName": "手机",
"brandId": 68,
"categoryId": 11463,
"commodityName": "Huawei/华为 nova 8 SE",
"remarkNumber": "2020011606326821",
"remarkType": "3C认证编号",
"commodityId": 49,
"marketTimeStamp": 1577808000000
},
{
"brandName": "华为",
"categoryName": "手机",
"brandId": 68,
"categoryId": 11463,
"commodityName": "Huawei/华为 畅享平板2",
"remarkNumber": "2020011606296345",
"remarkType": "3C认证编号",
"commodityId": 37,
"marketTimeStamp": 1577808000000
},
{
"brandName": "华为",
"categoryName": "手机",
"brandId": 68,
"categoryId": 11463,
"commodityName": "Huawei/华为 nova 8",
"remarkNumber": "2020011606344218",
"remarkType": "3C认证编号",
"commodityId": 54,
"marketTimeStamp": 1577808000000
},
{
"brandName": "华为",
"categoryName": "手机",
"brandId": 68,
"categoryId": 11463,
"commodityName": "Huawei/华为 MATE 40",
"remarkNumber": "2020011606347412",
"remarkType": "3C认证编号",
"commodityId": 58,
"marketTimeStamp": 1577808000000
},
{
"brandName": "华为",
"categoryName": "手机",
"brandId": 68,
"categoryId": 11463,
"commodityName": "Huawei/华为 随行wifi 3",
"remarkNumber": "2020011606286177",
"remarkType": "3C认证编号",
"commodityId": 34,
"marketTimeStamp": 1577808000000
},
{
"brandName": "华为",
"categoryName": "手机",
"brandId": 68,
"categoryId": 11463,
"commodityName": "Huawei/华为 B311B-853",
"remarkNumber": "2020011606318516",
"remarkType": "3C认证编号",
"commodityId": 46,
"marketTimeStamp": 1577808000000
}
],
"pageSize": 20,
"page": 1,
"total": 21,
"time": 25
}
}
6. 状态码 #
以下仅列出了接口业务逻辑相关的状态码。
状态码 | 描述 |
---|---|