Appearance

获取订单列表2.0 ​

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

请求方式及url ​

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

接口调试

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

请求参数 ​

参数名必选类型说明
access_token是string专属token
aftersale_show_state否int售后状态 0-无 1-售后中 2-部分退款 3-全额退款
order_state否int订单状态 0-待付款 1-待成交 2-待发货 3-已发货 4-已完成 5-已关闭
settle_status否int结算状态 0-待结算 1-结算中 2-结算完成
page否int页码，从1开始，不传默认为1
page_size否int单页记录条数，限制100以内，不传默认为100
user_id否string用户ID，示例：u_62cbf09430aa2_3pcvv3UNJ1
order_id否string订单号，示例：o_1657532578_62cbf0a27b7b1_313860000
order_type否string订单类型 1-交易订单 2-导入订单 3-渠道采购订单（内容市场）4-兑换订单
created_time_start是string下单时间，开始，与结束时间的差值不能超过31天，示例：2022-01-01 00:00:00
created_time_end是string下单时间，截止，示例：2022-01-01 00:00:00
settle_time_start否string结算时间，开始，示例：2022-01-01 00:00:00
settle_time_end否string结算时间，截止，示例：2022-01-01 00:00:00
pay_time_start否string支付时间，开始，示例：2022-01-01 00:00:00
pay_time_end否string支付时间，截止，示例：2022-01-01 00:00:00
update_time_start否string更新时间，开始，示例：2022-01-01 00:00:00
update_time_end否string更新时间，截止，示例：2022-01-01 00:00:00
order_by否string排序条件，默认按筛选时间进行排序，可传created_at、pay_time、settle_time、updated_at
marketing_play否array营销玩法筛选，1-推广员 2-裂变海报分销 3-优惠劵 4-优惠码 5-拼团 6-限时折扣 7-秒杀 8-积分抵现 9-（体验）超级会员折扣 10-（正式）超级会员折扣 11-续费 12-满包邮 13-邀请码 14-兑换码 15-积分兑换 16-抽奖兑换（直播间） 17-涨粉神器 18-打包售卖 19-支付有礼 20-买赠（送好友） 21-圈子分享有赏 22-花呗分期免息 23-直播间任务奖励 24-等级会员折扣 25-门店推广 26-等级会员专属商品 27-社群接龙玩法 28-兑换券 29-等级会员价  目前只能传单数组[1]到[29] 筛选订单
order_asc否string排序规则，asc默认排序

特殊说明

若传多个时间条件筛选订单，筛选时间与默认排序时间的优先级如下： pay_time > settle_time > updated_time > created_time

若所有时间条件都不传，假设当天时间为2023-04-18，则默认筛选的订单条件为： created_at >= '2023-03-19 00:00:00' AND created_at <= '2023-04-19 00:00:00'

其他筛选时间场景如下图：

请求示例 ​

{
  "access_token":"xe_xxxxx",
  "page":0,
  "page_size":1,
  "aftersale_show_state":1,
  "settle_status":0,
  "order_state":1,
  "created_time_start":"2022-11-14 00:00:00",
  "created_time_end":"2022-11-14 12:00:00"    
}

返回参数 ​

参数名类型说明
codeint请求结果码
msgstring描述信息
data.listarray订单列表
data.pageint页码
data.page_sizeint单页记录条数
data.totalint总数

data.list订单列表

