文档中心 > API类目 > 分销

tmall.channel.products.get (查询供应商的产品数据)

查询供应商的产品数据。 * 入参传入pids将优先查询，即只按这个条件查询。 *入参传入sku_number将优先查询(没有传入pids)，即只按这个条件查询(最多显示50条) * 入参fields传skus将查询sku的数据，不传该参数默认不查询，返回产品的其它信息。 * 入参fields传入images将查询多图数据，不传只返回主图数据。 * 入参fields仅对传入pids生效（只有按ID查询时，才能查询额外的数据） * 查询结果按照产品发布时间倒序，即时间近的数据在前。 * 传入channel 渠道，会只返回相应渠道的产品

公共参数

请求地址：

环境	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_query_product_d_o	TopQueryProductDo	可选			top_query_product_d_o
└ ids Number [] 可选 [1,2] 要查询的产品id 列表 └ page_size Number 可选 10 分页大小 └ product_line_id Number 可选 24001 产品线id └ page_num Number 可选 1 当前要查看的页数 └ product_outer_id String 可选 xx0001 产品商家编码 └ item_ids Number [] 可选 [1,2,3] 关联的前端宝贝id列表 └ sku_outer_id String 可选 sku001 sku商家编码 └ channel Number 可选 21 渠道[21 零售plus]

响应参数

名称	类型	示例值	描述
products	TopProductDO []	无	产品对象记录集
└ city String 杭州所在地：市 └ cost_price_yuan String 1.01 代销采购价格，单位：元。 └ desc_path String http://img03.taobaocdn.com/xxx.dpc 产品描述路径，通过http请求获取 └ created Date 2000-01-01 00:00:00 创建时间 └ modified Date 2000-01-01 00:00:00 更新时间 └ have_invoice Number true 是否有发票，可选值：false（否）、true（是） └ have_quarantee Number true 是否有保修，可选值：false（否）、true（是） └ auction_id Number 10002 关联的前台宝贝id └ items_count Number 10 下载人数 └ postage_ems String 12 ems费用，单位：元 └ postage_fast String 6 快递费用，单位：元 └ postage_id Number 5545 运费模板ID └ postage_ordinary String 4.20 平邮费用，单位：元 └ postage_type Number 1 运费类型：1（供应商承担运费）、2（分销商承担运费）可选值：seller（供应商承担运费）、buyer（分销商承担运费） └ pid Number 100001 产品ID └ product_line_id Number 23001 产品所属产品线id └ outer_id String 1 商家编码 └ prov String 浙江所在地：省 └ quantity Number 100 产品库存 └ retail_price_high String 100 最高零售价，单位：元。 └ retail_price_low String 99 最低零售价，单位：元。 └ sc_item_id Number 1 scItemId skus ProductSkuDo [] 1 分销产品SKU列表 └ auction_sku_id Number 1 关联的前端宝贝skuid └ cost_price_fen Number 100 代销采购价:单位分 └ price_cost_dealer_fen Number 100 经销采购价:单位分 └ properties String 1243:1215;5626:5125 sku的销售属性组合字符串。格式:pid:vid;pid:vid,如:1627207:3232483;1630696:3284570,表示:机身颜色:军绿色;手机套餐:一电一充。 └ quantity Number 1 库存 └ quota_quantity Number 100 配额可用库存 └ reserved_quantity Number 1 预扣库存 └ scitem_id Number 1 关联的后端商品id └ sku_id Number 1 skuId └ outer_id String 1 商家编码 └ standard_price_fen Number 100 市场价单位分 └ spu_id Number 1 spuId └ standard_price String 1 市场价：单位元 └ status Number 1 发布状态： 1 上架，2 下架，3 删除 └ name String 1 产品名称 └ orders_count Number 1 累计采购次数 └ pictures String http://img01.taobaocdn.com/xxx.jpg,http://img01.taobaocdn.com/xxx.jpg 产品图片路径列表，用“,”分隔
total_results	Number	99	查询结果记录数

请求示例

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TmallChannelProductsGetRequest req = new TmallChannelProductsGetRequest();
TmallChannelProductsGetRequest.TopQueryProductDo obj1 = new TmallChannelProductsGetRequest.TopQueryProductDo();
obj1.setIds(new Long[] { 1,2 };
);
obj1.setPageSize(10L);
obj1.setProductLineId(24001L);
obj1.setPageNum(1L);
obj1.setProductOuterId("xx0001");
obj1.setItemIds(new Long[] { 1,2,3 };
);
obj1.setSkuOuterId("sku001");
obj1.setChannel(21L);
req.setTopQueryProductDO(obj1);
TmallChannelProductsGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TmallChannelProductsGetRequest req = new TmallChannelProductsGetRequest();
TmallChannelProductsGetRequest.TopQueryProductDoDomain obj1 = new TmallChannelProductsGetRequest.TopQueryProductDoDomain();
obj1.Ids = new long[] { 1,2 };
;
obj1.PageSize = 10L;
obj1.ProductLineId = 24001L;
obj1.PageNum = 1L;
obj1.ProductOuterId = "xx0001";
obj1.ItemIds = new long[] { 1,2,3 };
;
obj1.SkuOuterId = "sku001";
obj1.Channel = 21L;
req.TopQueryProductDO_ = obj1;
TmallChannelProductsGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TmallChannelProductsGetRequest;
$top_query_product_d_o = new TopQueryProductDo;
$top_query_product_d_o->ids="[1,2]";
$top_query_product_d_o->page_size="10";
$top_query_product_d_o->product_line_id="24001";
$top_query_product_d_o->page_num="1";
$top_query_product_d_o->product_outer_id="xx0001";
$top_query_product_d_o->item_ids="[1,2,3]";
$top_query_product_d_o->sku_outer_id="sku001";
$top_query_product_d_o->channel="21";
$req->setTopQueryProductDO(json_encode($top_query_product_d_o));
$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=tmall.channel.products.get' \
-d 'partner_id=apidoc' \
-d 'session=fcce7035-917f-400c-98be-9558bebac7fb' \
-d 'sign=B6C8E3DABA8A394D6B4B007860854932' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+18%3A51%3A23' \
-d 'v=2.0' \
-d 'top_query_product_d_o=null'

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

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

