七鱼开发文档中心
总览服务端 APIWebiOSAndroid鸿蒙Uniapp微信小程序插件三方接入
在线机器人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

请求参数

名称类型必填描述示例值
appKeystring是应用 AppKey1c088a89de51d0af457616605f28390f
timeint64是请求时间戳(秒);与服务器时间误差超过 10 分钟会鉴权失败1511832531
checksumstring是请求签名校验和f570a5eb049eb803b086e45829b07e48
checksumAlgorithmint32否签名算法:0-SHA-1,1-SHA-256;不传默认为 0(SHA-1)0

请求体

名称类型必填描述示例值
categoryIdstring是外部类目 ID;-1 表示全部类目,0 表示未分类-1
limitint64否返回条数,不传默认 100,最大 200100
offsetint64否偏移量,不传或小于等于 0 时默认 00

返回参数

名称类型描述示例值
codeint32业务状态码,200 表示成功200
messagestring响应消息success
dataobjectGMC 商品列表返回数据
└totalint32商品总数120
└dataobject[]商品列表
└idint64商品内部 ID;通常不传,接口按 goodsId 新增或更新10000001
└goodsIdstring商品货号,只允许数字和大小写字母,最大 100 字符SKU123456
└goodsNamestring商品名称,最大 500 字符春季新款外套
└categoryobject
└idint64类目内部 ID10001
└cidstring外部类目 IDCLOTHES001
└namestring类目名称服装
└statusint32有效状态:1-有效,2-删除1
└titlestring商品标题,最大 128 字符春季新款外套
└descriptionstring商品描述,最大 128 字符轻薄透气
└notestring商品备注,最大 128 字符主推款
└imgUrlstring商品图片地址,最大 1024 字符https://example.com/goods.jpg
└linksobject[]商品链接列表
└linkstring链接地址;传链接时 fromTypes 必填https://example.com/detail/SKU123456
└fromTypesobject
└terminalCodeint32渠道 code,必须是已开启的 GMC 渠道1
└appCodeint64应用 code;存在应用子级时必须匹配已开启应用10001
└aliasesstring[]商品同义词列表,单个最大 100 字符,最多 50 个
└goodsAttrsobject[]商品属性列表,最多 50 个
└idint64属性 ID30001
└attrNamestring属性名称;传属性时 attrVal 必填,属性和值必须已存在颜色
└categoryValboolean是否类目属性false
└requiredboolean是否必填false
└attrValIdint64属性值 ID40001
└attrValstring属性值黑色
totalint32分页总数,分页接口返回100
requestIdstring链路请求 ID0a1b2c3d4e5f
resultobject部分历史接口使用 result 字段承载业务数据

错误码

状态码描述
14001AppKey 缺失或不存在
14002checksum 校验失败
14003请求时间戳与服务器时间误差超过 10 分钟
14004请求体不是合法 JSON 对象,或参数缺失、格式非法
14009频控限制:接口调用超过限流阈值
14500服务内部错误
14501数据查询范围超出限制
14515当前 AppKey 无接口或资源访问权限
postEndpoint
/openapi/robot/api/gmc/goods/list
POST
/openapi/robot/api/gmc/goods/list
curl -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": "未开通机器人服务"
}

这篇文档有帮助吗?