Appearance
直播间添加商品
请求路径
- 请求方式:
POST - 请求头:
Content-Type:application/json - 接口地址:
https://gateway.nuoyunapi.com/Api/RoomManager/Shop/addGoods/2.0.0 - 频率限制:
10秒100次
请求参数
| 参数 | 必选 | 类型 | 描述 |
|---|---|---|---|
| room_id | 是 | integer | 直播间ID |
| goods_ids_str | 是 | string | 商品ID,多个用英文逗号分隔 |
| custom_menu_id | 否 | integer | 菜单ID |
| custom_menu_goods_category_id | 否 | integer | 橱窗ID |
请求示例
json
{
"room_id": 628564011,
"goods_ids_str": "1022786",
"custom_menu_id": 1243597,
"custom_menu_goods_category_id": 0
}批量添加商品示例
json
{
"room_id": 628564011,
"goods_ids_str": "1022786,1022787,1022788",
"custom_menu_id": 1243597,
"custom_menu_goods_category_id": 0
}响应参数
| 参数 | 必选 | 类型 | 描述 |
|---|---|---|---|
| code | 是 | integer | 状态码:200-成功,400-失败 |
| msg | 是 | string | 提示信息 |
| data | 是 | object | 响应数据 |
data 参数结构
| 参数 | 必选 | 类型 | 描述 |
|---|---|---|---|
| custom_menu_id | 是 | integer | 菜单ID |
响应示例
成功响应
json
{
"data": {
"custom_menu_id": 147131
},
"msg": "Success",
"code": 200
}失败响应
json
{
"code": 400,
"msg": "直播间不存在",
"data": {}
}返回值状态码说明
| 状态码 | 描述 |
|---|---|
| 200 | 成功 |
| 400 | 失败 |
使用说明
1. 商品关联方式
- 单个商品:
goods_ids_str传单个商品ID,如"1022786" - 批量商品:
goods_ids_str传多个商品ID,用英文逗号分隔,如"1022786,1022787,1022788"
2. 菜单和橱窗
- 菜单ID (
custom_menu_id):指定商品添加到哪个菜单下,如果不传则添加到默认菜单 - 橱窗ID (
custom_menu_goods_category_id):指定商品添加到哪个橱窗分类下,传0表示不指定分类
3. 操作前提
- 直播间必须存在且有权限操作
- 商品必须是有效的商品ID
- 商品状态必须允许添加到直播间
注意事项
- 商品ID格式:多个商品ID之间必须用英文逗号(
,)分隔,不能有空格 - 权限验证:需要确保有操作该直播间的权限
- 商品状态:只能添加状态正常的商品到直播间
- 重复添加:如果商品已存在于直播间中,系统会进行相应处理
- 菜单管理:返回的
custom_menu_id可用于后续的菜单管理操作
相关接口
- 获取直播间菜单商品列表 - 查看已添加的商品
- 删除直播间商品 - 移除直播间商品
- 直播间商品讲解 - 设置商品讲解状态
业务场景
- 电商直播:主播开播前批量添加要售卖的商品
- 产品展示:将相关产品添加到直播间供观众浏览
- 分类管理:通过橱窗ID将商品按类别进行组织
- 动态管理:直播过程中实时添加新的商品