API文档中心

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

淘宝联盟订单查询接口

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

查询淘宝客推广的订单。详细介绍和FAQ请查看接入指引页面。


特别说明：

如果您要查询订单中的渠道ID（即rid），请务必先确认您有渠道订单，可到“淘宝联盟会员后台——效果报表——渠道订单”下查看，如果这里没有渠道订单，那订单接口也是无法查询渠道ID。

如果您已经有渠道订单，那么要查询rid时，可以在此订单接口添加参数order_scene=2 ，就可以查到。


如果你感觉自己明明提供了rid转链，但订单却不是渠道订单，这一般是两种原因：

1、您在转链时，rid没有和渠道专属PID配合转链，而是使用了普通pid转链，这样转链的口令或链接下单，就无法成为渠道订单。

2、在下单环节，用户因一些操作，也会使订单变成普通订单，比如使用了别的淘客的红包。


更多订单问题，请参考接口指引 ：

https://www.veapi.cn/apidoc/taobaolianmeng/82

和渠道文档：

https://www.veapi.cn/apidoc/taobaolianmeng/113


【全量维权订单查询接口上线】

参考 https://www.veapi.cn/apidoc/taobaolianmeng/361 


【必读：重要升级-官方通知】

订单明细报表升级  2023-05-18

https://qn.taobao.com/headline/news/10698445?spm=a211vu.12026430.0.0.1fff3929P0kYHO 

调用说明

本接口需要您在会员中心授权（如果多用户可传入sessionkey参数）

接口请求地址

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

请求方式：GET 或 POST

请求参数

参数名称 参数类型 必填 示例值 描述
vekey String 是 V123M56 公共参数，接口秘钥，请在会员中心获取
start_time String 是 2019-04-05 12:18:22 订单查询开始时间
end_time String 是 2019-04-05 12:28:22 订单查询结束时间，必须大于start_time时间。start_time至end_time中间时间段日常要求不超过3个小时，但如618、双11、年货节等大促期间预估时间段不可超过20分钟，超过会提示错误，调用时请务必注意时间段的选择，以保证亲能正常调用！
query_type Number 否 1 查询时间类型，1：按照订单淘客创建时间查询，2:按照订单淘客付款时间查询，3:按照订单淘客结算时间查询，4:按照订单更新时间（订单增量查询）
position_index String 否 2222_334666 位点，除第一页之外，都需要传递；前端原样返回。用法：本参数把第一页调用的返回值position_index，做为第2页的入参即可。同样，第2页的position_index返回值，做为第3页的入参。
member_type Number 否 2 推广者角色类型,2:二方，3:三方，不传，表示所有角色
tk_status Number 否 2 淘客订单状态，12-付款，13-关闭，14-确认收货，3-结算成功;不传，表示所有状态。注意：如果一个订单全额退款，这时订单是失效关闭状态，虽然它付款过，但此时关闭状态，你用tk_status=12是查不到的，必须用tk_status=13或不用这个参数才能查的到。
jump_type Number 否 2 跳转类型，当向前或者向后翻页必须提供,-1: 向前翻页,1：向后翻页
order_scene Number 否 1 场景订单场景类型，1:常规订单，2:渠道订单，3:会员运营订单，默认为1，要查询订单中的渠道id，务必添加此参数值2，当然，前提是您的订单中有渠道订单才能查出渠道ID。参考上文说明。
member_group_id Number 否 100 member组ID
page_no Number 否 1 第几页，默认1，1~100
page_size Number 否 1 页大小，默认20，1~100
sessionkey String 否 7002 多用户专用。如果您的会员卡是多用户版订单查询接口，若要查不同的帐号，请提供该帐号授权的sessionkey值
account_id String 否 联盟号id 会员中心有多个授权时，用本参数指定要查询哪一个联盟号id下的订单，联盟号ID请到会员中心授权页查看

请求示例

  • HTTP
  • PHP
  • JAVA
  • PYTHON
GET/POST  http://api.veapi.cn/tbk/orderdetails?vekey=xx&start_time=2019-04-05+12:18:22&end_time=2019-04-05+12:28:21
使用curl函数，curl不是php原生库，需要安装才能使用

$api="http://api.veapi.cn/tbk/orderdetails?vekey=xx&start_time=2019-04-05+12:18:22&end_time=2019-04-05+12:28:21";

$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/tbk/orderdetails?vekey=xx&start_time=2019-04-05+12:18:22&end_time=2019-04-05+12:28:21";
        // 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/tbk/orderdetails?vekey=xx&start_time=2019-04-05+12:18:22&end_time=2019-04-05+12:28:21"

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

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

