小鹅通 · 云服务 API
首页
解决方案
  • 开放API
  • APP开店
文档中心应用市场控制台
首页
解决方案
  • 开放API
  • APP开店
文档中心应用市场控制台
  1. 开发前必读
  • 开发前必读
    • 小鹅云介绍
    • 更新日志
    • 开始开发
    • 小鹅通开放API开发交流群
  • 开发指南
    • 创建并授权应用
    • 获取access_token(含代码示例)
    • 开通接口权限
    • 全局返回码
    • 常用工具
      • 日志排查工具
  • 场景方案
    • 同步用户场景
    • 同步商品场景
    • 同步订购关系场景
    • 同步积分场景
    • 同步页面统计场景
    • 同步学习数据场景
    • 同步推广员场景
  • 内嵌SDK服务场景
    • 产品简介
    • 小鹅通SDK开发者声明
    • 小鹅通SDK个人信息保护政策
    • 开发指南
    • Android-SDK 接入
    • iOS-SDK 接入
    • H5直接嵌入
    • SDK&H5账号详解
    • 常见问题
    • 原生SDK登录态
      • 先决条件
      • 登录接口
      • 登出接口
  • 消息推送
    • 使用说明
    • 消息加/解密
    • 消息接收URL校验说明
    • 账号合并推送
    • 用户手机号变更推送
    • 用户状态变更推送
    • 用户注册推送
    • 商品变更推送
    • 订单支付推送
    • 订单状态变更推送
    • 优惠券消息推送
    • 信息采集推送
    • 积分变更推送
    • 考试消息推送
    • 活动签到推送
  • API列表
    • 用户管理
      • 使用说明
      • 注册新用户
      • 更新用户信息
      • 获取用户列表2.0
      • 获取用户列表1.0.0
      • 查询单个用户信息
      • 批量查询获取用户信息
      • 获取用户消费信息
      • 获取课程学员列表
      • 查询单个用户标签列表
      • 查询用户合并记录
      • 获取标签列表
      • 添加/修改标签
      • 添加/修改用户标签
    • 学习数据管理
      • 获取学习记录列表
      • 获取每日学习记录
      • 获取指定资源学习记录信息
      • 获取营期下用户的学习情况
    • 直播管理
      • 获取直播列表
      • 获取班课列表接口
      • 获取签到列表
      • 获取签到学员列表
      • 获取直播红包列表
      • 获取红包领取记录
      • 获取直播数据概览
      • 获取直播详情
      • 获取红包数据概况
    • 商品管理
      • 查询商品列表2.0
      • 查询商品列表1.0
      • 拉取组合课的资源列表4.0
      • 拉取组合课的资源列表3.0
      • 获取训练营营期任务
      • 商品详情2.0
      • 商品详情1.0
      • 获取直播带货商品列表
      • 商品增加库存
      • 商品减少库存
      • 新建实物商品
      • 编辑实物商品
      • 删除实物商品
      • 获取实物商品列表
      • 获取C端搜索商品列表
    • 商品分组管理
      • 获取店铺商品分组列表
      • 获取商品分组内商品列表
      • 批量新建/更新商品分组
      • 删除商品分组
    • 素材管理
      • 获取素材列表
      • 获取素材分组列表
      • 素材分组编辑
      • 素材分组移动
      • 素材分组删除
    • 订单管理
      • 获取订单列表1.1
      • 获取订单列表1.0
      • 查询用户订单列表
      • 获取订单详情
    • 订购管理
      • 用户开通产品包权益
      • 查询用户订购资源列表
      • 用户购买关系查询
      • 查询用户资源权益2.0
      • 查询用户资源权益1.0
      • 取消订购
    • 物流管理
      • 普通实物单发货
    • 推广员管理
      • 查询推广员列表
      • 查询推广员客户列表
      • 查询推广员的下级推广员列表
      • 查询指定推广员的信息
      • 查询客户所属推广员
      • 新增推广员
      • 推广员绑定客户
      • 修改/解除绑定关系
      • 设置推广员上级
      • 推广订单详情
      • 按日期查询推广员的收益和新增加的下级
      • 推广订单详情(支持购物车订单返回多条记录)
    • 信息采集管理
      • 获取信息采集列表
      • 获取单个信息采集结果
      • 获取用户信息采集结果
      • 根据表单ID以及用户ID获取信息采集结果
    • 营销码卷管理
      • 优惠券列表
      • 获取优惠券详情2.0
      • 获取优惠券详情
      • 获取优惠券领券用户
      • 发放优惠券2.0
      • 发放优惠券
      • 优惠券核销
      • 获取优惠码列表
      • 获取优惠码码库列表
      • 获取优惠码效果数据
      • 创建优惠码
      • 优惠码添加库存
      • 优惠码失效
      • 编辑优惠码
      • 优惠码删除
      • 获取兑换码码库列表
      • 追加兑换码库存
      • 创建兑换码
      • 编辑兑换码
      • 兑换码失效
      • 用户使用兑换码
      • 获取兑换码批次列表
    • 积分管理
      • 业务类型说明
      • 查询用户积分日志
      • 获取单个用户积分信息
      • 批量获取用户积分列表
      • 获取店铺积分信息
      • 批量发放积分
      • 批量扣减积分
      • 解冻冻结积分
      • 设置店铺积分过期时间
    • 页面统计管理
      • 新建页面统计
      • 编辑页面统计
      • 获取页面统计列表
      • 获取页面统计详情
      • 获取页面统计订单列表
      • 新建投放渠道
      • 获取投放渠道列表
    • 打卡管理
      • 获取打卡列表
      • 获取打卡参与用户
      • 获取指定学员活动日记列表
      • 获取活动点赞列表
      • 获取指定学员被点赞总数和列表
      • 获取用户日记被点评/评论列表
    • 社群管理
      • 获取用户参与的小社群
    • 考试管理
      • 获取考试列表
      • 获取考试详情
      • 获取考试结果列表信息
      • 获取考试结果详细信息
    • 活动管理
      • 获取活动列表
      • 获取签到列表
      • 获取活动报名列表
      • 获取活动签到信息
    • 组织管理
      • 获取员工列表
      • 获取员工详细信息
      • 添加或者保存员工信息
      • 启用员工
      • 停用员工
      • 删除员工
      • 根据员工账号获取用户ID
      • 获取组织结构树
      • 添加或修改组织架构
      • 移除组织架构
    • 微页面管理
      • 获取微页面列表
    • 企学院专用
      • 学员管理
        • 企学院获取学员列表
        • 企学院添加学员
        • 企学院修改学员
        • 企学院删除学员
        • 企学院添加组织架构
        • 企学院删除组织架构
        • 企学院编辑组织架构
        • 企学院获取组织架构
        • 企学院获取部门信息
      • 活动管理
        • 企学院用户签到活动列表
      • 培训计划管理(限企学院)
        • 获取培训计划列表
        • 获取培训计划详情
        • 获取用户培训学习数据
        • 获取员工的培训计划列表
  • 旧版API
    • 使用须知
    • 旧版指南
      • 签名和请求
      • Xiaoe SDK使用简介
      • 状态码和常见问题
    • 用户
      • 用户注册
      • 用户信息修改
      • 获取用户信息
    • 支付
      • 下单
      • 更新订单状态
    • 订单
      • 订单查询1.0
      • 订单查询2.0
    • 订购
      • 订阅列表查询
      • 订阅用户列表查询
      • 取消订阅
  • 常见问题
    • 问题汇总
    • 问题反馈
  1. 开发前必读

