在线机器人GMC 商品卡片
查询 GMC 商品列表
查询 GMC 商品列表。
接口级参数规则:categoryId 必填;categoryId 可传 -1 查询全部、0 查询未分类,其他值必须是已存在外部类目 ID;limit 不传默认 100,最大 200;offset 不传或小于等于 0 时默认 0。
请求字段限制:
- categoryId:必填,外部类目 ID;-1 表示全部类目,0 表示未分类
- limit:选填,返回条数,不传默认 100,最大 200,最大值 200,默认值:100
- offset:选填,偏移量,不传或小于等于 0 时默认 0,默认值:0
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| appKey | string | 是 | 应用 AppKey | 1c088a89de51d0af457616605f28390f |
| time | int64 | 是 | 请求时间戳(秒);与服务器时间误差超过 10 分钟会鉴权失败 | 1511832531 |
| checksum | string | 是 | 请求签名校验和 | f570a5eb049eb803b086e45829b07e48 |
| checksumAlgorithm | int32 | 否 | 签名算法:0-SHA-1,1-SHA-256;不传默认为 0(SHA-1) | 0 |
请求体
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| categoryId | string | 是 | 外部类目 ID;-1 表示全部类目,0 表示未分类 | -1 |
| limit | int64 | 否 | 返回条数,不传默认 100,最大 200 | 100 |
| offset | int64 | 否 | 偏移量,不传或小于等于 0 时默认 0 | 0 |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| code | int32 | 业务状态码,200 表示成功 | 200 |
| message | string | 响应消息 | success |
| data | object | GMC 商品列表返回数据 | |
| └total | int32 | 商品总数 | 120 |
| └data | object[] | 商品列表 | |
| └id | int64 | 商品内部 ID;通常不传,接口按 goodsId 新增或更新 | 10000001 |
| └goodsId | string | 商品货号,只允许数字和大小写字母,最大 100 字符 | SKU123456 |
| └goodsName | string | 商品名称,最大 500 字符 | 春季新款外套 |
| └category | object | ||
| └id | int64 | 类目内部 ID | 10001 |
| └cid | string | 外部类目 ID | CLOTHES001 |
| └name | string | 类目名称 | 服装 |
| └status | int32 | 有效状态:1-有效,2-删除 | 1 |
| └title | string | 商品标题,最大 128 字符 | 春季新款外套 |
| └description | string | 商品描述,最大 128 字符 | 轻薄透气 |
| └note | string | 商品备注,最大 128 字符 | 主推款 |
| └imgUrl | string | 商品图片地址,最大 1024 字符 | https://example.com/goods.jpg |
| └links | object[] | 商品链接列表 | |
| └link | string | 链接地址;传链接时 fromTypes 必填 | https://example.com/detail/SKU123456 |
| └fromTypes | object | ||
| └terminalCode | int32 | 渠道 code,必须是已开启的 GMC 渠道 | 1 |
| └appCode | int64 | 应用 code;存在应用子级时必须匹配已开启应用 | 10001 |
| └aliases | string[] | 商品同义词列表,单个最大 100 字符,最多 50 个 | |
| └goodsAttrs | object[] | 商品属性列表,最多 50 个 | |
| └id | int64 | 属性 ID | 30001 |
| └attrName | string | 属性名称;传属性时 attrVal 必填,属性和值必须已存在 | 颜色 |
| └categoryVal | boolean | 是否类目属性 | false |
| └required | boolean | 是否必填 | false |
| └attrValId | int64 | 属性值 ID | 40001 |
| └attrVal | string | 属性值 | 黑色 |
| total | int32 | 分页总数,分页接口返回 | 100 |
| requestId | string | 链路请求 ID | 0a1b2c3d4e5f |
| result | object | 部分历史接口使用 result 字段承载业务数据 |
错误码
| 状态码 | 描述 |
|---|---|
| 14001 | AppKey 缺失或不存在 |
| 14002 | checksum 校验失败 |
| 14003 | 请求时间戳与服务器时间误差超过 10 分钟 |
| 14004 | 请求体不是合法 JSON 对象,或参数缺失、格式非法 |
| 14009 | 频控限制:接口调用超过限流阈值 |
| 14500 | 服务内部错误 |
| 14501 | 数据查询范围超出限制 |
| 14515 | 当前 AppKey 无接口或资源访问权限 |
postEndpoint
/openapi/robot/api/gmc/goods/listcurl -X POST "https://qiyukf.com/openapi/robot/api/gmc/goods/list?appKey=1c088a89de51d0af457616605f28390f&time=1511832531&checksum=f570a5eb049eb803b086e45829b07e48" \ -H "Content-Type: application/json" \ -d '{ "offset": 0, "limit": 100, "categoryId": "-1" }'{
"code": 200,
"data": {},
"message": "success"
}{
"code": 14001,
"message": "AppKey not exists"
}{
"code": 14002,
"message": "Bad checksum"
}{
"code": 14003,
"message": "Bad time"
}{
"code": 14004,
"message": "body内容json解析错误"
}{
"code": 14009,
"message": "单位时间内请求过于频繁"
}{
"code": 14500,
"message": "Internal error"
}{
"code": 14501,
"message": "Data limit exceeded"
}{
"code": 14515,
"message": "未开通机器人服务"
}这篇文档有帮助吗?