返回值（JSON）

参数名称 参数类型 示例值 描述
has_next Boolean true 是否还有下一页
has_pre Boolean false 是否还有上一页
page_no Number 1 页码
page_size Number 20 页大小
position_index String 166520_3zEoey 位点字段，由调用方原样传递
tb_paid_time String 2019-04-22 15:15:05 订单在淘宝拍下付款的时间
tk_paid_time String 2019-04-22 15:15:05 订单付款的时间，该时间同步淘宝，可能会略晚于买家在淘宝的订单创建时间
pay_price String 9.11 买家确认收货的付款金额（不包含运费金额）
pub_share_fee String 1.65 结算预估收入=结算金额*提成。以买家确认收货的付款金额为基数，预估您可能获得的收入。因买家退款、您违规推广等原因，可能与您最终收入不一致。最终收入以月结后您实际收到的为准
tk_order_role Number 2 二方：佣金收益的第一归属者； 三方：从其他淘宝客佣金中进行分成的推广者
tk_earning_time String 2019-04-22 15:15:05 订单确认收货后且商家完成佣金支付的时间
adzone_id Number 11 推广位管理下的推广位名称对应的ID，同时也是pid=mm_1_2_3中的“3”这段数字
pub_share_rate String 100 从结算佣金中分得的收益比率
refund_tag Number 0 维权标签，0 含义为非维权 1 含义为维权订单
subsidy_rate String 0 平台给与的补贴比率，如天猫、淘宝、聚划算等
tk_total_rate String 9.99 提成=收入比率*分成比率。指实际获得收益的比率
item_category_name String 淘小铺 商品所属的根类目，即一级类目的名称
seller_nick String -- 掌柜旺旺
pub_id Number 98836808 推广者的会员id
alimama_rate String 10.00 推广者赚取佣金后支付给阿里妈妈的技术服务费用的比率
subsidy_type String -- 平台出资方，如天猫、淘宝、或聚划算等
item_img String //img.....jpg 商品图片
pub_share_pre_fee String 0 付款预估收入=付款金额*提成。指买家付款金额为基数，预估您可能获得的收入。因买家退款等原因，可能与结算预估收入不一致
alipay_total_price String 11.22 买家拍下付款的金额（不包含运费金额）
item_title String   淘宝天猫上的商品详情页标题
site_name String 合伙人 媒体管理下的对应ID的自定义名称
item_num Number 2 商品数量
subsidy_fee String 0 补贴金额=结算金额*补贴比率
alimama_share_fee String 0 技术服务费=结算金额*收入比率*技术服务费率。推广者赚取佣金后支付给阿里妈妈的技术服务费用
trade_id String 294159887 买家通过购物车购买的每个商品对应的订单编号，此订单编号并未在淘宝买家后台透出
trade_parent_id String 299887064307 买家在淘宝后台显示的订单编号
order_type String 如意淘 订单所属平台类型，包括天猫、淘宝、聚划算等，饿了么订单为“饿了么”
tk_create_time String 2019-04-22 15:15:05 订单创建的时间，该时间同步淘宝，可能会略晚于买家在淘宝的订单创建时间
flow_source String -- 产品类型
terminal_type String 无线 成交平台
click_time String 2019-04-22 15:14:55 通过推广链接达到商品、店铺详情页的点击时间
tk_status Number 13 已付款：指订单已付款，但还未确认收货。已收货：指订单已确认收货，但商家佣金未支付。已结算：指订单已确认收货，且商家佣金已支付成功。已失效：指订单关闭/订单佣金小于0.01元，订单关闭主要有：1）买家超时未付款； 2）买家付款前，买家/卖家取消了订单；3）订单付款后发起售中退款成功；详细订单名词请参考这里。tk_status状态值含义：3：订单结算，12：订单已付款， 13：订单失效，14：订单成功将进入结算
item_price String 2.1 商品单价
item_id String 590141576510 商品id
adzone_name String 爱分享 PID推广位名称
item_link String https://... 商品链接，如https://detail.tmall.com/item.htm?id=557017471577
site_id Number 45598009 媒体管理下的ID，同时也是pid=mm_1_2_3中的“2”这段数字
seller_shop_title String -- 店铺名称
income_rate String 9.99 订单结算的佣金比率+平台的补贴比率
total_commission_rate String 9.99 佣金比率
total_commission_fee String 0 佣金金额=结算金额＊佣金比率
tk_commission_pre_fee_for_media_platform String 1.05 预估内容专项服务费：内容场景专项技术服务费，内容推广者在内容场景进行推广需要支付给阿里妈妈专项的技术服务费用。专项服务费＝付款金额＊专项服务费率。
tk_commission_fee_for_media_platform String 1.05 结算内容专项服务费：内容场景专项技术服务费，内容推广者在内容场景进行推广需要支付给阿里妈妈专项的技术服务费用。专项服务费＝结算金额＊专项服务费率。
tk_commission_rate_for_media_platform String 0.01 内容专项服务费率：内容场景专项技术服务费率，内容推广者在内容场景进行推广需要按结算金额支付一定比例给阿里妈妈作为内容场景专项技术服务费，用于提供与内容平台实现产品技术对接等服务。
special_id Number 2323 会员运营id
relation_id Number 2323 渠道关系id，如果您想要查relation_id但没有查到，请参考上方“特别说明”以及订单接口指引
tk_deposit_time String 2019-09-09 12:01:01 预售时期，用户对预售商品支付定金的付款时间，可能略晚于在淘宝付定金时间
tb_deposit_time String 2019-09-09 12:01:01 预售时期，用户对预售商品支付定金的付款时间
deposit_price String 122.22 预售时期，用户对预售商品支付的定金金额
app_key String 112121 开发者调用api的appkey
alsc_id String 2332 口碑子订单号
alsc_pid String 32324 口碑父订单号
service_fee_dto_list Array   服务费信息
 └─ share_relative_rate String 0.10 专项服务费率
 └─ share_fee String 11.11 结算专项服务费
 └─ share_pre_fee String 11.11 预估专项服务费
 └─ tk_share_role_type Number 122 专项服务费来源，122-渠道