更新日志

2022-02-21#

1.
商品管理
【新增】 新建实物商品
【新增】 编辑实物商品
【新增】 删除实物商品
【新增】 获取实物商品类目列表
2.
营销码券管理
【修改】优惠券列表 新增响应字段has_spread_process_state:优惠券是否有进行中的定向发放

2022-02-15#

1.
推广员管理
【新增】 推广订单详情(支持购物车订单返回多条记录)

2022-02-09#

1.
用户管理
【新增】 获取标签列表
【新增】 添加/修改标签
【新增】 添加/修改用户标签

2022-01-26#

1.
消息推送
【修改】商品变更推送 新增商品创建推送,action为insert

2022-01-25#

1.
商品管理
【新增】 获取C端搜索商品列表
2.
营销码券管理
【新增】 获取兑换码批次列表

2022-01-21#

1.
商品管理
【新增】商品增加库存
【新增】商品减少库存

2022-01-07#

1.
用户管理
【修改】查询单个用户信息新增请求参数wx_open_id 微信open_id、field_list.skd_user_idsdk用户id 、field_list.created_at 创建时间
2.
直播管理
【新增】获取红包数据概况

2021-01-05#

1.
营销码券管理
【新增】创建兑换码
【新增】编辑兑换码
【新增】兑换码失效
【新增】用户使用兑换码

