淘宝开放平台 - 文档中心

请求地址：

环境	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。

名称	类型	是否必须	示例值	更多限制	描述
taoke_info_open_api_query	TaokeInfoOpenApiQuery	必须			查询请求对象
└ page_size Number 必须 100 分页大小 └ app_key String 必须 34309206 appkey └ title String 可选渠道2 渠道名称支持模糊查询 └ current_page Number 必须 1 当前分野

名称	类型	示例值	描述
result_code	ResultCode		结果
└ code String success 请求结果code └ message String 成功请求结果信息
page_size	Number	分页大小	20
total_count	Number	总数	100
current_page	Number	当前分页	1
data	TaokeInfoOpenApiVO []		响应数据
└ title String 渠道1 渠道名称 └ id Number 123 id └ pid String 111.222.333 pid └ parent_pid String 111.222 根pid └ notes String 备注一下备注 └ gmt_create String 2024-01-11 11:11:11 创建时间 └ gmt_modified String 2024-01-11 11:11:11 修改时间

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
PaimaiAuctionrubyPidQueryRequest req = new PaimaiAuctionrubyPidQueryRequest();
PaimaiAuctionrubyPidQueryRequest.TaokeInfoOpenApiQuery obj1 = new PaimaiAuctionrubyPidQueryRequest.TaokeInfoOpenApiQuery();
obj1.setPageSize(100L);
obj1.setAppKey("34309206");
obj1.setTitle("渠道2");
obj1.setCurrentPage(1L);
req.setTaokeInfoOpenApiQuery(obj1);
PaimaiAuctionrubyPidQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
PaimaiAuctionrubyPidQueryRequest req = new PaimaiAuctionrubyPidQueryRequest();
PaimaiAuctionrubyPidQueryRequest.TaokeInfoOpenApiQueryDomain obj1 = new PaimaiAuctionrubyPidQueryRequest.TaokeInfoOpenApiQueryDomain();
obj1.PageSize = 100L;
obj1.AppKey = "34309206";
obj1.Title = "渠道2";
obj1.CurrentPage = 1L;
req.TaokeInfoOpenApiQuery_ = obj1;
PaimaiAuctionrubyPidQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new PaimaiAuctionrubyPidQueryRequest;
$taoke_info_open_api_query = new TaokeInfoOpenApiQuery;
$taoke_info_open_api_query->page_size="100";
$taoke_info_open_api_query->app_key="34309206";
$taoke_info_open_api_query->title="渠道2";
$taoke_info_open_api_query->current_page="1";
$req->setTaokeInfoOpenApiQuery(json_encode($taoke_info_open_api_query));
$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.paimai.auctionruby.pid.query' \
-d 'partner_id=apidoc' \
-d 'sign=43EADF2F21C627B3AB4923E595770D02' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-03+23%3A43%3A58' \
-d 'v=2.0' \
-d 'taoke_info_open_api_query=null'

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

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

req.taoke_info_open_api_query="数据结构示例JSON格式"
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.paimai.auctionruby.pid.query");
add_param(pRequest,"taoke_info_open_api_query","数据结构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.paimai.auctionruby.pid.query', {
	'taoke_info_open_api_query':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<paimai_auctionruby_pid_query_response>
    <result_code>
        <code>success</code>
        <message>成功</message>
    </result_code>
    <page_size>分页大小</page_size>
    <total_count>总数</total_count>
    <current_page>当前分页</current_page>
    <data>
        <taoke_info_open_api_v_o>
            <title>渠道1</title>
            <id>123</id>
            <pid>111.222.333</pid>
            <parent_pid>111.222</parent_pid>
            <notes>备注一下</notes>
            <gmt_create>2024-01-11 11:11:11</gmt_create>
            <gmt_modified>2024-01-11 11:11:11</gmt_modified>
        </taoke_info_open_api_v_o>
    </data>
</paimai_auctionruby_pid_query_response>

{
    "paimai_auctionruby_pid_query_response":{
        "result_code":{
            "code":"success",
            "message":"成功"
        },
        "page_size":分页大小,
        "total_count":总数,
        "current_page":当前分页,
        "data":{
            "taoke_info_open_api_v_o":[
                {
                    "title":"渠道1",
                    "id":123,
                    "pid":"111.222.333",
                    "parent_pid":"111.222",
                    "notes":"备注一下",
                    "gmt_create":"2024-01-11 11:11:11",
                    "gmt_modified":"2024-01-11 11:11:11"
                }
            ]
        }
    }
}

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.paimai.auctionruby.pid.query (分页查询渠道)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