查询商品列表 - ListProduct
功能介绍
查询商品列表
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /v1/{project_id}/trace/trace-sweepcode/product/list
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 租户从IAM申请到的projectid,一般为32位字符串 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 用户Token |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| query | 是 | Query object | 分页参数 |
| merchant | 是 | String | 商户ID(取值为项目ID) |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code | String | 返回码 |
| message | String | 响应消息 |
| data | data object | 商品数据列表 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| pageNum | Integer | 页数 |
| pageSize | Integer | 每页展示的数量 |
| total | Integer | 总数 |
| pages | Integer | 总页数 |
| record | Array of record objects | 商品信息 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| productCode | String | 批次码 |
| productName | String | 产品名称 |
| productPhotoUrl | String | 图片url |
| sweepcodeStatisticsSwitch | String | 商品溯源扫码统计开关(0:关闭;1 打开) |
| bannerUrl | String | 横幅url |
| merchant | String | 商户ID(取值为项目ID) |
| productOrigin | String | 商品产地 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误描述 |
请求示例
{
"query" : {
"size" : 50,
"current" : 1
},
"merchant" : "1416325181332881400"
} 响应示例
状态码:200
Success
{
"code" : "200",
"message" : "操作成功!",
"data" : {
"pageNum" : 1,
"pageSize" : 2,
"total" : 1,
"pages" : 1,
"record" : [ {
"productCode" : "appletest",
"productName" : "11",
"productPhotoUrl" : "https://xxx.xxx.xxx.xxx",
"sweepcodeStatisticsSwitch" : "1",
"bannerUrl" : "https://xxx.xxx.xxx.xxx",
"merchant" : "1759540612045058049",
"productOrigin" : "bj"
} ]
}
} 状态码:500
Error response
{
"code" : "500",
"message" : "系统异常"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | Success |
| 500 | Error response |