参数名类型说明
order_infoobject订单详情
order_info.app_idstring店铺ID
order_info.user_idstring下单用户ID
order_info.trade_idstring父单号
order_info.order_idstring订单号
order_info.wx_app_typeint终端类型，0-小程序，1-微信(公众号)，2-qq ，3-支付宝，4-安卓app 5-浏览器/手机号，6-iOS Android App工具，10-开放平台，11-PC，12-小鹅通app（吴晓波，13-线下订单，14-小鹅通助手app，15-APP内嵌SDK，16-微博端浏览器，20-抖音小程序(已废弃)，21-App内嵌h5，22-百度小程序，30-管理台导入订单，31-积分兑换，32-企业微信，33-视频号小程序，34-鹅直播小程序，35-视频号小程序(自定义交易组件)订单，36-视频号分销小程序，40-视频号小店，88-抖音小程序订单
order_info.pay_typeint支付渠道，-1-无(0元订单) 1-线上微信 2-线上支付宝 3-线下支付 4-百度收银台 8-虚拟币 9-支付宝花呗
order_info.channel_typeint渠道类型 0-商详页 1-直播间 2-广告渠道
order_info.channel_bus_idstring渠道业务id
order_info.share_typestring分享类型 0-无 1-音频分享 2-日签分享 3-专栏分享 4-邀请卡分享 5-推广分销分享 6-推广分销平台 7-精选商城商铺分享 8-裂变海报分销分享 10-分销员模式 100-分享其它页面的默认类型
order_info.share_user_idstring分享人ID
order_info.actual_feeint订单实付总金额（分）
order_info.goods_original_total_priceint商品总金额（分）
order_info.discount_amountint活动折扣总金额（分）
order_info.deduct_amountint资产抵扣总金额（分）
order_info.freight_original_priceint原始运费（分）
order_info.freight_actual_priceint实际运费（分）
order_info.modified_amountint修改金额(优惠减免)（分）
order_info.refund_feeint已退款金额（分）
order_info.goods_buy_numint购买数量
order_info.goods_namestring商品名称
order_info.goods_spu_typeint商品一级类型 0-知识商品 1-实物商品 2-服务类商品 3-打赏 4-红包
order_info.goods_spu_sub_typestring商品二级类型
order_info.order_typeint订单类型 1-交易订单 2-导入订单 3-渠道采购订单（内容市场）4-兑换订单
order_info.sub_order_typeint子订单类型 0-无 1-api导入 2-管理台导入 3-线下课导入 4-带货 5-买赠优惠 6-支付有礼
order_info.order_stateint订单状态 0-待付款 1-待成交 2-待发货 3-已发货 4-已完成 5-已关闭
order_info.order_state_timestring订单状态变化时间，例0000-00-00 00:00:00
order_info.activity_type_bitmaparray|null参与的营销活动类型，未参与时返回null
营销活动类型：1-邀请码 2-优惠券 3-买赠 4-拼团 5-限时折扣 6-秒杀 7-好友助力 8-涨粉神器 9-裂变海报 10-砍价 11-兑换码 12-优惠码 13-积分兑换 14-兑奖 15-课程带货 16-实物带货 17-满包邮、18-续费 19-超级会员折扣 20-超级会员(体验)订单、21-超级会员(正式)订单 22-积分抵扣 23-好友裂变
order_info.distribute_type_bitmaparray|null参与的分销类型，未参与时返回null
分销类型：1-推广员 2-内容市场 3-裂变海报 4-人人分销 5-精选商城 6-第三方分销平台
order_info.relation_order_typeint0-无，1-带货主订单 2-带货副订单 3-买赠优惠主订单 4-支付有礼主订单 5-渠道方主订单 6-内容方主订单
order_info.relation_order_idstring关联订单id（渠道方订单号）
order_info.relation_order_appidstring关联订单的appid
order_info.order_close_typeint关闭类型:0-未关闭 1-自动取消 2-用户手动取消 3-商家取消 4-全额退款 5-拼团失败 6-系统取消
order_info.use_collectionint收款账户类型 -1-无收款账户 0-商户自有 1-小鹅通微信知识助手 2-小鹅通服务商 3-虚拟币 4-线下账户 5-抖音服务商 6-微信视频号服务商（针对交易组件升级）
order_info.pay_stateint支付状态：0-未支付 1-支付成功 2-支付关闭
order_info.pay_state_timestring支付时间，例0000-00-00 00:00:00
order_info.ship_way_choose_typeint发货方式选择类型: 0-无需选择 1-快递配送 2-到店自提
order_info.check_stateint核销状态 0-无 1-待核销 2-已核销 3-已失效 4-部分核销
order_info.settle_stateint结算状态 0-待结算 1-结算中 2-结算完成
order_info.settle_state_timestring结算状态变化时间，例0000-00-00 00:00:00
order_info.aftersale_show_stateint售后状态 0-无 1-售后中 2-部分退款 3-全额退款
order_info.aftersale_show_state_timestring售后状态变化时间，例0000-00-00 00:00:00
order_info.refund_timestring退款时间，例0000-00-00 00:00:00
order_info.update_timestring更新时间，例例0000-00-00 00:00:00
order_info.created_timestring下单时间，例例0000-00-00 00:00:00
order_info.order_remarksstring商家备注内容
order_info.order_tag_typeint订单标记 0-无 1-红，2-橙，3-绿，4-浅蓝，5-深蓝
payment_infoobject支付信息（订单支付完成才有该字段）
payment_info.third_order_idstring第三方交易单号
payment_info.out_order_idstring商户单号
payment_info.sub_merchant_idstring子商户号
buyer_infoobject下单用户信息
buyer_info.nicknamestring用户昵称
buyer_info.avatar_urlstring用户头像
buyer_info.phone_numberstring用户手机号
buyer_info.commentstring用户留言
buyer_info.union_idstring用户微信union_id
price_infoobject订单价格信息
price_info.total_priceint商品原价总价（分）
price_info.freight_priceint运费（分）
price_info.total_modified_amountint总改价金额（分）
price_info.goods_modified_amountint商品改价金额（分）
price_info.freight_modified_priceint运费改价金额（分）
price_info.origin_priceint订单原价（分）
price_info.actual_priceint订单实收金额（分）
ship_infoobject物流信息
ship_info.citystring市
ship_info.companystring物流公司
ship_info.confirm_timestring确认收货时间，默认值0001-01-01 00:00:00
ship_info.countystring区/县
ship_info.detailstring详细地址
ship_info.express_idstring运单号
ship_info.invalid_timestring自动确认收货时间，默认值0001-01-01 00:00:00
ship_info.phonestring联系电话
ship_info.provincestring省
ship_info.receiverstring收货人
ship_info.remarkstring买家留言
ship_info.ship_timestring发货时间，默认值0001-01-01 00:00:00
ship_info.user_idstring用户id
good_listarray商品信息
good_list[].unit_priceint商品单价（分）
good_list[].buy_numint数量
good_list[].total_priceint总价
good_list[].ship_stateint发货状态(-1-无需发货 0-待发货 1-已发货 2-发货失败 3-已收货 4-发货中)
good_list[].check_stateint核销状态 0-无 1-待核销 2-已核销 3-已失效 4-部分核销
good_list[].refund_stateint退款状态 0-无 1-售后中 2-部分退款 3-全额退款
good_list[].goods_namestring商品名称
good_list[].goods_imagestring商品图片
good_list[].spu_typeobjectENT-实物商品,OLC-线下课,OLP-课时包,ITX-图文,ADO-音频,VDO-视频,EBK-电子书,SPC-专栏,BSC-大专栏,TCP-训练营,MMB-会员,BTK-班课,VCP-有价优惠券,ALC-AI互动课,ATV-活动管理,PCD-付费打卡,CMN-小社群,PCT-练习, PAQ-付费问答,ANS-付费问答-答主,ALV-直播,SVP-超级会员,EKC-鹅课程【课程（训练营pro）】,SRV-服务类商品
good_list[].spu_idstring商品spu_id，示例：SPU_ENT_6280592699601HdGIWgf466“
good_list[].sku_idstring商品的sku_id，示例：SKU_ENT_6280592699601uAEIp42
good_list[].goods_descstring商品描述
good_list[].ship_state_descstring发货状态描述
good_list[].refund_state_descstring退款状态描述
good_list[].expire_descstring商品有效期描述（虚拟商品）
good_list[].expire_startstring商品有效期开始时间（虚拟商品）
good_list[].expire_endstring商品有效期结束时间（虚拟商品）
good_list[].period_typeint商品有效期类型 有效期类型：0-长期有效；1-具体时间前有效；2-有效期时间范围（秒）
good_list[].goods_snstring商品编码
good_list[].sku_spec_codestring规格编码
good_list[].relation_goods_typeint关联商品类型: 0-无 1-虚拟带货主商品 2-实物带货主商品 3-内容分销市场主商品 4-总分店总店商品
good_list[].relation_goods_type_descstring关联商品类型描述: 前端展示字段, 在 RelationGoodsType == 1 或 2 的时候, 值为 “套餐商品”, 其他值的时候暂时为空
good_list[].relation_goods_idstring关联商品 ID (order goods id)
good_list[].goods_spec_descstring商品规格描述
good_list[].discounts_infoobject商品优惠信息
good_list[].discounts_info.discount_amount_totalint优惠券总金额（分）
good_list[].discounts_info.discount_countint优惠券数量
good_list[].discounts_info.discount_detailobject优惠明细
good_list[].discounts_info.discount_detail.discount_typestring优惠类型：0-商品优惠券 ，1 店铺优惠券
good_list[].discounts_info.discount_detail.discount_idstring优惠券id
good_list[].discounts_info.discount_detail.discount_namestring优惠券名称
good_list[].discounts_info.discount_detail.discount_priceint优惠券抵扣金额（分）
good_list[].discounts_info.discount_detail.discount_descstring优惠描述

