淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
ds	Number	可选	20221031	日期
item_do	ItemDo	可选		无
└ ref_unit_price String 可选 40000.00 小区参考均价（单位：元）Double └ city String 可选杭州城市（简称） └ total_price String 可选 4990000.00 总价（单位：元）Double └ title String 可选房子精装修带地暖带花园采光无遮挡满五年标题 └ house_purpose String 可选普通住宅房屋用途 └ trans_ownership String 可选商品房住宅交易权属 └ community_score String 可选 9.00 小区评分 └ building_time Number 可选 2020 建成年代 └ feature String 可选近地铁满五年 VR房源新上随时看房特性 └ property_management String 可选北京市天宝伟业物业管理有限责任公司物业公司 └ community_alias String 可选颐景园颐景园曲水苑颐景园留云苑小区别名 └ broker_tele String 可选 4008163008 经纪人电话 └ house_area String 可选 122.00 面积 └ house_toward String 可选南北朝向 └ floor_desc String 可选中楼层楼层 └ prov String 可选浙江省份 └ property_unit_price String 可选 3.00 物业费 └ lat String 可选 120.21551 经度 └ parking_ratio String 可选 2 车位比 └ unit_price String 可选 50000.00 单价 └ address String 可选杭州东路50号地址 └ lng String 可选 30.25308 纬度 └ house_type String 可选 3室2厅2卫户型 └ houses_for_sale Number 可选 15 在售房屋套数 └ community String 可选颐景园小区 └ volume_rate String 可选 2.00 容积率 └ img_url String 可选 ... 主图url └ item_id Number 可选 100000001 id └ district String 可选未来科技城商圈 └ total_floor Number 可选 12 总楼层 └ houses_for_rent Number 可选 100 在租房屋套数 └ location String 可选 330106 区位码 └ greening_rate String 可选 30.00 绿化率 └ building_type String 可选塔楼建筑类型

