淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
top_detail_request	TopDetailRequest	必须			topDetailRequest
└ item_id Number 必须 3 商品id

名称	类型	示例值	描述
top_result	TopResult		topResult
└ success Boolean false 是否成功 top_auction_detail TopAuctionDetail 返回数据 └ item_id Number 3 拍品ID └ auction_type String xxxxx 拍卖类型: oa-英式拍卖, du-荷兰拍, fpo-仅直购价 └ title String xxxxx 拍品标题 └ short_title String xxxxx 短标题 └ desc String xxxxx 拍品详情 └ category_id Number 3 标准类目ID(后台类目) └ front_cat_id Number 3 前台一级类目ID └ front_child_cat_id Number 3 前台二级类目ID └ prov String xxxxx 省份编码 └ city String xxxxx 城市编码 └ quantity Number 10 库存 └ c_code String xxxxx 商品编码 └ fixed_price Number 3 一口价/直购价(分)，仅直购价模式必填 └ pic_urls String [] Top,Pub 图片URL列表第一张默认主图 detail_video TopVideo 详情视频对象 └ video_id String 111 视频ID └ video_url String http://video.alicdn.com/video/111.mp4 视频URL └ video_cover_url String http://video.alicdn.com/video/111.jpg 视频封面URL main_video TopVideo 主图视频对象 └ video_id String 111 视频ID └ video_url String http://video.alicdn.com/video/111.mp4 视频URL └ video_cover_url String http://video.alicdn.com/video/111.jpg 视频封面URL └ properties String xxxxx 属性串, 格式: p1:v1;p2:v2 └ input_pids String xxxxx 用户自定义属性ID串需跟属性值串一一对应,格式: 逗号分隔的 pid，如 "20000,20001" └ input_str String xxxxx 用户自定义属性值串需跟属性id串一一对应,格式: 逗号分隔的值组，每组内分号分隔，如 "耐克;耐克系列,科比系列;2K5" └ tag_ids String xxxxx 标签ID列表格式: 逗号分隔的 tagId，如 "101,203,305" └ ext_params String {"extendServiceForms": [{ "code": "SELLER_RULE","version": "a336db143159cc056b2bc6f335d1cfcc", "properties":[{"code": "发货信息","value": "24小时"}, {"code":"包邮", "value": "包邮"}]}]} 扩展参数JSON 例如{"extendServiceForms": [{ "code": "SELLER_RULE","version": "a336db143159cc056b2bc6f335d1cfcc", "properties":[{"code": "发货信息","value": "24小时"}, {"code":"包邮", "value": "包邮"}]}]} └ status String xxxxx 商品状态 └ create_time Date null 创建时间 error_code TopErrorCode 错误码 └ code String INVALID_PARAMETER 业务错误码 └ default_msg String 参数缺失或值域不合法业务错误信息 └ message String xxxxx 错误信息 └ trace_id String xxxxx 链路追踪ID

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
PaimaiPmpAuctionDetailGetRequest req = new PaimaiPmpAuctionDetailGetRequest();
PaimaiPmpAuctionDetailGetRequest.TopDetailRequest obj1 = new PaimaiPmpAuctionDetailGetRequest.TopDetailRequest();
obj1.setItemId(3L);
req.setTopDetailRequest(obj1);
PaimaiPmpAuctionDetailGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
PaimaiPmpAuctionDetailGetRequest req = new PaimaiPmpAuctionDetailGetRequest();
PaimaiPmpAuctionDetailGetRequest.TopDetailRequestDomain obj1 = new PaimaiPmpAuctionDetailGetRequest.TopDetailRequestDomain();
obj1.ItemId = 3L;
req.TopDetailRequest_ = obj1;
PaimaiPmpAuctionDetailGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new PaimaiPmpAuctionDetailGetRequest;
$top_detail_request = new TopDetailRequest;
$top_detail_request->item_id="3";
$req->setTopDetailRequest(json_encode($top_detail_request));
$resp = $c->execute($req, $sessionKey);

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.pmp.auction.detail.get' \
-d 'partner_id=apidoc' \
-d 'session=1a421923-acb2-4362-a162-124f574b699e' \
-d 'sign=1CF616A44D374A09959DC033B8A71A85' \
-d 'sign_method=hmac' \
-d 'timestamp=2026-08-25+02%3A37%3A49' \
-d 'v=2.0' \
-d 'top_detail_request=null'

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

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

req.top_detail_request="数据结构示例JSON格式"
try:
	resp= req.getResponse(sessionkey)
	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.pmp.auction.detail.get");