2021-12-31#

1.
直播管理
【新增】获取直播详情
【修改】获取直播列表 新增响应字段alive_manual_stop_at直播手动结束时间,alive_stop_at 直播结束时间

2021-12-29#

1.
营销码券管理
【新增】获取优惠券领券用户
【新增】获取优惠码码库列表
【新增】获取优惠码效果数据
【新增】获取兑换码码库列表
【新增】追加兑换码库存
2.
直播管理
【新增】获取直播数据概览

2021-12-15#

1.
营销码券管理
【新增】获取优惠码列表
【新增】创建优惠码
【新增】优惠码添加库存
【新增】优惠码失效
【新增】优惠码删除
【新增】编辑优惠码

2021-12-13#

1.
打卡管理
【修改】获取指定学员活动日记列表新增响应字段created_at日记发表日期

2021-12-09#

1.
组织管理
【新增】根据员工账号获取用户ID

2021-12-06#

1.
考试管理
【修改】获取考试结果列表信息新增请求参数join_id考试参加唯一id
2.
推广员管理
【修改】查询指定推广员的信息新增响应group_id分组id和group_name分组名称

2021-12-03#

1.
商品管理
【新增】查询商品列表2.0
【新增】获取实物商品评论列表
2.
直播管理
【新增】获取直播红包列表
【新增】获取红包领取记录
3.
考试管理
【新增】获取考试列表
【新增】获取考试详情

2021-12-02#

1.
推广员管理
【修改】查询推广员列表新增响应字段group_id所属组id,group_name所属组名

2021-12-01#

1.
订购管理
【修改】用户开通产品包权益新增请求参数discount_price优惠金额
2.
考试管理
【修改】获取考试结果详细信息新增响应字段child_info材料题的子题列表

2021-11-30#

1.
商品管理
【新增】商品详情2.0
【新增】获取直播带货列表
2.
组织管理
【新增】启用员工
【新增】删除员工

2021-11-29#

1.
消息推送文档
【新增】用户信息变更推送
【新增】用户状态变更推送
【新增】用户注册信息推送

2021-11-26#

1.
推广员管理
【新增】查询推广员客户列表
【修改】查询客户所属推广员新增响应字段distribute_update_time关系变更时间
【修改】查询推广员的下级推广员列表新增响应字段bind_time最新绑定时间

2021-11-18#

1.
素材管理
【新增】获取素材列表
【新增】获取素材分组列表
【新增】素材分组编辑
【新增】素材分组移动
【新增】素材分组删除

2021-11-17#

1.
用户管理
【修改】获取用户消费信息新增响应字段user_list.bought_products.tm商品购买时间
2.
活动管理
【新增】获取活动报名列表
【新增】获取活动签到信息

2021-11-16#

1.
用户管理
【新增】获取用户列表2.0

2021-11-10#

1.
消息推送文档
【修改】订单状态推送新增action用户领取赠送课程user_receive_gift_class

2021-11-08#

1.
消息推送文档
【新增】活动签到推送
2.
商品管理
【新增】获取商品分组内商品列表

2021-11-05#

1.
商品管理
【新增】批量新建/更新商品分组
【新增】删除商品分组
【新增】获取店铺商品分组列表

2021-11-04#

