诺云开放平台

Appearance

可添加到直播间的商品列表 ​

请求路径 ​

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

请求参数 ​

参数必选类型描述
currentPage是integer当前页码
pageSize是integer每页数量
room_id是integer直播间ID
custom_menu_id否integer自定义菜单ID

请求示例 ​

json
{
    "currentPage": 1,
    "pageSize": 100,
    "room_id": 850668440,
    "custom_menu_id": 155469
}

基础查询示例 ​

json
{
    "currentPage": 1,
    "pageSize": 20,
    "room_id": 850668440
}

响应参数 ​

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

data 参数结构

参数必选类型描述
list是array商品列表数组
page_info是object分页信息

list 数组元素结构

参数必选类型描述
id是integer商品ID
name是string商品名称
purchase_way是string购买方式
first_pic是string商品图片
intro_price是string商品价格
activity_intro_price是string活动价格
stock是integer库存
goods_type_txt是string商品类型

page_info 参数结构

参数必选类型描述
currentPage是integer当前页面
pageSize是integer每页数量
total_count是integer总数量

响应示例 ​

成功响应 ​

json
{
  "code": 200,
  "data": {
    "list": [
      {
        "id": 174620,
        "name": "菠萝88",
        "purchase_way": "local",
        "first_pic": "https://nyfs-alpha.oss-cn-hangzhou.aliyuncs.com/Uploads/ConsoleWechat/45952/materialPic/202505261509472545385.png",
        "intro_price": "1.00",
        "activity_intro_price": "0.01",
        "stock": 9999,
        "goods_type_txt": "实体商品"
      }
    ],
    "page_info": {
      "currentPage": 1,
      "pageSize": 10,
      "total_count": 29
    }
  },
  "msg": "Success"
}

失败响应 ​

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

返回值状态码说明 ​

状态码描述
200成功
400失败

字段说明 ​

购买方式 (purchase_way) ​

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

商品类型 (goods_type_txt) ​

  • 实体商品：需要物流配送的商品
  • 虚拟商品：数字化商品，无需物流
  • 服务商品：提供服务的商品

价格说明 ​

  • 商品价格 (intro_price)：商品的标准售价
  • 活动价格 (activity_intro_price)：促销活动价格，通常低于标准价格

使用说明 ​

1. 分页查询 ​

  • 页码从1开始：currentPage 最小值为1
  • 合理设置每页数量：建议 pageSize 设置为10-100之间
  • 总数统计：通过 total_count 获取总商品数量

2. 筛选条件 ​

  • 菜单筛选：传入 custom_menu_id 可筛选特定菜单下的商品
  • 全量查询：不传 custom_menu_id 则返回所有可用商品

3. 商品状态 ​

  • 返回的商品都是可添加到直播间的商品
  • 已下架或删除的商品不会出现在列表中
  • 库存为0的商品仍会显示，但需要注意库存状态

注意事项 ​

  1. 权限验证：需要确保有访问该直播间的权限
  2. 分页处理：建议实现分页加载，避免一次性加载过多数据
  3. 图片加载：商品图片链接需要确保网络可访问
  4. 价格展示：注意区分标准价格和活动价格的显示
  5. 库存监控：关注商品库存状态，及时更新商品可用性

业务流程 ​

1. 调用本接口获取可添加的商品列表
   ↓
2. 展示商品信息供用户选择
   ↓
3. 用户选择商品后调用添加商品接口
   ↓
4. 商品成功添加到直播间菜单

相关接口 ​

业务场景 ​

  1. 商品选择：直播前选择要在直播间展示的商品
  2. 商品搜索：在大量商品中查找特定商品
  3. 库存查看：了解商品库存情况
  4. 价格对比：查看商品的标准价格和活动价格
  5. 分类管理：按菜单分类管理商品

接口对比 ​

接口用途返回数据
getGoodsList获取可添加的商品商品基础信息
getMenuGoodsList获取已添加的商品商品详细状态

这两个接口配合使用，可以完整实现直播间商品的选择和管理功能。