返回示例 ​

{
    "code": 0,
    "msg": "成功",
    "data": {
        "list": [
            {
                "buyer_info": {
                    "avatar_url": "",
                    "comment": "",
                    "nickname": "夢",
                    "phone_number": ""
                },
                "good_list": [
                    {
                        "buy_num": 1,
                        "check_state": 0,
                        "discounts_info": {
                            "discount_amount_total": 1,
                            "discount_count": 1,
                            "discount_detail": [
                                {
                                    "discount_desc": "满减",
                                    "discount_id": "cu_63713825c0492_89IFD4WJ",
                                    "discount_name": "0.01优惠券",
                                    "discount_price": 1,
                                    "discount_type": "店铺优惠券"
                                }
                            ]
                        },
                        "expire_desc": "--",
                        "expire_end": "--",
                        "expire_start": "--",
                        "goods_desc": "",
                        "goods_image": "https://wechatapppro-12525xxxxxx.file.myqcloud.com/appAKLWLitnxxxx/image/158813b5eb7802e5b155530cc9977470.png",
                        "goods_name": "超级付费2333",
                        "goods_sn": "--",
                        "goods_spec_desc": "规格:111天",
                        "period_type": 0,
                        "refund_state": 0,
                        "refund_state_desc": "--",
                        "relation_goods_id": "",
                        "relation_goods_type": 0,
                        "relation_goods_type_desc": "",
                        "resource_id": "c_6369fed39f345_iNuZIC4B3467",
                        "resource_type": 7,
                        "ship_state": -1,
                        "ship_state_desc": "已发货",
                        "sku_id": "SKU_CMN_66789089929556KUQJ11",
                        "sku_spec_code": "",
                        "spu_id": "c_6369fed39f345_iNuZIC4B3467",
                        "spu_type": "CMN",
                        "total_price": 2,
                        "unit_price": 2
                    }
                ],
                "order_info": {
                    "actual_fee": 0,
                    "aftersale_show_state": 0,
                    "aftersale_show_state_time": "0000-00-00 00:00:00",
                    "app_id": "appAKLWLitn7978",
                    "channel_bus_id": "",
                    "channel_type": 0,
                    "check_state": 0,
                    "deduct_amount": 0,
                    "discount_amount": 2,
                    "freight_actual_price": 0,
                    "freight_original_price": 0,
                    "goods_buy_num": 1,
                    "goods_name": "超级付费2333",
                    "goods_original_total_price": 2,
                    "goods_spu_sub_type": "CMN",
                    "goods_spu_type": 0,
                    "modified_amount": 0,
                    "order_close_type": 0,
                    "order_id": "o_1668364330_6371382a9cba9_33409596",
                    "order_remarks": "",
                    "order_state": 4,
                    "order_state_time": "2022-11-15 02:34:02",
                    "order_tag_type": 0,
                    "order_type": 1,
                    "pay_state": 1,
                    "pay_state_time": "2022-11-14 02:32:11",
                    "pay_type": -1,
                    "distribute_type_bitmap": null,
                    "activity_type_bitmap": [
                        1,
                        5
                    ],
                    "relation_order_type": 0,
                    "relation_order_id": "",
                    "relation_order_appid": "",
                    "refund_fee": 0,
                    "refund_time": "0000-00-00 00:00:00",
                    "settle_state": 2,
                    "settle_state_time": "2022-11-14 02:32:11",
                    "share_type": 5,
                    "share_user_id": "u_60eea4e553c5a_7B28NjQ8Nq",
                    "ship_way_choose_type": 0,
                    "sub_order_type": 0,
                    "trade_id": "o_1668364330_6371382a9cba9_33409596",
                    "update_time": "2022-11-15 02:34:02",
                    "use_collection": -1,
                    "user_id": "u_60eea4e553c5a_7B28NjQ8Nq",
                    "wx_app_type": 5
                },
                "payment_info": {
                    "out_order_id": "",
                    "third_order_id": ""
                },
                "price_info": {
                    "actual_price": 0,
                    "freight_modified_price": 0,
                    "freight_price": 0,
                    "origin_price": 2,
                    "total_modified_amount": 0,
                    "total_price": 2
                },
                "ship_info": {
                    "city": "深圳市",
                    "company": "",
                    "confirm_time": "0000-00-00 00:00:00",
                    "county": "南山区",
                    "detail": "科兴科学园A2栋9楼",
                    "express_id": "",
                    "invalid_time": "0000-00-00 00:00:00",
                    "phone": "1565791****",
                    "province": "广东省",
                    "receiver": "朱*农",
                    "remark": "",
                    "ship_time": "0000-00-00 00:00:00",
                    "user_id": "u_6139c8c051bb9_pU4WzQFuyR"
                }
            }
        ],
        "page": 1,
        "page_size": 1,
        "total": 17
    }
}