add_param(pRequest,"top_detail_request","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,sessionKey);
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',
	'url': 'http://gw.api.taobao.com/router/rest'
});

client.execute('taobao.paimai.pmp.auction.detail.get', {
	'top_detail_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<paimai_pmp_auction_detail_get_response>
    <top_result>
        <success>false</success>
        <top_auction_detail>
            <item_id>3</item_id>
            <auction_type>xxxxx</auction_type>
            <title>xxxxx</title>
            <short_title>xxxxx</short_title>
            <desc>xxxxx</desc>
            <category_id>3</category_id>
            <front_cat_id>3</front_cat_id>
            <front_child_cat_id>3</front_child_cat_id>
            <prov>xxxxx</prov>
            <city>xxxxx</city>
            <quantity>10</quantity>
            <c_code>xxxxx</c_code>
            <fixed_price>3</fixed_price>
            <pic_urls>
                <string>Top</string>
                <string>Pub</string>
            </pic_urls>
            <detail_video>
                <video_id>111</video_id>
                <video_url>http://video.alicdn.com/video/111.mp4</video_url>
                <video_cover_url>http://video.alicdn.com/video/111.jpg</video_cover_url>
            </detail_video>
            <main_video>
                <video_id>111</video_id>
                <video_url>http://video.alicdn.com/video/111.mp4</video_url>
                <video_cover_url>http://video.alicdn.com/video/111.jpg</video_cover_url>
            </main_video>
            <properties>xxxxx</properties>
            <input_pids>xxxxx</input_pids>
            <input_str>xxxxx</input_str>
            <tag_ids>xxxxx</tag_ids>
            <ext_params>{&quot;extendServiceForms&quot;:  [{ &quot;code&quot;: &quot;SELLER_RULE&quot;,&quot;version&quot;: &quot;a336db143159cc056b2bc6f335d1cfcc&quot;,  &quot;properties&quot;:[{&quot;code&quot;: &quot;发货信息&quot;,&quot;value&quot;: &quot;24小时&quot;}, {&quot;code&quot;:&quot;包邮&quot;, &quot;value&quot;: &quot;包邮&quot;}]}]}</ext_params>
            <status>xxxxx</status>
            <create_time>null</create_time>
        </top_auction_detail>
        <error_code>
            <code>INVALID_PARAMETER</code>
            <default_msg>参数缺失或值域不合法</default_msg>
        </error_code>
        <message>xxxxx</message>
        <trace_id>xxxxx</trace_id>
    </top_result>
</paimai_pmp_auction_detail_get_response>

{
    "paimai_pmp_auction_detail_get_response":{
        "top_result":{
            "success":false,
            "top_auction_detail":{
                "item_id":3,
                "auction_type":"xxxxx",
                "title":"xxxxx",
                "short_title":"xxxxx",
                "desc":"xxxxx",
                "category_id":3,
                "front_cat_id":3,
                "front_child_cat_id":3,
                "prov":"xxxxx",
                "city":"xxxxx",
                "quantity":10,
                "c_code":"xxxxx",
                "fixed_price":3,
                "pic_urls":{
                    "string":[
                        "Top",
                        "Pub"
                    ]
                },
                "detail_video":{
                    "video_id":"111",
                    "video_url":"http:\/\/video.alicdn.com\/video\/111.mp4",
                    "video_cover_url":"http:\/\/video.alicdn.com\/video\/111.jpg"
                },
                "main_video":{
                    "video_id":"111",
                    "video_url":"http:\/\/video.alicdn.com\/video\/111.mp4",
                    "video_cover_url":"http:\/\/video.alicdn.com\/video\/111.jpg"
                },
                "properties":"xxxxx",
                "input_pids":"xxxxx",
                "input_str":"xxxxx",
                "tag_ids":"xxxxx",
                "ext_params":"{\"extendServiceForms\":  [{ \"code\": \"SELLER_RULE\",\"version\": \"a336db143159cc056b2bc6f335d1cfcc\",  \"properties\":[{\"code\": \"发货信息\",\"value\": \"24小时\"}, {\"code\":\"包邮\", \"value\": \"包邮\"}]}]}",
                "status":"xxxxx",
                "create_time":"null"
            },
            "error_code":{
                "code":"INVALID_PARAMETER",
                "default_msg":"参数缺失或值域不合法"
            },
            "message":"xxxxx",
            "trace_id":"xxxxx"
        }
    }
}

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.pmp.auction.detail.get (查询发布/编辑页表单回显数据)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