1.
活动管理
【新增】获取活动列表
【新增】获取签到列表
2.
打卡管理
【新增】获取打卡列表
【新增】获取打卡参与用户
【新增】获取指定学员活动日记列表
【新增】获取活动点赞列表
【新增】获取指定学员被点赞总数和列表
【新增】获取用户日记被点评/评论列表

2021-11-03#

1.
消息推送文档
【新增】商品变更推送

2021-10-28#

1.
学习数据管理
【修改】获取指定资源学习记录信息新增筛选字段stay_time看课学习时长
2.
用户管理
【修改】获取用户消费信息新增响应字段total用户总数、collection_phone采集手机号等

2021-10-21#

1.
学员管理(限企学院)
【新增】企学院添加学员
【新增】企学院修改学员
【新增】企学院删除学员

2021-10-14#

1.
解决方案
【新增】SDK&H5账号详解

2021-09-27#

1.
订购管理
【新增】查询用户资源权益2.0
2.
推广员管理
【新增】新增推广员
【新增】绑定客户的推广员
【新增】修改/解绑客户所属推广员
【新增】设置推广员上级
3.
解决方案
【新增】同步页面统计场景
【新增】同步学习数据场景

2021-09-15#

1.
学员管理(限企学院)
【新增】企学院添加组织架构
【新增】企学院删除组织架构
【新增】企学院编辑组织架构
【新增】企学院获取组织架构
【新增】企学院获取部门信息
【新增】企学院获取学员列表
2.
培训计划管理(限企学院)
【新增】获取员工的培训计划列表

2021-09-13#

1.
学习数据管理
【新增】获取每日学习记录

2021-09-09#

1.
订单管理
【修改】获取订单列表1.1新增响应字段goods_img商品主图链接
2.
用户管理
【修改】更新用户信息新增请求参数 update_data.wx_union_id字段

2021-09-07#

1.
消息推送文档
【修改】订单支付推送新增推送字段channel_id页面统计id和channel_name页面统计名称
2.
订单管理
【修改】获取订单详情新增响应字段channel_id页面统计id和channel_name页面统计名称
3.
页面统计管理
【新增】新建页面统计
【新增】编辑页面统计
【新增】获取页面统计列表
【新增】获取页面统计详情
【新增】获取页面统计订单列表
【新增】新建投放渠道
【新增】获取投放渠道列表

2021-08-31#

1.
解决方案
【修改】同步用户场景更新流程说明图
【修改】同步商品场景更新流程说明图
2.
订单管理
【修改】获取订单详情1.0:新增响应字段after_sales_state售后单状态
【修改】获取订单详情1.1:新增响应字段after_sales_state售后单状态

2021-08-23#

1.
商品管理
【修改】获取订单详情:新增响应字段is_modified_amount 是否可以改价 和 must_not_modified_amount_reason 不可修改价格原因

2021-08-06#

1.
商品管理
【新增】获取训练营营期任务

2021-07-29#

1.
解决方案
【新增】同步积分信息场景
2.
消息推送
【新增】积分变更消息推送

2021-07-26#

1.
商品管理
【修改】查询专栏的资源列表4.0.0 resource_type 新增大专栏 和 训练营

2021-07-21#

1.
用户管理
【新增】查询用户合并记录
2.
订单管理
【新增】获取订单详情

2021-07-16#

1.
获取access_token文档
【修改】 添加各语言获取access_token的Demo示例

2021-07-14#

1.
直播管理
【新增】签到记录列表
【新增】签到学员列表

2021-07-12#

1.
组织管理
【新增】获取员工详细信息
【新增】获取组织结构树
【新增】获取员工列表
【新增】停用员工
【新增】添加或者保存员工信息
【新增】移除组织架构
【新增】添加或修改组织架构

2021-07-08#

1.
用户管理
【修改】查询单个用户信息 请求参数新增field_list.wx_email 微信邮箱 字段

2021-07-03#

1.
直播管理
【修改】获取直播列表 返回值新增讲师列表信息

2021-07-01#

1.
物流管理
【新增】普通实物单发货

2021-06-28#

1.
商品管理
【修改】查询商品列表 API支持查询会员,大专栏

2021-06-25#

1.
考试管理
【新增】获取考试结果列表信息
【新增】获取考试结果详情信息

