API文档中心

热门接口：产品ID找同款全量维权查询万能转链字符串ID转换 （有API需求可联系本站）

饿了么订单查询接口，售后维权订单查询接口

调用权限：核心接口会员卡调用
 接口测试 
接口使用场景等说明：

本接口用于查询您使用本站API推广的饿了么订单。同时可以查询饿了么售后维权的订单。

订单每10秒更新一次。


特别说明：

正常饿了么佣金比例是4-6%左右，如果出现佣金比例commission_rate为0，而结算预估收入settle为0.01，这类订单是商家没有参与阿里联盟站外推广，正常是没有佣金的。目前饿了么没有区分开参与推广和未参与推广的商家。没有推广的订单由饿了么按0.1%标准补贴。

附：饿了么订单接口名词说明 https://www.veapi.cn/taokelianmeng/556.html 


您如何通过订单接口把订单采集到自己的系统？

本站外卖订单接口除了个别时间受饿了么官方服务器订单延时影响以外，外卖接口都是每10秒更新一次，同时对3天前的订单每半天更新一次以获取旧订单维权等新状态。

因此，您不需要像淘宝联盟、京东联盟等订单接口一样高频率调用。只需要定时采集某个时间段的订单即可。

接口请求地址

环境 http 地址 https 地址
正式环境 http://api.veapi.cn/waimai/ele_orders 暂无

请求方式：GET 或 POST

请求参数

参数名称 参数类型 必填 示例值 描述
vekey String 是 V123M56 公共参数，接口秘钥，请在会员中心获取
order_id String 否 2022111xxxx 饿了么订单号，当指定了本参数后，start_date和end_date参数失效。
sid String 否 2022111xxxx 查询指定sid的订单
order_state Number 否 2 订单状态，0-已失效 1-已下单 2-已付款 4-已收货,不传-全部状态
settle_state Number 否 1 结算状态，1-已结算 2-未结算 ,不传-全部状态
date_type Number 否 1 时间维度，1-付款时间 2-创建时间 3-结算时间 4-更新时间
start_date String 否 2021-09-14 10:00:00 查询起始时间，精确到时分秒。如无order_id入参，则本参数是
end_date String 否 2021-09-14 10:00:00 查询截止时间，精确到时分秒。开始和结束时间不能超过31天
page Number 否 1 页码，默认第一页，取值范围1~100
page_size Number 否 20 每页返回数据大小，默认20，最大返回50
refund Number 否 0 是否查询售后维权订单，仅限0，1，2，含义：0表示不查询售后维权订单，1表示查询维权售后成功的订单，2表示查询所有售后维权的订单

请求示例

  • HTTP
  • PHP
  • JAVA
  • PYTHON
GET/POST  http://api.veapi.cn/waimai/ele_orders?vekey=xx&start_date=2023-03-01+23:59:59&end_date=2023-04-01+23:59:59
使用curl函数，curl不是php原生库，需要安装才能使用

$api="http://api.veapi.cn/waimai/ele_orders?vekey=xx&start_date=2023-03-01+23:59:59&end_date=2023-04-01+23:59:59";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $api);
//curl_setopt($ch, CURLOPT_POST, true);  //POST方式时启用
//curl_setopt($ch, CURLOPT_POSTFIELDS, $postData );  //POST方式时传参

curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);  //如果使用https请启用
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);  //如果使用https请启用
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true );   //返回数据流，不直接输出
curl_setopt($ch, CURLOPT_ENCODING, 'gzip'); //使用gzip压缩传输让访问更快
curl_setopt($ch, CURLOPT_TIMEOUT, 6);  //允许执行的最长秒数。这里设定6S
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);

$result = curl_exec($ch);
$info = curl_getinfo($ch);
curl_close($ch);

echo $result; //返回值
使用okhttp3/httpclient/jsoup/hutool，以hutool为例：

import cn.hutool.http.HttpResponse;
import cn.hutool.http.HttpRequest;

public class testGetParam {

