API文档中心

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

淘宝客全量维权退款订单查询

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

本接口用于查询已授权淘宝客的全量维权退款订单明细。


查询范围包含您的淘宝联盟的普通订单、渠道订单、会员订单的维权退款。

本接口可用于替代之前的只能查询渠道订单的维权订单接口。

调用说明

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

接口请求地址

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

请求方式:GETPOST

请求参数

参数名称 参数类型 必填 示例值 描述
vekey String V123M56 公共参数,接口秘钥,请在会员中心获取
start_time String 2023-11-11 12:18:22 订单查询开始时间
end_time String 2019-11-11 12:28:22 订单查询结束时间,必须大于start_time时间。start_time至end_time中间时间段日常要求不超过3个小时,但如618、双11、年货节等大促期间预估时间段不可超过20分钟,超过会提示错误,调用时请务必注意时间段的选择,以保证亲能正常调用!
jump_type Number 2 跳转类型,当向前或者向后翻页必须提供,-1: 向前翻页,1:向后翻页
order_scene Number 1 订单类型,目前只有一个可选值1(默认),表示“全部订单”。可不传本参。
page_no Number 1 第几页,默认1
page_size Number 1 单页订单量,默认20,上限100条
position_index String adb123456 翻页偏移值,从上一页返回值中得到,做为下一页查询的入参。
query_type Number 1 查询时间类型,可选值:1-维权发起时间,2-订单结算时间(正向订单),3-维权完成时间,4-订单创建时间,5-订单更新时间 (注意:入参startTime小于2022年12月20日0点时,query_type只能为1、2、3;入参startTime大于等于2022年12月20日0点时,query_type可以为1、2、3、4、5)
position_index String 2222_334666 位点,除第一页之外,都需要传递;前端原样返回。用法:本参数把第一页调用的返回值position_index,做为第2页的入参即可。同样,第2页的position_index返回值,做为第3页的入参。
member_type Number 2 推广者角色类型,1 表示2方,2表示3方,4表示不限,不传表示4所有角色
sessionkey String 7002 多用户专用。如果您的会员卡是多用户版订单查询接口,若要查不同的帐号,请提供该帐号授权的sessionkey值
account_id String 联盟号id 会员中心有多个授权时,用本参数指定要查询哪一个联盟号id下的订单,联盟号ID请到会员中心授权页查看

请求示例

  • HTTP
  • PHP
  • JAVA
  • PYTHON
GET/POST  http://api.veapi.cn/tbk/allorderrefund?vekey=xxx&start_time=2023-11-06%2000:00:00&end_time=2023-11-06%2003:00:00 

使用curl函数,curl不是php原生库,需要安装才能使用

$api="http://api.veapi.cn/tbk/allorderrefund?vekey=xxx&start_time=2023-11-06%2000:00:00&end_time=2023-11-06%2003:00:00";

$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/allorderrefund?vekey=xxx&start_time=2023-11-06%2000:00:00&end_time=2023-11-06%2003:00:00";
        // 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/allorderrefund?vekey=xxx&start_time=2023-11-06%2000:00:00&end_time=2023-11-06%2003:00:00"

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

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

返回值(JSON)

参数名称 参数类型 示例值 描述
refund_suit_id String 12345 维权编号,是当前订单发生维权退款的编号,非淘宝订单编号,如订单发生多次维权,则会产生多个维权编号
tb_trade_parent_id String 1707359271433894971 淘宝父订单编号(买家在淘宝后台显示的订单编号)
tb_trade_id String 1707359271433894971 淘宝子订单编号
tb_trade_create_time String 2022-10-19 14:33:06 订单创建时间
earning_time String 2022-10-19 14:39:31 订单结算时间
tk_refund_time String 2022-10-19 14:41:22 维权创建时间
tk_refund_suit_time String 2022-10-19 14:42:29 维权完成时间
modified_time String 2022-10-20 03:26:23 订单更新时间
item_title String 晨妍-服饰 商品标题
tk_order_role String 二方 推广者角色(二方、三方)
refund_status Number 2 维权创建(淘客结算回执) 4, 维权成功(淘客结算回执) 2, 维权失败(淘客结算回执) 3, 发生多次维权,待处理 11, 从淘客处补扣(钱已结给淘客) 等待扣款 12, 从淘客处补扣(钱已结给淘客) 扣款成功 13, 从卖家处补扣(钱已结给卖家) 等待扣款 14, 从卖家处补扣(钱已结给卖家) 扣款成功 15
tb_trade_finish_price String 5.00 结算金额(订单确认收货后的成交金额)
refund_fee String 3.50 维权金额(买家申请维权退款的金额)
pub_share_fee String 1.10 结算预估收入=结算金额*提成。以订单确认收货后的成交金额为基数,预估您可能获得的收入。
tk_commission_fee_refund String 0.71 应退还佣金(不含技术服务费和渠道专项服务费)
tk_subsidy_fee_refund String 0 应退还补贴(不含技术服务费和渠道专项服务费)
tk_commission_alimm_refund_fee String 0.06 应退还佣金对应的技术服务费
tk_subsidy_alimm_refund_fee String 0 应退还补贴对应的技术服务费
tk_commission_agent_refund_fee String 0 应退还佣金对应的渠道专项服务费
tk_subsidy_agent_refund_fee String 0 应退还补贴对应的渠道专项服务费
show_return_fee String 0.77 应退还预估收入:订单发生维权退款应退还的预估收入(佣金+补贴,含技术服务费和渠道专项服务费)
relation_id Number 1111111 渠道关系id
special_id Number 22222 会员关系id
pre_page Number 1 上一页
next_page Number 1 下一页
page_no Number 1 页码
page_size Number 2 每页订单量
has_next Boolean false 是否有下一页
position_index String 1666161749_227IRqDZH07_88HkDISvJH2|1666161749_227IRqDZH07_88HkDISvJH2 位点
has_pre Boolean false 是否有上一页

返回示例

【提示】推广链接通常有时效性,示例中的链接为创建文档时生成,仅用于展示返回结果使用,有可能已失效。
{ "error": "15", "msg": "亲,订单开始时间至订单结束时间的时间段是14580分钟,时间段日常要求不超过3个小时,但如618、双11、年货节等大促期间预估时间段不可超过20分钟,超过会提示错误,调用时请务必注意时间段的选择,以保证亲能正常调用!", "data": {}, "request_id": "EHKcsNC" }

错误码

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

在线
客服

会员请加QQ群交流:

微信
咨询

加微信咨询
顶部