req.top_query_product_d_o=""
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,"tmall.channel.products.get");
add_param(pRequest,"top_query_product_d_o","数据结构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('tmall.channel.products.get', {
	'top_query_product_d_o':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

XML示例
JSON示例

<tmall_channel_products_get_response>
    <products>
        <top_product_d_o>
            <city>杭州</city>
            <cost_price_yuan>1.01</cost_price_yuan>
            <desc_path>http://img03.taobaocdn.com/xxx.dpc</desc_path>
            <created>2000-01-01 00:00:00</created>
            <modified>2000-01-01 00:00:00</modified>
            <have_invoice>true</have_invoice>
            <have_quarantee>true</have_quarantee>
            <auction_id>10002</auction_id>
            <items_count>10</items_count>
            <postage_ems>12</postage_ems>
            <postage_fast>6</postage_fast>
            <postage_id>5545</postage_id>
            <postage_ordinary>4.20</postage_ordinary>
            <postage_type>1</postage_type>
            <pid>100001</pid>
            <product_line_id>23001</product_line_id>
            <outer_id>1</outer_id>
            <prov>浙江</prov>
            <quantity>100</quantity>
            <retail_price_high>100</retail_price_high>
            <retail_price_low>99</retail_price_low>
            <sc_item_id>1</sc_item_id>
            <skus>
                <product_sku_do>
                    <auction_sku_id>1</auction_sku_id>
                    <cost_price_fen>100</cost_price_fen>
                    <price_cost_dealer_fen>100</price_cost_dealer_fen>
                    <properties>1243:1215;5626:5125</properties>
                    <quantity>1</quantity>
                    <quota_quantity>100</quota_quantity>
                    <reserved_quantity>1</reserved_quantity>
                    <scitem_id>1</scitem_id>
                    <sku_id>1</sku_id>
                    <outer_id>1</outer_id>
                    <standard_price_fen>100</standard_price_fen>
                </product_sku_do>
            </skus>
            <spu_id>1</spu_id>
            <standard_price>1</standard_price>
            <status>1</status>
            <name>1</name>
            <orders_count>1</orders_count>
            <pictures>http://img01.taobaocdn.com/xxx.jpg,http://img01.taobaocdn.com/xxx.jpg</pictures>
        </top_product_d_o>
    </products>
    <total_results>99</total_results>
</tmall_channel_products_get_response>

{
    "tmall_channel_products_get_response":{
        "products":{
            "top_product_d_o":[
                {
                    "city":"杭州",
                    "cost_price_yuan":"1.01",
                    "desc_path":"http:\/\/img03.taobaocdn.com\/xxx.dpc",
                    "created":"2000-01-01 00:00:00",
                    "modified":"2000-01-01 00:00:00",
                    "have_invoice":true,
                    "have_quarantee":true,
                    "auction_id":10002,
                    "items_count":10,
                    "postage_ems":"12",
                    "postage_fast":"6",
                    "postage_id":5545,
                    "postage_ordinary":"4.20",
                    "postage_type":1,
                    "pid":100001,
                    "product_line_id":23001,
                    "outer_id":"1",
                    "prov":"浙江",
                    "quantity":100,
                    "retail_price_high":"100",
                    "retail_price_low":"99",
                    "sc_item_id":1,
                    "skus":{
                        "product_sku_do":[
                            {
                                "auction_sku_id":1,
                                "cost_price_fen":100,
                                "price_cost_dealer_fen":100,
                                "properties":"1243:1215;5626:5125",
                                "quantity":1,
                                "quota_quantity":100,
                                "reserved_quantity":1,
                                "scitem_id":1,
                                "sku_id":1,
                                "outer_id":"1",
                                "standard_price_fen":100
                            }
                        ]
                    },
                    "spu_id":1,
                    "standard_price":"1",
                    "status":1,
                    "name":"1",
                    "orders_count":1,
                    "pictures":"http:\/\/img01.taobaocdn.com\/xxx.jpg,http:\/\/img01.taobaocdn.com\/xxx.jpg"
                }
            ]
        },
        "total_results":99
    }
}

异常示例

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工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

分销