    public static void main(String[] args) {
        // API网址
        String url = "http://api.veapi.cn/waimai/ele_orders?vekey=xx&start_date=2023-03-01+23:59:59&end_date=2023-04-01+23:59:59";
        // JDK 8u111版本后，若目标页面为HTTPS协议，请启用proxy用户密码鉴权
        //System.setProperty("jdk.http.auth.tunneling.disabledSchemes", "");

        // 发送请求
        String result = HttpRequest.get(url)
                .timeout(10000)//设置超时，毫秒
                .execute().body();
        System.out.println(result);
    }
}
推荐使用 requests，支持访问http,https网页：

import requests
		
# 要访问的API网页
target_url = "http://api.veapi.cn/waimai/ele_orders?vekey=xx&start_date=2023-03-01+23:59:59&end_date=2023-04-01+23:59:59"

# 发送请求
response = requests.get(target_url)

# 获取页面内容
if response.status_code == 200:
	print response.text

返回值（JSON）

参数名称 参数类型 示例值 描述
total_count Number 100 当前查询条件下总的记录。可用该字段判断是否还有下一页，您查询了几页*页数，大于total_count就到底了
title String 商品标题 商品标题
pic_url String https://xxx 商品图片下载url
shop_name String xxx店 店铺名称
pay_amount String 30.00 付款金额
settle_amount String 28.00 结算金额，针对CPS订单
trace_time String 2021-09-01 10:00:00 点击时间
tk_create_time String 2021-09-01 10:00:00 创建时间
pay_time String 2021-09-01 10:00:00 付款时间
receive_time String 2021-09-01 10:00:00 收货时间
income String 28.00 预估收入。付款之后有值。没结算之前只有income有值
settle_time String 2021-09-01 11:00:00 结算时间
settle String 24.00 结算预估收入。该值是还没去掉扣除阿里官方技术服务10%和税收10%的佣金；该字段仅在结算之后才有值。real_settle字段是最终到手的预估收入。
特别说明：正常饿了么佣金比例是4-6%左右，如果出现佣金比例commission_rate为0，而结算预估收入settle为0.01，这类订单是商家没有参与阿里联盟站外推广，正常是没有佣金的。因此饿了么补贴0.01元。
settle_state Number 1 结算状态，1-已结算 2-未结算
refund_settle String 24.00 售后维权退还给商家的佣金。只有维权成功的才有值。维权还没有完成的，可以查看refund_info信息。
refund_info Struct - 售后维权信息，仅当有维权时才有本字段信息。
 └─ explain_start_time String 2021-09-01 10:00:00 维权创建时间
 └─ explain_end_time String 2021-09-11 10:00:00 维权结束时间，如无此字段表示还没完成维权
 └─ explain_state Number 0 维权状态，0-维权成功 1-维权创建 2-维权关闭 3-维权失败
 └─ refund_amount String 30.00 维权退款金额
 └─ return_commission_state Number 0 维权成功后的佣金返回状态 0-待返回 1-已返回
 └─ settle String 28.00 应返回商家佣金金额，当维权成功后，本字段值和refund_settle值一样。
