淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
isv_product_search_request	ISVProductSearchRequest	必须			搜索请求对象
└ title String 可选奶粉产品标题 page_param PageParam 必须分页参数 └ page_no Number 必须 1 页码 └ page_size Number 必须 10 每页数量 └ tags String [] 可选 gj_zx 产品标（gj_zx-全球购甄选，qqg-全球购， outbound-保税区发货，inland-大贸） cost_price_range PriceRange 可选成本价范围 └ high BigDecimal 可选 200.00 范围上限 └ low BigDecimal 可选 100.00 范围下限 order Order 可选排序 └ order_type String 可选 desc 排序方式（desc-降序，asc-升序） └ order_by String 可选 costPrice 排序属性（空-综合排序，"costPrice"-成本价）

名称	类型	示例值	描述
page_no	Number	1	页码
result_code	Number	10001	错误码
page_size	Number	10	每页数量
total_count	Number	500	记录总数量
result_msg	String	参数不合法	错误信息
data	ISVProductSearchResultVO []		搜索结果实体
└ supplier_item_id Number 658218539444 渠道产品id └ title String 泥膜产品标题 └ cost_price BigDecimal 90.00 成本价 └ suggest_retail_price BigDecimal 100.00 建议零售价 └ pic_url String i4/2214218025807/O1CN01znpRzl1sleoqLwp9j_!!2214218025807.jpg 图片地址（前缀拼接https://img.alicdn.com/imgextra） └ tags String [] 渠道产品标 cost_price_range PriceRange 成本价范围 └ low BigDecimal 100.00 最低价 └ high BigDecimal 200.00 最高价 suggest_retail_price_range PriceRange 建议零售价范围 └ low BigDecimal 100.00 最低价 └ high BigDecimal 200.00 最高价
is_success	Boolean	true	是否成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TfxProductSearchRequest req = new TfxProductSearchRequest();
TfxProductSearchRequest.ISVProductSearchRequest obj1 = new TfxProductSearchRequest.ISVProductSearchRequest();
obj1.setTitle("奶粉");
TfxProductSearchRequest.PageParam obj2 = new TfxProductSearchRequest.PageParam();
obj2.setPageNo(1L);
obj2.setPageSize(10L);
obj1.setPageParam(obj2);
obj1.setTags("gj_zx");
TfxProductSearchRequest.PriceRange obj3 = new TfxProductSearchRequest.PriceRange();
obj3.setHigh("200.00");
obj3.setLow("100.00");
obj1.setCostPriceRange(obj3);
TfxProductSearchRequest.Order obj4 = new TfxProductSearchRequest.Order();
obj4.setOrderType("desc");
obj4.setOrderBy("costPrice");
obj1.setOrder(obj4);
req.setIsvProductSearchRequest(obj1);
TfxProductSearchResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TfxProductSearchRequest req = new TfxProductSearchRequest();
TfxProductSearchRequest.ISVProductSearchRequestDomain obj1 = new TfxProductSearchRequest.ISVProductSearchRequestDomain();
obj1.Title = "奶粉";
TfxProductSearchRequest.PageParamDomain obj2 = new TfxProductSearchRequest.PageParamDomain();
obj2.PageNo = 1L;
obj2.PageSize = 10L;
obj1.PageParam= obj2;
obj1.Tags = "gj_zx";
TfxProductSearchRequest.PriceRangeDomain obj3 = new TfxProductSearchRequest.PriceRangeDomain();
obj3.High = "200.00";
obj3.Low = "100.00";
obj1.CostPriceRange= obj3;
TfxProductSearchRequest.OrderDomain obj4 = new TfxProductSearchRequest.OrderDomain();
obj4.OrderType = "desc";
obj4.OrderBy = "costPrice";
obj1.Order= obj4;
req.IsvProductSearchRequest_ = obj1;
TfxProductSearchResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TfxProductSearchRequest;
$isv_product_search_request = new ISVProductSearchRequest;
$isv_product_search_request->title="奶粉";
$page_param = new PageParam;
$page_param->page_no="1";
$page_param->page_size="10";
$isv_product_search_request->page_param = $page_param;
$isv_product_search_request->tags="gj_zx";
$cost_price_range = new PriceRange;
$cost_price_range->high="200.00";
$cost_price_range->low="100.00";
$isv_product_search_request->cost_price_range = $cost_price_range;
$order = new Order;
$order->order_type="desc";
$order->order_by="costPrice";
$isv_product_search_request->order = $order;
$req->setIsvProductSearchRequest(json_encode($isv_product_search_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.tfx.product.search' \
-d 'partner_id=apidoc' \
-d 'session=bcc54952-9924-4126-ad18-d9f9d5240f20' \
-d 'sign=8C7E6D98D50C07DDC6D91B885D8BD934' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+17%3A08%3A21' \
-d 'v=2.0' \
-d 'isv_product_search_request=null'

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

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

req.isv_product_search_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.tfx.product.search");
add_param(pRequest,"isv_product_search_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',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('taobao.tfx.product.search', {
	'isv_product_search_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tfx_product_search_response>
    <page_no>1</page_no>
    <result_code>10001</result_code>
    <page_size>10</page_size>
    <total_count>500</total_count>
    <result_msg>参数不合法</result_msg>
    <data>
        <i_s_v_product_search_result_v_o>
            <supplier_item_id>658218539444</supplier_item_id>
            <title>泥膜</title>
            <cost_price>90.00</cost_price>
            <suggest_retail_price>100.00</suggest_retail_price>
            <pic_url>i4/2214218025807/O1CN01znpRzl1sleoqLwp9j_!!2214218025807.jpg</pic_url>
            <cost_price_range>
                <low>100.00</low>
                <high>200.00</high>
            </cost_price_range>
            <suggest_retail_price_range>
                <low>100.00</low>
                <high>200.00</high>
            </suggest_retail_price_range>
        </i_s_v_product_search_result_v_o>
    </data>
    <is_success>true</is_success>
</tfx_product_search_response>

{
    "tfx_product_search_response":{
        "page_no":1,
        "result_code":10001,
        "page_size":10,
        "total_count":500,
        "result_msg":"参数不合法",
        "data":{
            "i_s_v_product_search_result_v_o":[
                {
                    "supplier_item_id":658218539444,
                    "title":"泥膜",
                    "cost_price":"90.00",
                    "suggest_retail_price":"100.00",
                    "pic_url":"i4\/2214218025807\/O1CN01znpRzl1sleoqLwp9j_!!2214218025807.jpg",
                    "cost_price_range":{
                        "low":"100.00",
                        "high":"200.00"
                    },
                    "suggest_retail_price_range":{
                        "low":"100.00",
                        "high":"200.00"
                    }
                }
            ]
        },
        "is_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

taobao.tfx.product.search (淘分销渠道产品搜索)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