获取订单列表1.1

拥有此API的权限集
订单管理-查询

请求方式及url

  • 请求方式:POST
  • 请求头:Content-Type:application/json
  • 接口地址:https://api.xiaoe-tech.com/xe.order.list.get/1.0.1
  • 频率限制:10秒3000次

在线调试工具

请求

响应

请求参数

参数名 必选 类型 说明
access_token string 专属token
order_by string 排序方式。格式为column:asc/desc,column可选值:created_at ,默认为created_at:asc
page_index string 页码,从1开始 ,默认为1
page_size string 每页请求条数,最大支持200,默认取200条
order_id string 订单id
resource_id string 资源id
transaction_id string 交易单号
out_order_id string 商户单号
user_id string 用户id
begin_time string 查询created_time的起始时间,unix 时间戳,单位为秒。与end_time的差值不能超过7天,如果为空,则默认取以end_time为准24小时前的时间戳
end_time string 查询created_time的结束时间,unix 时间戳,单位为秒。与begin_time的差值不能超过7天,如果为空,则默认取当前最新时间戳
order_state int 订单状态:0-未支付,1-支付成功,3-已退款(如拼团未成功等情况),6-订单超时未支付,自动取消,7-手动取消,8-退款中,9-退款失败,10-退款成功,11-部分退款
ship_state int 发货状态:0-禁止发货,1-未发货,2-已发货,3-已收货,4-部分发货
sales_state int 售后状态:1-部分退款、2-全部退款、 -1-默认值(没有进行售后)
resource_type int 资源类型:1-图文,2-音频,3-视频,4-直播,5-会员,6-专栏,8-大专栏,7-圈子 ,20-电子书,21-实物商品,23-超级会员,25-训练营,29-线下课,31-小班课,35-大班课,41-有价优惠券,42-课时包,45-AI互动课,50-课程(训练营pro),68-服务类商品,不填查全部类型
client_type int 购买时使用的客户端类型:0-小程序,1-公众号,2-QQ,3-支付宝,4-安卓,5-mobileWeb H5,6-IOS Android App工具,10-开放api导入,11-PC端 ,12-APP,13-线下订单,14-小鹅通助手APP内嵌H5,15-通用化APP下单,16-微博-H5微信,21-APP内嵌H5,22-百度小程序,30-管理台导入订单,31-积分兑换,32-企业微信,33-视频号小程序来源,34-鹅直播小程序,35-视频号小程序新流程来源,36-鹅小店视频号分销(平台级),37-快手小程序,41-小鹅通小店,88-抖音小程序,89-品牌APP

请求示例

{
    "access_token":"xe_xxxxx",
    "order_id":"o_xxxx",
    "begin_time":1629203700,
    "end_time":1629204057,
    "page_size":"1",
    "page_index":"100"
}

返回参数

