淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
storeId	Number	可选	13333	最大长度：64	商户中心storeId，不填则搜索企业下商品
pageSize	Number	必须	0		页面
pageNo	Number	必须	100		数据个数
sellerId	Number	必须	12342		企业用户id
startGmtModified	String	可选	2017-11-11 11:11:11		商品的开始更新时间,格式：YYYY-MM-DD HH:mm:ss
endGmtModified	String	可选	2017-01-11 11:11:11		商品的结束更新时间，格式：YYYY-MM-DD HH:mm:ss
auctionStatus	Number []	可选		最大列表长度：999	商品状态，0：有效；其他：无效

名称	类型	示例值	描述
success	Boolean	true/false	是否成功
errCode	String	500	错误码
data	ItemDTO []		商品列表
└ itemId Number 23333 商品ID └ outId String huohao 外部编码/一般与货号相同 └ barcode String 234231 商品条码,69码 └ categoryId Number 2342123 阿里后台叶子类目ID └ brandName String only 品牌名称 └ brandId Number 12423 品牌ID └ pics String [] http:// 图片地址，第一个为首焦图 └ sellerId Number 453453 卖家ID └ price Number 234 单位“分”，吊牌价 └ promotionPrice Number 1232 单位“分”，销售价/优惠价 └ title String 我是标题商品标题 └ goodsNo String huohao 货号 └ status Number 0 天猫线上宝贝状态，0:有效，其它为无效 └ classifition String 我是分类发布宝贝的时候传入的自定义信息 skuList SkuDTO [] 商品sku列表 └ skuId Number 1232 零售核心skuId，零售核心交易链路中使用 └ refId Number 234234224 天猫宝贝的skuId，如果与天猫其它系统交互，使用此id └ status Number 1 天猫sku状态，1:有效，-1:无效 properties PropertyDTO [] 商品销售属性 └ valueId Number 3453 属性值id └ valueText String 大属性值 └ propertyId Number 2432 属性id └ propertyText String 型号属性名称 └ price String 212 商品销售价 └ tagPrice String 1312 商品吊牌价 propertyList PropertyDTO [] 商品属性 └ valueId Number 3245 属性值id └ valueText String only 属性值 └ propertyId Number 20000 属性id └ propertyText String 品牌属性名称 └ categoryName String 男装阿里后台叶子类目名称 └ type Number 1 1:集团纬度商品，2:门店商品

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

QimenCloudClient client = new DefaultQimenCloudClient(url, appkey, secret);
AlibabaUniGoodsSearchRequest req = new AlibabaUniGoodsSearchRequest();
req.setStoreId(13333L);
req.setPageSize(0L);
req.setPageNo(100L);
req.setSellerId(12342L);
req.setStartGmtModified("2017-11-11 11:11:11");
req.setEndGmtModified("2017-01-11 11:11:11");
req.setAuctionStatus("");
AlibabaUniGoodsSearchResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaUniGoodsSearchRequest req = new AlibabaUniGoodsSearchRequest();
req.StoreId = 13333L;
req.PageSize = 0L;
req.PageNo = 100L;
req.SellerId = 12342L;
req.StartGmtModified = "2017-11-11 11:11:11";
req.EndGmtModified = "2017-01-11 11:11:11";
req.AuctionStatus = "";
AlibabaUniGoodsSearchResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaUniGoodsSearchRequest;
$req->setStoreId("13333");
$req->setPageSize("0");
$req->setPageNo("100");
$req->setSellerId("12342");
$req->setStartGmtModified("2017-11-11 11:11:11");
$req->setEndGmtModified("2017-01-11 11:11:11");
$req->setAuctionStatus("");
$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=qimen.alibaba.uni.goods.search' \
-d 'partner_id=apidoc' \
-d 'session=5f41e732-6c8f-4a0a-8168-5c08f16cd4c0' \
-d 'sign=6E523BD85B67C7F8A53920805393E50F' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-29+20%3A24%3A11' \
-d 'v=2.0' \
-d 'auctionStatus=null' \
-d 'endGmtModified=2017-01-11+11%3A11%3A11' \
-d 'pageNo=100' \
-d 'pageSize=0' \
-d 'sellerId=12342' \
-d 'startGmtModified=2017-11-11+11%3A11%3A11' \
-d 'storeId=13333'

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

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