real_settle String 24.00 真实到手的结算预估收入。该值是“settle - refund_settle”后，再扣除阿里官方技术服务10%和综合税收10%后，最终拿到手的佣金；该字段仅在结算之后才有值。
item_id String 123456789 商品ID
product_num Number 5 商品数量
unit_price String 10.00 商品单价
category_name String 商品类目 商品类目
biz_order_id Number 123456789 淘宝子单号
parent_order_id Number 123456789 淘宝主单号
main_item_id String 123456789 主商品ID，针对CPS订单
main_item_title String 主商品名称 主商品名称，针对CPS订单
order_state Number 2 订单状态，0-已失效 1-已下单 2-已付款 4-已收货
order_item_status Number 1 0已失效，1已下单，2已付款，3售中退，4已收货，5售后退。外卖售后维权时间大部分72小时内，如果是零售则时间要更长。
order_item_status_name String 售中退款 订单补充状态，针对CPS订单，考虑到存在已付款的cps订单发生售中退款，不参与结算的情况需要渠道知晓
full_settle_amount String 28.00 结算基数，针对CPS订单，等于付款金额+平台补贴
commission_rate String 10% 佣金比率，针对CPS订单。
特别说明：如果佣金比例显示为0，而结算预估收入settle为0.01，这类订单是商家没有参与饿了么站外推广，正常是没有佣金的。因此饿了么补贴0.01元。
commission_fee String 10.00 佣金金额，针对CPS订单
subsidy_rate String 5% 补贴比率，针对CPS订单
subsidy_fee String 5.00 补贴金额
income_rate String 15% 收入比率，针对CPS订单，等于佣金比率+补贴比率
stratify_rate String 100% 分成比率，针对CPS订单
deduct_rate String 15% 提成，针对CPS订单，等于收入比率*分成比率
platform_commission_rate String 10% 技术服务费率
platform_commission_fee String 10 技术服务费
channel_rate String 0% 淘宝直播费率，针对CPS订单
channel_fee String 0 淘宝直播费，针对CPS订单
media_id String 12345678 媒体ID
media_name String 媒体名称 媒体名称
ad_zone_id String 12345678 推广位ID
ad_zone_name String 推广位名称 推广位名称
activity_fee String 12.0 招商服务费
activity_service_fee String 2.4 招商服务费中的技术服务费
activity_service_rate String 0.2 招商服务费中的技术服务率
gmt_modified String 2021-09-01 10:00:00 更新时间
tag String 用户维权 售中退 或 售后退
sid String 123456 会员标识
platform_type Number 1 1口碑，2饿了么
activity_id Number 12 活动ID
used_store_id String EFDI12d23A 核销门店（已加密）
pid String alsc_xxx_xxx_xxx pid
relation_order_id Number 203232223 卡券订单号
flow_type Number 1 场景值，7卡券订单，8卡券核销订单
activity_info_remark_list String null 活动信息明细
channel_right_id String 3145 权益ID（flow_type=10或11时为媒体出资活动ID）

返回示例

【提示】推广链接通常有时效性，示例中的链接为创建文档时生成，仅用于展示返回结果使用，有可能已失效。
{ "error": "0", "msg": "查询成功！", "total_count": "3", "data": [ { "sid": "v2wphz", "title": "招牌螺蛳粉+鸡爪等5件商品", "biz_order_id": "8089120104297966035", "parent_order_id": "8089120104297966035", "relation_order_id": "", "activity_id": "", "activity_info_remark_list": "", "ad_zone_id": "3562081", "ad_zone_name": "本地公众号", "media_id": "1610002", "media_name": "维易淘客", "pid": "alsc_17581674_1610002_3562081", "category_name": "快餐便当", "channel_fee": "0.00", "channel_rate": "0.0", "commission_fee": "0.00", "commission_rate": "0.0", "flow_type": "3", "gmt_modified": "2023-03-20 11:35:26", "income": "0.01", "income_rate": "0.001", "item_id": "A64C61E993D20C70C5F89B685C249CB2", "order_item_status": "5", "order_item_status_name": "售后退款", "order_state": "4", "pay_amount": "13.01", "pay_time": "2023-03-20 11:19:53", "receive_time": "2023-03-20 11:35:26", "pic_url": "https://img.alicdn.com/i4/2201477407328/O1CN01a714pm240HB7vcT8l_!!2201477407328-0-koubei.jpg", "platform_commission_fee": "0.00", "platform_commission_rate": "0.1", "platform_type": "2", "product_num": "5", "full_settle_amount": "13.01", "settle": "0.01", "settle_amount": "13.01", "settle_state": "1", "settle_time": "2023-03-20 11:35:27", "shop_name": "螺鼎记林科大螺蛳粉(梅溪湖店)", "subsidy_fee": "0.01", "subsidy_rate": "0.001", "tk_create_time": "2023-03-20 11:19:42", "trace_time": "2023-03-20 11:19:42", "unit_price": "2.60", "channel_right_id": "", "refund_settle": "0.01", "refund_info": { "explain_start_time": "2023-03-20 12:08:25", "explain_end_time": "2023-03-20 12:08:25", "explain_state": "0", "refund_amount": "13.01", "return_commission_state": "1", "settle": "0.01" }, "real_settle": "0.00" } ], "request_id": "r3T2QXx" }

错误码

如果error不为0时，请点此查看错误码表格

相关文章：

在线
客服

点此【QQ在线咨询】QQ号：3252444923

会员请加QQ群交流：

微信
咨询

加微信咨询
顶部