参数名 类型 说明
total int 数据总条数,只在获取首页数据时返回,非首页则返回0
order_id string 订单id
user_id string 用户id
resource_type int 资源类型:1-图文,2-音频,3-视频,4-直播,5-会员,6-专栏,8-大专栏,7-社群 ,9-活动报名,20-电子书,21-实物商品,23-超级会员,25-训练营,29-线下课,31-小班课,35-大班课,41-有价优惠券
resource_id string 资源id
title string 资源名
count int 购买个数
order_type array 订单类型:2-普通订单,4-买赠订单,6-拼团订单,26-秒杀订单,27-砍价订单,8-优惠券订单,10-邀请码订单,12-兑换码订单,14-会员续费订单,16-限时折扣订单,18-好友助力订单,20- 涨粉神器订单,22-推广员订单,24-裂变海报分销订单,28-第三方平台分销订单,31-内容分销-本店售出,38-好课人人推-渠道售出,30-开放API导入订单,35-线下课堂,36-班课订单,37-超级会员(正式)订单,39-超级会员(体验)订单,40-积分兑换订单,66-其他订单,68-课程带货订单,69-实物带货订单,70-管理台导入订单,71-兑奖订单,74-积分抵扣订单,75-优惠码订单,72直播带货订单,同一笔订单可能有多个订单类型
price int 实付价格,单位:分
discount_data array 优惠详情:明细
discount_price int 活动折扣金额,如:限时折扣、秒杀等活动,单位:分
coupon_id string 优惠券id
coupon_name string 优惠券名称
goods_img string 商品主图链接
goods_no string 商品编码
coupon_price int 优惠券抵扣金额,单位:分
order_state int 订单状态:0-未支付,1-支付成功,3-已退款(如拼团未成功等情况),6-订单超时未支付,自动取消,7-手动取消,8-退款中,9-退款失败,10-退款成功,11-部分退款
ship_state int 发货状态:0-禁止发货,1-未发货,2-已发货,3-已收货,4-部分发货
team_buy_state int 拼团状态:0-进行中 1-拼团成功 2-拼团失败 -1-非拼团订单
after_sales_state int 售后单状态:0-没有相关售后单 1-存在未处理售后单 2-存在已处理售后单
pay_way int 支付方式 -1-未指定支付方式 0-线上微信 1-线上支付宝 2-IOS支付 3-安卓支付 4-线下支付 5-百度支付 7-虚拟币支付 9-抖音支付 11-IOS虚拟币支付 13-小鹅币支付
collection_way int 收款方式:0-微信商户自有、1-小鹅通知识助手账户、2-微信电商收付通、3-虚拟币收款、4-支付宝直付通、5-抖音微信收款、6-抖音支付宝收款、7-视频号自有收款账户、8-快手微信收款、9-快手支付宝收款、10-IOS虚拟币账户
out_order_id string 外部订单
transaction_id string 交易单号
client_type int 数据来源 0-小程序,1-公众号,2-QQ,3-支付宝,4-安卓,5-mobileWeb H5,6-IOS Android App工具,10-开放api导入,11-PC端 ,12-APP,13-线下订单,14-小鹅通助手APP内嵌H5,15-通用化APP下单,16-微博-H5微信,21-APP内嵌H5,22-百度小程序,30-管理台导入订单,31-积分兑换,32-企业微信,33-视频号小程序来源,34-鹅直播小程序,35-视频号小程序新流程来源,36-鹅小店视频号分销(平台级),37-快手小程序,88-抖音小程序,89-品牌APP
system_info string 用户下单时所用的设备信息
created_time string 订单创建时间
pay_time string 支付时间
refund_time string 退款时间
settle_time string 结算时间
refund_money int 退款金额,单位是分
receiver_name string 收件姓名
receiver_detail string 收件地址
receiver_phone string 收件人电话

返回示例

{
    "code": 0,
    "msg": "",
    "data": {
        "total": 1,    //总条数
        "list": [
            {
                "order_id": "o_xxxx",
                "user_id": "u_xxx",
                "resource_type": 6,
                "resource_id": "p_xxxx",
                "title": "测试",
                "count": 1,
                "price": 0,
                "coupon_id": "cu_xxxx",
                "coupon_name": "测试",
                "coupon_price": 2,
                "order_state": 1,
                "ship_state": 0,
                "sales_state": -1,
                "pay_way": 0,
                "collection_way": -1,
                "out_order_id": "",
                "transaction_id": "",
                "client_type": 1,
                "system_info": "Mozilla/5.0 (Linux; Android 10; MI 8 Build/QKQ1.190828.002; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/77.0.3865.120 MQQBrowser/6.2 TBS/045512 Mobile Safari/537.36 MMWEBID/4882 MicroMessenger/7.0.15.1680(0x27000F50) Process/tools WeChat/arm32 NetType/4G Language/zh_CN ABI/arm64",
                "created_time": "2021-01-12 19:08:54",
                "pay_time": "2021-01-12 19:08:55",
                "refund_time": "0000-00-00 00:00:00",
                "after_sales_state": 0,
                "settle_time": "o_xxxx",
                "refund_money": "",
                "receiver_name":"xxx",                        //收件姓名
                "receiver_detail":"xxxx",                    //收件地址
                "receiver_phone":"xxxx"                        //收件人电话
                "order_type": [  // 例如:订单类型是6和8,拼团和优惠券
                    6,
                    8
                ],
                "discount_price": 10,
                "discount_data": [
                    {
                        "discount_name": "拼团优惠",
                        "discount_type": 6,
                        "discount_price": 8
                    },
                    {
                        "discount_name": "优惠券抵扣",
                        "discount_type": 1,
                        "discount_price": 2
                    }
                ],
                "team_buy_state": 1
            }
        ]
    }
}

备注

  • 传参如果传了order_id,out_order_id,transaction_id,user_id这4种类型表示精准搜索,精准搜索时,如果未传时间参数,那么将不受时间参数限制。
  • discount_data为优惠明细,数组类型:discount_data.discount_type分为:3-限时折扣,6-拼团优惠/团长优惠,7-涨粉神器,1-优惠券折扣,11-优惠码折扣,102-兑换码开通,100-邀请码开通,8-秒杀,27-砍价,2-超级会员,103-ios波豆,104-安卓波豆

results matching ""

    No results matching ""