2021-06-23#

1.
用户管理
【新增】获取课程学员列表信息

2021-06-22#

1.
消息推送文档
【新增】订单状态推送

2021-06-18#

1.
内嵌SDK服务场景
【新增】小鹅通SDK开发者声明
【新增】小鹅通SDK个人信息保护指南
2.
消息推送文档
【新增】考试消息推送
3.
商品管理
【新增】查询专栏的资源列表4.0.0

2021-06-17#

1.
订购管理
【修改】用户开通产品包权益接口修改payment_type字段,具体查看接口备注信息
2.
订单管理
【修改】获取订单列表1.1接口查询字段begin_time字段和end_time修改

2021-06-16#

1.
推广员管理
【修改】查询推广员列表, 查询推广员的下级用户列表, 查询指定推广员的信息 返回值增加level字段,表示推广员等级

2021-06-15#

1.
开发者日志查询工具:登录云服务控制台,[应用详情] - [运维管理] - [请求日志] / [消息推送日志],即可查看日志详情,辅助开发

2021-06-11#

1.
积分
【新增】获取店铺积分概览

2021-05-28#

1.
用户
【修改】获取学习记录表接口, 获取指定资源学习记录信息接口:去掉shop_id字段
【修改】获取用户信息接口:返回参数增加phone_resource字段
2.
积分
【新增】获取用户流水明细
【新增】获取单个用户账户信息
【新增】获取用户积分列表
【新增】批量发放积分
【新增】批量扣减积分
【新增】解冻冻结积分
【新增】设置店铺积分过期时间

2021-05-18#

1.
API列表
【新增】接口限制频率
2.
用户
【修改】获取用户信息接口:data.phone field_list.phone 添加备注

2021-05-17#

1.
培训
【新增】获取培训计划列表
【新增】获取培训计划详情
【新增】获取用户培训学习数据

2021-05-14#

1.
用户
批量获取用户信息2.0:升级API,调整请求参数,调整返回字段

2021-04-28#

1.
优惠券
优惠券列表
用户领取优惠券2.0:升级1.0 API,优化请求参数,新增返回字段
获取优惠券详情2.0:升级1.0 API,调整请求参数,新增返回字段
优惠券核销:更新优惠券为已使用状态
2.
调用场景新增内嵌SDK服务场景说明:SDK适用于具有一定开发能力商家,需在自有客户端内搭建店铺的商家。内嵌SDK服务场景说明文档

2021-04-03#

1.
用户:更新[获取指定资源学习记录信息API],[查询单个用户标签列表API];
2.
内容:发布[获取课程列表API];
3.
班课:发布[获取班课列表API];
4.
直播:发布[获取直播列表API];
5.
微页面:发布[获取微页面列表API]。

2021-02-01#

1.
用户:发布[获取用户列表API];
2.
商品:发布[获取商品列表API];
3.
信息采集:以内测形式提供部分信息采集接口;
4.
推广员:以内测形式提供部分推广员接口;
5.
订单:发布[获取订单列表1.1API];优化订单消息推送字段。

2020-02-27#

1.
订单:[获取订单列表API]已结束内测,现已正式发布。

2020-01-14#

1.
发布新版的[获取订单列表API],调用接口可查询订单列表;
2.
订单消息推送,新增“商品编码”字段。 特别说明:上述接口和字段目前正处于内测阶段,会逐步开放。

2019-12-9#

发布小鹅通云服务,API的开发信息和配置统一在云控制台完成。调用方式由原来的app_id + app_secret改为app_id + client_id + client_secret。

2019-8-12#

发布新版api,启用新的鉴权方式。

2018-6-22#

取消轮播图、资源详情、评论、点赞、组合、消息通知等相关接口。

2018-3-30#

1.
订单:订单查询增加2.0版本:提供查询买赠订单、拼团订单,订单中增加优惠券使用的情况。

2018-02-10#

调整用户注册和订购关系打通的策略(见简介和用户注册接口)。

2018-01-05#

专栏/会员详情接口添加会员的过期时间。
上一页
小鹅云介绍
下一页
开始开发
Built with