小鹅通 · 云服务 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
        POST
      • 订单查询2.0
        POST
    • 订购
      • 订阅列表查询
      • 订阅用户列表查询
      • 取消订阅
  • 常见问题
    • 问题汇总
    • 问题反馈
  1. 订单

订单查询2.0

POST
https://api.xiaoe-tech.com/open/order.list.get/2.0
简要描述:
查询订单列表
新增数据:
如果订单有使用优惠券,会返回coupon_name和coupon_price字段
请求字段payment_type增加了4/5两个值,分别对应买赠和拼团的订单
当请求字段payment_type=4时,返回gitf_buy_count字段代表买的数量
当请求字段payment_type=5时,返回team_buy_state字段代表拼团状态
返回说明:
备注
更多返回错误代码请看首页的错误代码描述
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.xiaoe-tech.com/open/order.list.get/2.0' \
--header 'Content-Type: application/json' \
--data-raw '{
    "order_by": "string",
    "page_index": "string",
    "page_size": "string",
    "user_id": "string",
    "begin_time": "string",
    "end_time": "string",
    "order_state": "string",
    "resource_type": "string",
    "payment_type": "string",
    "client_type": "string"
}'
响应示例响应示例
{
  "code": 0,
  "msg": "success",
  "data": [
    {
      "id": "i_59474896580bf_WOLsUClD",
      "user_id": "u_58a6e7fce06ea_BYfDHyBu",
      "order_id": "o_1497603468_59439d8c46465_23517845",
      "title": "测试图文",
      "resource_type": 1,
      "price": 1800,
      "order_state": 1,
      "payment_type": 2,
      "out_order_id": "oo_59bfc27566c4c_Ex42L5xW",
      "system_info": "Mozilla/5.0 (iPhone; CPU iPhone OS 10_2 like Mac OS X) AppleWebKit/602.3.12 (KHTML, like Gecko) Mobile/14C92 MicroMessenger/6.5.14 NetType/4G Language/zh_CN",
      "client_type": 1,
      "created_at": "2017-10-20 15:20:32",
      "coupon_name": "新人优惠",
      "coupon_price": 100,
      "gitf_buy_count": 2,
      "team_buy_state": 2,
      "receiver_name": "xxx",
      "receiver_detail": "xxxx",
      "receiver_phone": "xxxx"
    }
  ]
}

请求参数

Body 参数application/json
order_by
string 
可选
排序方式。格式为column:asc/desc,column可选值:created_at ,默认为created_at:desc
page_index
string 
可选
页码,从0开始 ,默认为0
page_size
string 
可选
每页请求条数,最大支持50,默认取10条
user_id
string 
用户id
可选
begin_time
string 
可选
查询起始时间,unix 时间戳。与end_time的差值不能超过86400(24小时),如果为空,则默认取以end_time为准24小时前的时间戳
end_time
string 
可选
查询结束时间,unix 时间戳。与begin_time的差值不能超过86400(24小时),如果为空,则默认取当前最新时间戳
order_state
string 
可选
订单状态:0-未支付 1-支付成功 2-支付失败 3-已退款(如拼团未成功等情况) 6-订单超时未支付,自动取消
resource_type
string 
可选
查询单笔资源时(即payment_type=2时)需传入该参数,1-图文 2-音频 3-视频 4-直播 5-活动 7-社群 不填查全部类型
payment_type
string 
可选
付费类型 2-单笔 3-订阅付费产品包(专栏和会员) 4-购买赠送 5-拼团 默认取出这四种类型的所有订单
client_type
string 
可选
购买时使用的客户端类型,0-小程序 1-公众号 10-开放平台 12-App,不填查全部类型
示例

返回响应

🟢200成功
application/json
Body
code
integer 
必需
msg
string 
必需
data
array [object {23}] 
必需
id
string 
资源id
可选
user_id
string 
用户id
可选
order_id
string 
订单id
可选
title
string 
资源名
可选
resource_type
integer 
可选
0-无(产品包),1-图文 2-音频 3-视频 4-直播 5-活动 7-社群(payment_type为2时该这段有意义)
price
integer 
价格,单位为分
可选
order_state
integer 
可选
订单状态:0-未支付 1-支付成功 2-支付失败
payment_type
integer 
可选
2-单笔,3-订阅付费产品包,5-单笔的购买赠送,6-订阅付费产品包的购买赠送,13-单笔的拼团,14-订阅付费产品包的拼团
out_order_id
string 
外部订单
可选
system_info
string 
可选
用户下单时所用的设备信息
client_type
integer 
可选
购买时使用的客户端类型,0-小程序 1-公众号 10-开放平台 12-App
created_at
string 
订单时间
可选
coupon_name
string 
优惠券名称
可选
coupon_price
integer 
可选
优惠价钱(单位:分)
gitf_buy_count
integer 
可选
购买赠送的订单中一次买的数量
team_buy_state
integer 
可选
拼团状态:0-进行中 1-拼团成功 2-拼团失败
receiver_name
string 
收件姓名
可选
receiver_detail
string 
收件地址
可选
receiver_phone
string 
收件人电话
可选
distribute_price
integer 
分销提成(分)
可选
distribute_percent
integer 
可选
分销比例(百分点1-100)
superior_distribute_price
integer 
上级分销提成(分)
可选
superior_distribute_percent
integer 
可选
上级分销比例(百分点1-100)
上一页
订单查询1.0
下一页
订阅列表查询
Built with