lx_rid String 13123 激励池对应的rid
is_lx String 1 订单是否为激励池订单 1表示是 0表示否
marketing_type String 淘礼金 营销类型：该字段中视订单情况有单个或多个值。 例如：淘礼金（自助充值），特价版客户端染色，特价版客户端锁粉，特价版客户端推广。
modified_time String 2022-05-12 15:35:59 订单更新时间
extra_mkt_id String 1gwcawUiqn49 管理member新商品ID-B段

返回示例

【提示】推广链接通常有时效性，示例中的链接为创建文档时生成，仅用于展示返回结果使用，有可能已失效。
{ "error": "0", "msg": "操作成功", "data": { "has_next": true, "has_pre": false, "page_no": 1, "page_size": 20, "position_index": "1667466520_3zEoeyGLi0f2|1667466613_4pP3zn2", "results": { "publisher_order_dto": [ { "adzone_id": 99310200014, "adzone_name": "公众号专用", "alimama_rate": "10.00", "alimama_share_fee": "0.16", "alipay_total_price": "20.60", "click_time": "2022-11-03 17:02:03", "deposit_price": "0.00", "flow_source": "--", "income_rate": "8.00", "is_lx": "0", "item_category_name": "快餐便当", "item_img": "https://cube.elemecdn.com/8/CE/93A5719A3439CA23E6EBDFE9F124Dpng.png", "item_num": 2, "item_title": "【火爆热卖】窑鸡半只 + 自选等2件商品", "marketing_type": "", "modified_time": "2022-11-03 17:47:48", "order_type": "饿了么", "pay_price": "20.60", "pub_id": 326800075, "pub_share_fee": "1.65", "pub_share_pre_fee": "1.65", "pub_share_rate": "100.00", "refund_tag": 0, "seller_nick": "古法窑鸡(狮山店)", "seller_shop_title": "古法窑鸡(狮山店)", "site_id": 334750462, "site_name": "知铲科技", "subsidy_fee": "0.00", "subsidy_rate": "0.00", "subsidy_type": "--", "tb_deposit_time": "--", "tb_paid_time": "2022-11-03 17:10:03", "terminal_type": "无线", "tk_commission_fee_for_media_platform": "0.00", "tk_commission_pre_fee_for_media_platform": "0.00", "tk_commission_rate_for_media_platform": "0.00", "tk_create_time": "2022-11-03 17:08:44", "tk_deposit_time": "--", "tk_earning_time": "2022-11-03 17:47:48", "tk_order_role": 2, "tk_paid_time": "2022-11-03 17:10:13", "tk_status": 3, "tk_total_rate": "8.00", "total_commission_fee": "1.65", "total_commission_rate": "8.00", "trade_id": "1046108185", "trade_parent_id": "8739532568443857127" } ] } } }

错误码

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

在线
客服

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

会员请加QQ群交流：

微信
咨询

加微信咨询
顶部