名称	类型	描述
result_code	ResultCode	结果描述
└ code String 10000 错误码 └ message String success 错误信息
value	Number []	成功上传的商品ID列表

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
PaimaiItemCooperationSyncRequest req = new PaimaiItemCooperationSyncRequest();
req.setDs(20221031L);
PaimaiItemCooperationSyncRequest.ItemDo obj1 = new PaimaiItemCooperationSyncRequest.ItemDo();
obj1.setRefUnitPrice("40000.00");
obj1.setCity("杭州");
obj1.setTotalPrice("4990000.00");
obj1.setTitle("房子精装修 带地暖 带花园 采光无遮挡 满五年");
obj1.setHousePurpose("普通住宅");
obj1.setTransOwnership("商品房住宅");
obj1.setCommunityScore("9.00");
obj1.setBuildingTime(2020L);
obj1.setFeature("近地铁 满五年 VR房源 新上 随时看房");
obj1.setPropertyManagement("北京市天宝伟业物业管理有限责任公司");
obj1.setCommunityAlias("颐景园 颐景园曲水苑 颐景园留云苑");
obj1.setBrokerTele("4008163008");
obj1.setHouseArea("122.00");
obj1.setHouseToward("南 北");
obj1.setFloorDesc("中楼层");
obj1.setProv("浙江");
obj1.setPropertyUnitPrice("3.00");
obj1.setLat("120.21551");
obj1.setParkingRatio("2");
obj1.setUnitPrice("50000.00");
obj1.setAddress("杭州东路50号");
obj1.setLng("30.25308");
obj1.setHouseType("3室2厅2卫");
obj1.setHousesForSale(15L);
obj1.setCommunity("颐景园");
obj1.setVolumeRate("2.00");
obj1.setImgUrl("...");
obj1.setItemId(100000001L);
obj1.setDistrict("未来科技城");
obj1.setTotalFloor(12L);
obj1.setHousesForRent(100L);
obj1.setLocation("330106");
obj1.setGreeningRate("30.00");
obj1.setBuildingType("塔楼");
req.setItemDo(obj1);
PaimaiItemCooperationSyncResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
PaimaiItemCooperationSyncRequest req = new PaimaiItemCooperationSyncRequest();
req.Ds = 20221031L;
PaimaiItemCooperationSyncRequest.ItemDoDomain obj1 = new PaimaiItemCooperationSyncRequest.ItemDoDomain();
obj1.RefUnitPrice = "40000.00";
obj1.City = "杭州";
obj1.TotalPrice = "4990000.00";
obj1.Title = "房子精装修 带地暖 带花园 采光无遮挡 满五年";
obj1.HousePurpose = "普通住宅";
obj1.TransOwnership = "商品房住宅";
obj1.CommunityScore = "9.00";
obj1.BuildingTime = 2020L;
obj1.Feature = "近地铁 满五年 VR房源 新上 随时看房";
obj1.PropertyManagement = "北京市天宝伟业物业管理有限责任公司";
obj1.CommunityAlias = "颐景园 颐景园曲水苑 颐景园留云苑";
obj1.BrokerTele = "4008163008";
obj1.HouseArea = "122.00";
obj1.HouseToward = "南 北";
obj1.FloorDesc = "中楼层";
obj1.Prov = "浙江";
obj1.PropertyUnitPrice = "3.00";
obj1.Lat = "120.21551";
obj1.ParkingRatio = "2";
obj1.UnitPrice = "50000.00";
obj1.Address = "杭州东路50号";
obj1.Lng = "30.25308";
obj1.HouseType = "3室2厅2卫";
obj1.HousesForSale = 15L;
obj1.Community = "颐景园";
obj1.VolumeRate = "2.00";
obj1.ImgUrl = "...";
obj1.ItemId = 100000001L;
obj1.District = "未来科技城";
obj1.TotalFloor = 12L;
obj1.HousesForRent = 100L;
obj1.Location = "330106";
obj1.GreeningRate = "30.00";
obj1.BuildingType = "塔楼";
req.ItemDo_ = obj1;
PaimaiItemCooperationSyncResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new PaimaiItemCooperationSyncRequest;
$req->setDs("20221031");
$item_do = new ItemDo;
$item_do->ref_unit_price="40000.00";
$item_do->city="杭州";
$item_do->total_price="4990000.00";
$item_do->title="房子精装修 带地暖 带花园 采光无遮挡 满五年";
$item_do->house_purpose="普通住宅";
$item_do->trans_ownership="商品房住宅";
$item_do->community_score="9.00";
$item_do->building_time="2020";
$item_do->feature="近地铁 满五年 VR房源 新上 随时看房";
$item_do->property_management="北京市天宝伟业物业管理有限责任公司";
$item_do->community_alias="颐景园 颐景园曲水苑 颐景园留云苑";
$item_do->broker_tele="4008163008";
$item_do->house_area="122.00";
$item_do->house_toward="南 北";
$item_do->floor_desc="中楼层";
$item_do->prov="浙江";
$item_do->property_unit_price="3.00";
$item_do->lat="120.21551";
$item_do->parking_ratio="2";
$item_do->unit_price="50000.00";
$item_do->address="杭州东路50号";
$item_do->lng="30.25308";
$item_do->house_type="3室2厅2卫";
$item_do->houses_for_sale="15";
$item_do->community="颐景园";
$item_do->volume_rate="2.00";
$item_do->img_url="...";
$item_do->item_id="100000001";
$item_do->district="未来科技城";
$item_do->total_floor="12";
$item_do->houses_for_rent="100";
$item_do->location="330106";
$item_do->greening_rate="30.00";
$item_do->building_type="塔楼";
$req->setItemDo(json_encode($item_do));
$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.item.cooperation.sync' \
-d 'partner_id=apidoc' \
-d 'sign=A8E5F97B2B9D9F17BC70FFF04085650B' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-03+23%3A47%3A14' \
-d 'v=2.0' \
-d 'ds=20221031' \
-d 'item_do=%E6%97%A0'

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

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

req.ds=20221031
req.item_do="无"
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.item.cooperation.sync");
add_param(pRequest,"ds","20221031");
add_param(pRequest,"item_do","数据结构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.item.cooperation.sync', {
	'ds':'20221031',
	'item_do':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<paimai_item_cooperation_sync_response>
    <result_code>
        <code>10000</code>
        <message>success</message>
    </result_code>
</paimai_item_cooperation_sync_response>

{
    "paimai_item_cooperation_sync_response":{
        "result_code":{
            "code":"10000",
            "message":"success"
        }
    }
}

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.item.cooperation.sync (商品同步)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