诺云开放平台

Appearance

直播间菜单商品列表 ​

请求路径 ​

  • 请求方式：POST
  • 请求头：Content-Type:application/json
  • 接口地址：https://gateway.nuoyunapi.com/Api/RoomManager/Shop/getMenuGoodsList/2.0.0
  • 频率限制：10秒100次

请求参数 ​

参数必选类型描述
room_id是integer直播间ID
custom_menu_id否integer菜单ID
custom_menu_goods_category_id否integer菜单分类ID

请求示例 ​

json
{
    "room_id": 628564011,
    "custom_menu_id": 1243597,
    "custom_menu_goods_category_id": 0
}

获取所有商品示例 ​

json
{
    "room_id": 628564011
}

响应参数 ​

参数必选类型描述
code是integer状态码：200-成功，400-失败
msg是string提示信息
data是object响应数据

data 参数结构

参数必选类型描述
list是array商品列表数组

list 数组元素结构

参数必选类型描述
id是integer商品ID
name是string商品名称
sort是integer商品排序
is_show_room是integer是否直播间展示：1-显示；2-隐藏
custom_menu_goods_id是integer自定义菜单商品ID
first_pic是string商品图片
goods_type_txt是string商品类型
purchase_way是string购买方式
price是string价格
stock是integer库存
sale_type是integer开售类型 1-立即开售 2-定时开售
sale_time是integer销售时间
underlined_price是string划线价格
unit是string单位
sale_status是integer售卖状态：1-售卖中；2-未开始
sale_status_info是string售卖状态文本
explain是integer商品讲解状态：1-讲解中；2-未讲解
recommend是integer推荐状态：1-推荐中；2-未推荐

响应示例 ​

成功响应 ​

json
{
  "code": 200,
  "data": {
    "list": [
      {
        "id": 174928,
        "name": "苹果-测试一下最长商品名称，阿是刚到家啊还是讲课费撒娇阿是",
        "sort": 1,
        "is_show_room": 1,
        "custom_menu_goods_id": 96849,
        "first_pic": "https://nyfs-alpha.oss-cn-hangzhou.aliyuncs.com/Uploads/ConsoleWechat/35016/materialPic/202507110940551214819.jpg",
        "goods_type_txt": "虚拟商品",
        "purchase_way": "local",
        "price": "0.01",
        "stock": 0,
        "sale_type": 1,
        "sale_time": 0,
        "underlined_price": "0.00",
        "unit": "个",
        "sale_status": 2,
        "sale_status_info": "售卖中",
        "explain": 1,
        "recommend": 0
      }
    ]
  },
  "msg": "Success"
}

失败响应 ​

json
{
  "code": 400,
  "msg": "直播间不存在",
  "data": {}
}

返回值状态码说明 ​

状态码描述
200成功
400失败

字段说明 ​

显示状态 (is_show_room) ​

  • 1：在直播间中显示
  • 2：在直播间中隐藏

开售类型 (sale_type) ​

  • 1：立即开售
  • 2：定时开售

售卖状态 (sale_status) ​

  • 1：售卖中
  • 2：未开始

讲解状态 (explain) ​

  • 1：讲解中（当前正在讲解的商品）
  • 2：未讲解

推荐状态 (recommend) ​

  • 1：推荐中（推荐商品）
  • 2：未推荐

购买方式 (purchase_way) ​

  • local：本地购买
  • external：外部链接
  • miniprogram：小程序购买

使用说明 ​

1. 筛选参数 ​

  • 不传筛选参数：返回直播间所有商品
  • 传入菜单ID：返回指定菜单下的商品
  • 传入分类ID：返回指定分类下的商品

2. 商品管理 ​

  • 排序：通过 sort 字段控制商品在列表中的显示顺序
  • 显示控制：通过 is_show_room 控制商品是否在直播间展示
  • 状态管理：包含讲解、推荐、售卖等多种状态

3. 价格信息 ​

  • 销售价格 (price)：实际售卖价格
  • 划线价格 (underlined_price)：原价或参考价格
  • 库存 (stock)：剩余库存数量

注意事项 ​

  1. 权限验证：需要确保有访问该直播间的权限
  2. 商品状态：商品的各种状态会影响在直播间的展示效果
  3. 库存管理：库存为0时可能影响商品的售卖状态
  4. 图片访问：商品图片链接需要确保可正常访问
  5. 排序规则：sort 值越小，商品排序越靠前

相关接口 ​

业务场景 ​

  1. 商品管理：查看直播间所有商品及其状态
  2. 讲解管理：获取当前正在讲解的商品信息
  3. 库存监控：实时了解商品库存情况
  4. 状态统计：统计推荐商品、售卖商品等数量
  5. 菜单展示：按菜单分类展示商品列表