商品管理
添加商品
api名称:goods.add
,SDK对应方法:goodsAdd
- 应用参数说明:
字段 | 类型 | 必选 | 描述 |
---|---|---|---|
departmentID | string/int | Y | 部门ID |
options | object | Y | 产品信息 |
- options参数说明:
字段 | 类型 | 必选 | 描述 |
---|---|---|---|
name | string | Y | 商品名称 |
img | string | Y | 商品图片链接 |
price | float | Y | 商品售价 |
originalPrice | float | Y | 市场售价 |
tab | int | N | 展示标签 特价:1, 限时:2, 新品:3, 钜惠:4, 秒杀:5,拼团:6不显示:0 |
pay | int | Y | 购买模式 链接购买:1, 二维码购买:2 |
url | string | N | 商品链接(链接购买必须) |
qrcode | string | N | 商品二维码(二维码购买必须) |
link_text | string | N | 购物按钮 |
- 返回说明:
code=0 成功,data为新增的商品id
获取商品详情
api名称:goods.get
对应方法:goodsGet
- 应用参数说明:
字段 | 类型 | 必选 | 描述 |
---|---|---|---|
id | string | Y | 商品ID |
返回参数说明:code=0成功,其他值为失败
data说明:
字段 | 类型 | 描述 |
---|---|---|
id | string | 商品id |
name | string | 商品名称 |
img | string | 商品图片链接 |
price | float | 商品售价 |
originalPrice | float | 市场售价 |
tab | int | 展示标签 特价:1, 限时:2, 新品:3, 钜惠:4, 秒杀:5,拼团:6不显示:0 |
pay | int | 购买模式 链接购买:1, 二维码购买:2 |
url | string | 商品链接(链接购买必须) |
qrcode | string | 商品二维码(二维码购买必须) |
link_text | string | 购物按钮 |
获取商品列表
api名称:goods.list
对应方法:goodsList
- 应用参数说明:
字段 | 类型 | 必选 | 描述 |
---|---|---|---|
page | int | N | 页码,最大值为 10000 |
size | int | N | 每页数量,最大值为 1000 |
options | object | N | 其他选项 |
name 商品名称 putaway 上下架状态 0下架,1上架,不传获取全部状态 departmentID 部门id |
返回参数说明:code=0成功,其他值为失败
返回data数组说明:字段和商品详情一致
商品编辑
api名称:goods.edit
对应方法:goodsEdit
- 应用参数说明:
字段 | 类型 | 必选 | 描述 |
---|---|---|---|
id | string | Y | 商品id |
options | object | Y | 其他选项 |
需要更新的字段(参考添加商品) |
返回参数说明:code=0成功,其他值为失败
特别说明:商品下架则全部课程删除,直播中的课程立刻生效,其他刷新生效
商品删除
api名称:goods.del
对应方法:goodsDel
- 应用参数说明:
字段 | 类型 | 必选 | 描述 |
---|---|---|---|
id | string | Y | 商品id;支持批量删除,字符串格式: '1,2,3' |
返回参数说明:code=0成功,其他值为失败
特别说明:商品删除则全部课程删除,直播中的课程立刻生效,其他刷新生效
直播商品管理
1、直播商品列表
api名称:course.goods.list
,SDK对应方法:courseGoods
- 应用参数说明:
字段 | 类型 | 必须 | 描述 |
---|---|---|---|
course_id | string | Y | 直播ID |
- 返回data数组参数说明:
字段 | 类型 | 描述 |
---|---|---|
goods_id | string | 商品id |
name | string | 商品名称 |
img | string | 商品图片链接 |
price | float | 商品售价 |
originalPrice | float | 市场售价 |
tab | int | 展示标签 特价:1, 限时:2, 新品:3, 钜惠:4, 秒杀:5,拼团:6不显示:0 |
pay | int | 购买模式 链接购买:1, 二维码购买:2 |
url | string | 商品链接(链接购买必须) |
qrcode | string | 商品二维码(二维码购买必须) |
link_text | string | 购物按钮 |
sort | int | 商品在当前列表排序 |
2、直播商品批量导入
api名称:course.goods.import
,SDK对应方法:courseGoodsImport
- 应用参数说明:
字段 | 类型 | 必须 | 描述 |
---|---|---|---|
course_id | string | Y | 直播id |
goods_id | array | Y | 商品库商品id |
返回参数说明:code=0成功,其他值为失败
3、直播商品添加
api名称:course.goods.add
,SDK对应方法:courseGoodsAdd
- 应用参数说明:
字段 | 类型 | 必选 | 描述 |
---|---|---|---|
course_id | string | Y | 直播id |
goods_id | string | Y | 商品id |
options | obj | Y | 添加项 |
options.name | string | Y | 商品名称 |
options.img | string | Y | 商品图片链接 |
options.price | float | Y | 商品售价 |
options.originalPrice | float | Y | 市场售价 |
options.tab | int | Y | 展示标签 特价:1, 限时:2, 新品:3, 钜惠:4, 秒杀:5,拼团:6不显示:0 |
options.pay | int | Y | 购买模式 链接购买:1, 二维码购买:2 |
options.url | string | N | 商品链接(链接购买必须) |
options.qrcode | string | N | 商品二维码(二维码购买必须) |
options.link_text | string | N | 购物按钮 |
options.sort | int | N | 排序(默认排最后) |
返回参数说明:code=0成功,其他值为失败
4、直播商品编辑
api名称:course.goods.edit
,SDK对应方法:courseGoodsEdit
- 应用参数说明:
字段 | 类型 | 必选 | 描述 |
---|---|---|---|
course_id | string | Y | 直播id |
goods_id | string | Y | 商品id |
options | obj | Y | 修改项 |
options.name | string | N | 商品名称 |
options.img | string | N | 商品图片链接 |
options.price | float | N | 商品售价 |
options.originalPrice | float | N | 市场售价 |
options.tab | int | N | 展示标签 特价:1, 限时:2, 新品:3, 钜惠:4, 秒杀:5,拼团:6不显示:0 |
options.pay | int | N | 购买模式 链接购买:1, 二维码购买:2 |
options.url | string | N | 商品链接(链接购买必须) |
options.openUrlType | string | N | 跳转链接类型 外部跳转访问:0,内部打开访问1 |
options.qrcode | string | N | 商品二维码(二维码购买必须) |
options.link_text | string | N | 购物按钮 |
options.sort | int | N | 排序(只对上架商品生效) |
返回参数说明:code=0成功,其他值为失败
5、直播商品删除
api名称:course.goods.del
,SDK对应方法:courseGoodsDel
- 应用参数说明:
字段 | 类型 | 必须 | 描述 |
---|---|---|---|
course_id | string | Y | 直播id |
goods_id | string | Y | 商品id;支持批量删除,字符串格式: '1,2,3' |
返回参数说明:code=0成功,其他值为失败
6、直播商品推送
api名称:course.goods.push
,SDK对应方法:courseGoodsPush
- 应用参数说明:
字段 | 类型 | 必须 | 描述 |
---|---|---|---|
course_id | string | Y | 直播id |
goods_id | string | Y | 商品id |
putaway | string | Y | 推送商品 下架:0,上架:1,推荐:2,取消推荐:3 |
返回参数说明:code=0成功,其他值为失败