淘宝开放平台

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

名称	类型	是否必须	示例值	更多限制	描述
af_order_option	TopApiAfOrderOption	可选			入参的对象
└ relation_id Number 可选 2222 渠道关系id └ tb_trade_id Number 可选 258897956183171983 子订单号 └ tb_trade_parent_id Number 可选 258897956183171983 此参数不再使用，请勿入参 └ page_size Number 可选 1 pagesize └ page_no Number 可选 10 pageNo └ span Number 可选 10 查询时间跨度，不超过30天，单位是天 └ start_time Date 可选 2018-11-11 00:01:01 查询开始时间，以taoke订单创建时间开始 └ special_id Number 可选 23132 此参数不再使用，请勿入参 └ adzone_id Number 可选 123 pid中的第三段，adzoneId └ site_id Number 可选 123 pid中的第二段，siteId └ violation_type Number 可选 1 此参数不再使用，请勿入参 └ punish_status Number 可选 1 此参数不再使用，请勿入参

名称	类型	示例值	描述
result	RpcResult		查询的对象
data PageResult 结果 results Result [] 处罚订单列表 └ union_id String 淘宝联盟unionid（该字段不再支持） └ special_id Number 会员运营id（该字段不再支持） └ relation_id Number 122344 渠道关系id └ settle_month Number 201812 结算月份 └ punish_status String 0 处罚状态。0 冻结，1 解冻 └ violation_type String 店铺淘宝客处罚类型，目前包括 1.店铺淘宝客 2.订单虚假交易 └ tk_trade_create_time String 2018-11-11 00:01:01 淘客订单创建时间 └ tb_trade_id Number 581552321112183166 子订单号 └ tb_trade_parent_id Number 父订单号（该字段不再支持） └ tk_adzone_id Number 1212 pid里的adzoneid └ tk_site_id Number 1212 pid里的siteid └ tk_pub_id String 114469792 pid里的pubid └ page_no Number 1 翻页的pageno └ page_size Number 10 翻页的pagesie └ total_count Number 100 一共能查询出来的结果总数 └ biz_error_desc String 没有获取到memberid 业务出错的描述 └ biz_error_code Number 103 业务出错的状态码 └ result_msg String ok 执行结果 └ result_code Number 200 执行结果状态码

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TbkDgPunishOrderGetRequest req = new TbkDgPunishOrderGetRequest();
TbkDgPunishOrderGetRequest.TopApiAfOrderOption obj1 = new TbkDgPunishOrderGetRequest.TopApiAfOrderOption();
obj1.setRelationId(2222L);
obj1.setTbTradeId(258897956183171983L);
obj1.setTbTradeParentId(258897956183171983L);
obj1.setPageSize(1L);
obj1.setPageNo(10L);
obj1.setSpan(10L);
obj1.setStartTime(StringUtils.parseDateTime("2018-11-11 00:01:01"));
obj1.setSpecialId(23132L);
obj1.setAdzoneId(123L);
obj1.setSiteId(123L);
obj1.setViolationType(1L);
obj1.setPunishStatus(1L);
req.setAfOrderOption(obj1);
TbkDgPunishOrderGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TbkDgPunishOrderGetRequest req = new TbkDgPunishOrderGetRequest();
TbkDgPunishOrderGetRequest.TopApiAfOrderOptionDomain obj1 = new TbkDgPunishOrderGetRequest.TopApiAfOrderOptionDomain();
obj1.RelationId = 2222L;
obj1.TbTradeId = 258897956183171983L;
obj1.TbTradeParentId = 258897956183171983L;
obj1.PageSize = 1L;
obj1.PageNo = 10L;
obj1.Span = 10L;
obj1.StartTime = DateTime.Parse(2018-11-11 00:01:01");
obj1.SpecialId = 23132L;
obj1.AdzoneId = 123L;
obj1.SiteId = 123L;
obj1.ViolationType = 1L;
obj1.PunishStatus = 1L;
req.AfOrderOption_ = obj1;
TbkDgPunishOrderGetResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TbkDgPunishOrderGetRequest;
$af_order_option = new TopApiAfOrderOption;
$af_order_option->relation_id="2222";
$af_order_option->tb_trade_id="258897956183171983";
$af_order_option->tb_trade_parent_id="258897956183171983";
$af_order_option->page_size="1";
$af_order_option->page_no="10";
$af_order_option->span="10";
$af_order_option->start_time="2018-11-11 00:01:01";
$af_order_option->special_id="23132";
$af_order_option->adzone_id="123";
$af_order_option->site_id="123";
$af_order_option->violation_type="1";
$af_order_option->punish_status="1";
$req->setAfOrderOption(json_encode($af_order_option));
$resp = $c->execute($req);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=taobao.tbk.dg.punish.order.get' \
-d 'partner_id=apidoc' \
-d 'sign=BC8625E4C7D43A73A73F7E193A2C4FAF' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-05+02%3A57%3A09' \
-d 'v=2.0' \
-d 'af_order_option=null'

# -*- coding: utf-8 -*-
import top.api

req=top.api.TbkDgPunishOrderGetRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.af_order_option=""
try:
	resp= req.getResponse()
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"taobao.tbk.dg.punish.order.get");
add_param(pRequest,"af_order_option","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,NULL);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('taobao.tbk.dg.punish.order.get', {
	'af_order_option':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tbk_dg_punish_order_get_response>
    <result>
        <data>
            <results>
                <result>
                    <union_id></union_id>
                    <special_id></special_id>
                    <relation_id>122344</relation_id>
                    <settle_month>201812</settle_month>
                    <punish_status>0</punish_status>
                    <violation_type>店铺淘宝客</violation_type>
                    <tk_trade_create_time>2018-11-11 00:01:01</tk_trade_create_time>
                    <tb_trade_id>581552321112183166</tb_trade_id>
                    <tb_trade_parent_id></tb_trade_parent_id>
                    <tk_adzone_id>1212</tk_adzone_id>
                    <tk_site_id>1212</tk_site_id>
                    <tk_pub_id>114469792</tk_pub_id>
                </result>
            </results>
            <page_no>1</page_no>
            <page_size>10</page_size>
            <total_count>100</total_count>
        </data>
        <biz_error_desc>没有获取到memberid</biz_error_desc>
        <biz_error_code>103</biz_error_code>
        <result_msg>ok</result_msg>
        <result_code>200</result_code>
    </result>
</tbk_dg_punish_order_get_response>

{
    "tbk_dg_punish_order_get_response":{
        "result":{
            "data":{
                "results":{
                    "result":[
                        {
                            "union_id":"",
                            "special_id":,
                            "relation_id":122344,
                            "settle_month":201812,
                            "punish_status":"0",
                            "violation_type":"店铺淘宝客",
                            "tk_trade_create_time":"2018-11-11 00:01:01",
                            "tb_trade_id":581552321112183166,
                            "tb_trade_parent_id":,
                            "tk_adzone_id":1212,
                            "tk_site_id":1212,
                            "tk_pub_id":"114469792"
                        }
                    ]
                },
                "page_no":1,
                "page_size":10,
                "total_count":100
            },
            "biz_error_desc":"没有获取到memberid",
            "biz_error_code":103,
            "result_msg":"ok",
            "result_code":200
        }
    }
}

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码	错误描述	解决方案

API测试工具错误码查询工具 SDK下载

淘宝客API

taobao.tbk.dg.punish.order.get (淘宝客-推广者-处罚订单查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