Skip to content

获取订单列表1.0

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

接口描述

  • 获取订单列表,该版本较老,不再维护,推荐使用“订单列表2.0”接口来获取订单列表

请求方式及url

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

接口调试

请求参数
响应结果
暂无响应数据

请求参数

参数名必选类型说明
access_tokenstring专属token
order_bystring排序方式。格式为column:asc/desc,column可选值:created_at ,默认为created_at:desc
page_indexstring页码,从0开始 ,默认为0
page_sizestring每页请求条数,最大支持50,默认取10条
user_idstring用户id
begin_timestring查询起始时间,unix 时间戳,单位为秒。与end_time的差值不能超过86400(24小时),如果为空,则默认取以end_time为准24小时前的时间戳
end_timestring查询结束时间,unix 时间戳,单位为秒。与begin_time的差值不能超过86400(24小时),如果为空,则默认取当前最新时间戳
order_stateint订单状态:0-未支付 1-支付成功 2-支付失败 3-已退款(如拼团未成功等情况) 6-订单超时未支付,自动取消
resource_typeint查询单笔资源时(即payment_type=2时)需传入该参数,1-图文 2-音频 3-视频 4-直播 5-活动 7-圈子 不填查全部类型
payment_typeint付费类型 2-单笔 3-订阅付费产品包(专栏和会员) 4-购买赠送 5-拼团 默认取出这四种类型的所有订单
client_typeint购买时使用的客户端类型:0-小程序,1-公众号,10-开放api导入,11-PC ,12-APP,13-线下订单,15-APP内嵌SDK,5-手机号,2-QQ,20-抖音,30-管理台导入, 31-积分兑换,32-企业微信,不填查全部类型
goods_nostring商品编码

请求示例

  {
	"access_token":"xe_xxxxx",
	"data":{
		"user_id":"u_xxxx",
		"resource_type":1,
		"payment_type":2
	}
}

返回参数

参数名类型说明
idstring资源id
order_idstring订单id
user_idstring用户id
priceint价格,单位为分
titlestring资源名
order_stateint订单状态:0-未支付 1-支付成功 2-支付失败 6-订单过期 10-退款成功
payment_typeint2-单笔,3-订阅付费产品包,5-单笔的购买赠送,6-订阅付费产品包的购买赠送,13-单笔的拼团,14-订阅付费产品包的拼团
out_order_idstring外部订单
resource_typeint0-无(产品包),1-图文 2-音频 3-视频 4-直播 5-活动 7-圈子(payment_type为2时该这段有意义)
system_infostring用户下单时所用的设备信息
distribute_priceint分销提成(分)
distribute_percentint分销比例(百分点1-100)
coupon_namestring优惠券名称
coupon_priceint优惠价钱(单位:分)
gitf_buy_countint购买赠送的订单中一次买的数量
team_buy_stateint拼团状态:0-进行中 1-拼团成功 2-拼团失败
created_atstring订单时间
after_sales_stateint售后单状态:0-没有相关售后单 1-存在未处理售后单 2-存在已处理售后单
superior_distribute_priceint上级分销提成(分)
superior_distribute_percentint上级分销比例(百分点1-100)
pay_wayint支付方式 -1-未指定支付方式 0-线上微信 1-线上支付宝 2-IOS支付 3-安卓支付 4-线下支付
cu_idstring优惠券id
related_idstring拼团活动中用户开团的标示ID
refund_timestring退款时间
settle_timestring结算时间
client_typeint数据来源 0-小程序 1-公众号 10-开放平台 11-PC通用版 12-App 13-线下订单 20-抖音小程序 21-app内嵌H5
goods_nostring商品编码
receiver_namestring收件姓名
receiver_detailstring收件地址
receiver_phonestring收件人电话
备注
  • 如果订单有使用优惠券,会返回coupon_name和coupon_price字段
  • 请求字段payment_type增加了4/5两个值,分别对应买赠和拼团的订单
  • 当请求字段payment_type=4时,返回gitf_buy_count字段代表买的数量
  • 当请求字段payment_type=5时,返回team_buy_state字段代表拼团状态

返回示例

{
    "code": 0,
    "msg": "success",
    "data": [
        {
            "id": "i_ccccccccc04",
            "order_id": "o_ccccccc",
            "user_id": "u_xxxxxxxxx",
            "price": 0,
            "title": "test 001",
            "pay_way": 0,
            "cu_id": "cu_xxxxxxxHuh",
            "related_id": "",			
            "order_type": "优惠券订单,推广员订单",
            "refund_time": "0000-00-00 00:00:00",
            "settle_time": "2021-06-25 01:27:34",
            "resource_type": 1,
            "order_state": 1,
            "payment_type": 2,
            "out_order_id": null,
            "system_info": "x",
            "client_type": 1,
            "created_at": "2021-06-25 01:27:34",
            "after_sales_state": 0,

            "distribute_price": 0,
            "distribute_percent": "40.0000",
            "superior_distribute_price": 0,
            "superior_distribute_percent": "40.0000",
            "coupon_name": "xxxxx",
            "coupon_price": 6,
            "goods_no": "",
            "receiver_name": "",
            "receiver_detail": "",
            "receiver_phone": ""
        }
    ]
}