req.storeId=13333
req.pageSize=0
req.pageNo=100
req.sellerId=12342
req.startGmtModified="2017-11-11 11:11:11"
req.endGmtModified="2017-01-11 11:11:11"
req.auctionStatus="null"
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,"qimen.alibaba.uni.goods.search");
add_param(pRequest,"storeId","13333");
add_param(pRequest,"pageSize","0");
add_param(pRequest,"pageNo","100");
add_param(pRequest,"sellerId","12342");
add_param(pRequest,"startGmtModified","2017-11-11 11:11:11");
add_param(pRequest,"endGmtModified","2017-01-11 11:11:11");
add_param(pRequest,"auctionStatus","");
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',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('qimen.alibaba.uni.goods.search', {
	'storeId':'13333',
	'pageSize':'0',
	'pageNo':'100',
	'sellerId':'12342',
	'startGmtModified':'2017-11-11 11:11:11',
	'endGmtModified':'2017-01-11 11:11:11',
	'auctionStatus':''
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<success>true/false</success>
<errCode>500</errCode>
<data>
    <item_d_t_o>
        <itemId>23333</itemId>
        <outId>huohao</outId>
        <barcode>234231</barcode>
        <categoryId>2342123</categoryId>
        <brandName>only</brandName>
        <brandId>12423</brandId>
        <pics>
            <string>http://</string>
        </pics>
        <sellerId>453453</sellerId>
        <price>234</price>
        <promotionPrice>1232</promotionPrice>
        <title>我是标题</title>
        <goodsNo>huohao</goodsNo>
        <status>0</status>
        <classifition>我是分类</classifition>
        <skuList>
            <sku_d_t_o>
                <skuId>1232</skuId>
                <refId>234234224</refId>
                <status>1</status>
                <properties>
                    <property_d_t_o>
                        <valueId>3453</valueId>
                        <valueText>大</valueText>
                        <propertyId>2432</propertyId>
                        <propertyText>型号</propertyText>
                    </property_d_t_o>
                </properties>
                <price>212</price>
                <tagPrice>1312</tagPrice>
            </sku_d_t_o>
        </skuList>
        <propertyList>
            <property_d_t_o>
                <valueId>3245</valueId>
                <valueText>only</valueText>
                <propertyId>20000</propertyId>
                <propertyText>品牌</propertyText>
            </property_d_t_o>
        </propertyList>
        <categoryName>男装</categoryName>
        <type>1</type>
    </item_d_t_o>
</data>

{
    "success":true/false,
    "errCode":"500",
    "data":{
        "item_d_t_o":[
            {
                "itemId":23333,
                "outId":"huohao",
                "barcode":"234231",
                "categoryId":2342123,
                "brandName":"only",
                "brandId":12423,
                "pics":{
                    "string":[
                        "http:\/\/"
                    ]
                },
                "sellerId":453453,
                "price":234,
                "promotionPrice":1232,
                "title":"我是标题",
                "goodsNo":"huohao",
                "status":0,
                "classifition":"我是分类",
                "skuList":{
                    "sku_d_t_o":[
                        {
                            "skuId":1232,
                            "refId":234234224,
                            "status":1,
                            "properties":{
                                "property_d_t_o":[
                                    {
                                        "valueId":3453,
                                        "valueText":"大",
                                        "propertyId":2432,
                                        "propertyText":"型号"
                                    }
                                ]
                            },
                            "price":"212",
                            "tagPrice":"1312"
                        }
                    ]
                },
                "propertyList":{
                    "property_d_t_o":[
                        {
                            "valueId":3245,
                            "valueText":"only",
                            "propertyId":20000,
                            "propertyText":"品牌"
                        }
                    ]
                },
                "categoryName":"男装",
                "type":1
            }
        ]
    }
}

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

qimen.alibaba.uni.goods.search (线下商品搜索接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