淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
item_id	String	必须	edsdsrwr2	商品列表里面返回的商品id
city_id	String	必须	42323	城市id
aid	String	必须	542342	商品列表里面返回的商品广告主id
cnid	String	必须	7654345	商品列表里面返回的商品计划id

名称	类型	示例值	描述
result	ResultDTO	ResultDTO	异步获取历史数据接口返回结果
result KbItemDetail KbItemDetail 商品详情实体 └ valid_period String 7天内商品使用有效期 └ gmt_end String 2020-04-01 00:00:00 结束售卖时间 └ gmt_start String 2020-01-01 00:00:00 起始售卖时间 └ total_sales Number 534 总销量 └ quantity Number 44 该库存类型下的剩余库存 └ original_price String 555元原价 └ price String 444元现价 └ sub_title String 商品副标题副标题 └ title String 商品主标题主标题 └ cover String https://img.alicdn.com/i3/2200798722917/O1CN01Z2QLds1XQ1u1IGGmy_!!2200798722917-0-koubei.jpg 商品封面图 └ tb_item_id String 6543454345 淘宝商品id └ images String [] https://img.alicdn.com/i3/2200798722917/O1CN01Z2QLds1XQ1u1IGGmy_!!2200798722917-0-koubei.jpg 商品橱窗图 image_texts ItemImageTextDTO [] 商品内容中的图文信息商品内容中的图文信息 └ title String 图文标题图文标题 └ desc String 描述描述 └ urls String [] 图片列表图片列表 shops KbCpaShopDTO [] 商品关联门店商品关联门店 └ name String 门店名称门店名称 └ subname String 门店子名称门店子名称 └ status Number 1 1生效，0失效 └ error_msg String 错误信息错误信息 └ error_code String 错误码错误码 └ success String true 执行结果

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaKbcpaDistributeItemdetailGetRequest req = new AlibabaKbcpaDistributeItemdetailGetRequest();
req.setItemId("edsdsrwr2");
req.setCityId("42323");
req.setAid("542342");
req.setCnid("7654345");
AlibabaKbcpaDistributeItemdetailGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaKbcpaDistributeItemdetailGetRequest req = new AlibabaKbcpaDistributeItemdetailGetRequest();
req.ItemId = "edsdsrwr2";
req.CityId = "42323";
req.Aid = "542342";
req.Cnid = "7654345";
AlibabaKbcpaDistributeItemdetailGetResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaKbcpaDistributeItemdetailGetRequest;
$req->setItemId("edsdsrwr2");
$req->setCityId("42323");
$req->setAid("542342");
$req->setCnid("7654345");
$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=alibaba.kbcpa.distribute.itemdetail.get' \
-d 'partner_id=apidoc' \
-d 'sign=477487D7A5B050F3D45C925C9F35B389' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-29+20%3A21%3A17' \
-d 'v=2.0' \
-d 'aid=542342' \
-d 'city_id=42323' \
-d 'cnid=7654345' \
-d 'item_id=edsdsrwr2'

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

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

req.item_id="edsdsrwr2"
req.city_id="42323"
req.aid="542342"
req.cnid="7654345"
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,"alibaba.kbcpa.distribute.itemdetail.get");
add_param(pRequest,"item_id","edsdsrwr2");
add_param(pRequest,"city_id","42323");
add_param(pRequest,"aid","542342");
add_param(pRequest,"cnid","7654345");
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('alibaba.kbcpa.distribute.itemdetail.get', {
	'item_id':'edsdsrwr2',
	'city_id':'42323',
	'aid':'542342',
	'cnid':'7654345'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_kbcpa_distribute_itemdetail_get_response>
    <result>
        <result>
            <valid_period>7天内</valid_period>
            <gmt_end>2020-04-01 00:00:00</gmt_end>
            <gmt_start>2020-01-01 00:00:00</gmt_start>
            <total_sales>534</total_sales>
            <quantity>44</quantity>
            <original_price>555元</original_price>
            <price>444元</price>
            <sub_title>商品副标题</sub_title>
            <title>商品主标题</title>
            <cover>https://img.alicdn.com/i3/2200798722917/O1CN01Z2QLds1XQ1u1IGGmy_!!2200798722917-0-koubei.jpg</cover>
            <tb_item_id>6543454345</tb_item_id>
            <images>
                <string>https://img.alicdn.com/i3/2200798722917/O1CN01Z2QLds1XQ1u1IGGmy_!!2200798722917-0-koubei.jpg</string>
            </images>
            <image_texts>
                <item_image_text_d_t_o>
                    <title>图文标题</title>
                    <desc>描述</desc>
                    <urls>
                        <string>图片列表</string>
                    </urls>
                </item_image_text_d_t_o>
            </image_texts>
            <shops>
                <kb_cpa_shop_d_t_o>
                    <name>门店名称</name>
                    <subname>门店子名称</subname>
                </kb_cpa_shop_d_t_o>
            </shops>
            <status>1</status>
        </result>
        <error_msg>错误信息</error_msg>
        <error_code>错误码</error_code>
        <success>true</success>
    </result>
</alibaba_kbcpa_distribute_itemdetail_get_response>

{
    "alibaba_kbcpa_distribute_itemdetail_get_response":{
        "result":{
            "result":{
                "valid_period":"7天内",
                "gmt_end":"2020-04-01 00:00:00",
                "gmt_start":"2020-01-01 00:00:00",
                "total_sales":534,
                "quantity":44,
                "original_price":"555元",
                "price":"444元",
                "sub_title":"商品副标题",
                "title":"商品主标题",
                "cover":"https:\/\/img.alicdn.com\/i3\/2200798722917\/O1CN01Z2QLds1XQ1u1IGGmy_!!2200798722917-0-koubei.jpg",
                "tb_item_id":"6543454345",
                "images":{
                    "string":[
                        "https:\/\/img.alicdn.com\/i3\/2200798722917\/O1CN01Z2QLds1XQ1u1IGGmy_!!2200798722917-0-koubei.jpg"
                    ]
                },
                "image_texts":{
                    "item_image_text_d_t_o":[
                        {
                            "title":"图文标题",
                            "desc":"描述",
                            "urls":{
                                "string":[
                                    "图片列表"
                                ]
                            }
                        }
                    ]
                },
                "shops":{
                    "kb_cpa_shop_d_t_o":[
                        {
                            "name":"门店名称",
                            "subname":"门店子名称"
                        }
                    ]
                },
                "status":1
            },
            "error_msg":"错误信息",
            "error_code":"错误码",
            "success":"true"
        }
    }
}

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

alibaba.kbcpa.distribute.itemdetail.get (本地生活口碑CPA分销媒体商品详情)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