淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
is_tmall	Boolean	可选	false		商品筛选-是否天猫商品。true表示属于天猫商品，false或不设置表示不限
unid	String	可选	123456		渠道自定义参数
lock_rate_start_time	Number	可选	1567440000000		锁佣开始时间
page_size	Number	可选	20	默认值：20	页大小，默认20，1~100
adzone_id	Number	必须	12345678		mm_xxx_xxx_12345678三段式的最后一段数字
platform	Number	可选	1		链接形式：1：PC，2：无线，默认：１
has_coupon	Boolean	可选	false		优惠券筛选-是否有优惠券。true表示该商品有优惠券，false或不设置表示不限
start_tk_rate	Number	可选	1234		商品筛选-淘客佣金比率下限。如：1234表示12.34%
need_prepay	Boolean	可选	true		商品筛选-是否加入消费者保障。true表示加入，false或不设置表示不限
include_pay_rate30	Boolean	可选	true		商品筛选(特定媒体支持)-成交转化是否高于行业均值。True表示大于等于，false或不设置表示不限
page_no	Number	可选	1	默认值：1	第几页，默认：１
cat	String	可选	16,18		商品筛选-后台类目ID。用,分割，最大10个，该ID可以通过taobao.itemcats.get接口获取到
ucrowd_rank_items	Ucrowdrankitems	可选			物料评估-商品列表
└ commirate Number 可选 1234 物料评估-商品佣金率，如：1234表示12.34%，material_id=41377时选填 └ item_id String 可选 542808901898 物料评估-商品ID，material_id=41377时必填 └ price String 可选 10.12 物料评估-商品价格，单位：元，material_id=41377时选填
lock_rate_end_time	Number	可选	1567440000000		锁佣结束时间
ucrowd_id	Number	可选	1		人群ID，仅适用于物料评估场景material_id=41377
start_price	Number	可选	10		商品筛选-折扣价范围下限。单位：元
device_type	String	可选	IMEI		智能匹配-设备号类型：IMEI，或者IDFA，或者UTDID（UTDID不支持MD5加密），或者OAID
start_ka_tk_rate	Number	可选	1234		商品筛选-KA媒体淘客佣金比率下限。如：1234表示12.34%
include_rfd_rate	Boolean	可选	true		商品筛选(特定媒体支持)-退款率是否低于行业均值。True表示大于等于，false或不设置表示不限
end_tk_rate	Number	可选	1234		商品筛选-淘客佣金比率上限。如：1234表示12.34%
get_topn_rate	Number	可选	0		是否获取前N件佣金信息 0否，1是，其他值否
device_encrypt	String	可选	MD5		智能匹配-设备号加密类型：MD5
end_price	Number	可选	10		商品筛选-折扣价范围上限。单位：元
sort	String	可选	tk_rate_des		排序_des（降序），排序_asc（升序），销量（total_sales），淘客佣金比率（tk_rate），累计推广量（tk_total_sales），总支出佣金（tk_total_commi），价格（price），匹配分（match）
material_id	Number	可选	2836		不传时默认物料id=2836；如果直接对消费者投放，可使用官方个性化算法优化的搜索物料id=17004
is_overseas	Boolean	可选	false		商品筛选-是否海外商品。true表示属于海外商品，false或不设置表示不限
itemloc	String	可选	杭州		商品筛选-所在地
q	String	可选	女装		商品筛选-查询词
npx_level	Number	可选	2		商品筛选-牛皮癣程度。取值：1不限，2无，3轻微
site	String	可选	TW		站点标识：TW(台湾)；HK(香港)；MY(马来)；SG(新加坡)；AU(澳大利亚)；CA(加拿大)；MO(澳门)；KR(韩国)
include_good_rate	Boolean	可选	true		商品筛选-好评率是否高于行业均值。True表示大于等于，false或不设置表示不限
end_ka_tk_rate	Number	可选	1234		商品筛选-KA媒体淘客佣金比率上限。如：1234表示12.34%
create_tpwd	Boolean	可选	false	默认值：false	是否透出淘口令，透出会影响接口性能
device_value	String	可选	xxx		智能匹配-设备号加密后的值（MD5加密需32位小写）
start_dsr	Number	可选	10		商品筛选(特定媒体支持)-店铺dsr评分。筛选大于等于当前设置的店铺dsr评分的商品0-50000之间

名称	类型	示例值	描述
total_results	Number	1212	搜索到符合条件的结果总数
result_list	ItemDTO []		resultList
└ uv_sum_pre_sale Number 23 预售专用-预售数量 └ white_image String https://img.alicdn.com/bao/uploaded/i4/745957850/TB1WzSRmV9gSKJjSspbXXbeNXXa_!!0-item_pic.jpg 商品信息-商品白底图 └ price_after_coupon String 60.00 券后价 └ lock_rate_start_time Number 1567440000000 锁佣开始时间 └ short_title String xxsd 商品信息-商品短标题 └ coupon_id String d62db1ab8d9546b1bf0ff49bda5fc33b 优惠券信息-优惠券id └ small_images String [] 商品信息-商品小图列表 └ coupon_amount Number 10.00 优惠券（元）若属于预售商品，该优惠券付尾款可用，付定金不可用 └ seller_id Number 232323 店铺信息-卖家id └ price String 102.00 商品信息-商品一口价格 └ cpa_reward_type String 0 1 额外奖励活动类型，如果一个商品有多个奖励类型，返回结果使用空格分割，0=单单奖励，1=超级单单奖励 └ coupon_start_time String 2017-10-29 优惠券信息-优惠券开始时间 └ is_brand_flash_sale String 1 是否品牌快抢，0不是，1是 └ item_description String 季凉被全棉亲肤商品信息-宝贝描述(推荐理由) └ lock_rate_end_time Number 1567440000000 锁佣结束时间 └ level_one_category_id Number 20 商品信息-一级类目ID └ level_one_category_name String 女装商品信息-一级类目名称 └ coupon_info String 满299元减20元优惠券信息-优惠券满减信息 maifan_promotion MaifanPromotionDTO 猫超买返卡信息 └ maifan_promotion_discount String 200 猫超买返卡面额 └ maifan_promotion_condition String 100 猫超买返卡总数，-1代表不限量，其他大于等于0的值为总数 └ maifan_promotion_end_time String 1559750399000 猫超买返卡活动结束时间 └ maifan_promotion_start_time String 1559750399000 猫超买返卡活动开始时间 └ presale_start_time Number 1567440000000 预售商品-付定金开始时间（毫秒） └ tmall_play_activity_info String 前n件x折营销-天猫营销玩法 topn_info TopNInfoDTO 前N件佣金信息-前N件佣金生效或预热时透出以下字段 └ topn_quantity Number 3000 前N件剩余库存 └ topn_total_count Number 3000 前N件初始总库存 └ topn_rate String 30 前N件佣金率 └ topn_end_time String 1937297392332 前N件佣金结束时间 └ topn_start_time String 1937297392332 前N件佣金开始时间 └ hot_flag String 1 是否是热门商品，0不是，1是 └ coupon_total_count Number 23223 优惠券信息-优惠券总量 └ volume String 123 商品信息-30天销量（饿了么卡券信息-总销量） └ item_id String 5678899993 商品信息-宝贝id └ match_score String 10.0 物料评估-匹配分 └ x_id String uESS0mv8JvfJRMKlIgCD5At9VuHVBXoqBRihfQlo4ybLiKygRlqiN4eoxoZDfe38uSogWy6GB971jD2N8tLuuc 链接-物料块id(测试中请勿使用) └ reward_info Number 1 比价场景专用，当系统检测到入参消费者ID购买当前商品会获得《天天开彩蛋》玩法的彩蛋时，该字段显示1，否则为0 └ user_type Number 1 店铺信息-卖家类型。0表示集市，1表示天猫 └ click_url String s.click.xxx 链接-宝贝推广链接 └ commission_rate String 1550表示15.5% 商品信息-佣金比率。1550表示15.5% └ reserve_price String 102.00 商品信息-商品一口价格 └ include_dxjh String false 商品信息-是否包含定向计划 └ presale_deposit String 100 预售商品-定金（元） └ superior_brand String 1 是否品牌精选，0不是，1是 └ title String 毛呢阔腿裤港味复古女裤子秋冬九分裤萝卜裤显瘦高腰韩版2017新款商品信息-商品标题 └ category_name String 连衣裙商品信息-叶子类目名称 └ coupon_share_url String s.click.xxx 链接-宝贝+券二合一页面链接 └ zk_final_price String 88.00 折扣价（元）若属于预售商品，付定金时间内，折扣价=预售价 └ nick String 旗舰店店铺信息-卖家昵称 └ commi_score String 20.0 物料评估-收益分 └ tk_total_sales String 11 商品信息-淘客30天推广量 └ presale_end_time Number 1567440000000 预售商品-付定金结束时间（毫秒） └ presale_tail_end_time Number 1567440000000 预售商品-付尾款结束时间（毫秒） └ shop_dsr Number 13 店铺信息-店铺dsr评分 └ commission String 0.52 商品佣金 └ include_mkt String false 商品信息-是否包含营销计划 └ coupon_start_fee String 29.00 优惠券信息-优惠券起用门槛，满X元可用。如：满299元减20元 └ coupon_remain_count Number 111 优惠券信息-优惠券剩余量 └ sale_price String 168 活动价 pintuan_info_dto PintuanInfoDTO 拼团信息 └ jdd_price String 5 拼团专用-拼团拼成价，单位元 └ ostime String 2018-08-21 11:23:43 拼团专用-拼团开始时间 └ orig_price String 25 拼团专用-拼团一人价（原价)，单位元 └ total_stock Number 5555 拼团专用-拼团库存数量 └ stock Number 4444 拼团专用-拼团剩余库存 └ oetime String 2018-08-21 11:23:43 拼团专用-拼团结束时间 └ jdd_num Number 10 拼团专用-拼团几人团 └ sell_num Number 1111 拼团专用-拼团已售数量 └ lock_rate String 1567440000000 锁住的佣金率 └ pict_url String https://img.alicdn.com/bao/uploaded/i4/745957850/TB1WzSRmV9gSKJjSspbXXbeNXXa_!!0-item_pic.jpg 商品信息-商品主图 └ kuadian_promotion_info String ["每100减20","每200减50"] 跨店满减信息 └ presale_tail_start_time Number 1567440000000 预售商品-付尾款开始时间（毫秒） └ real_post_fee String 0.00 商品邮费 └ commission_type String MKT表示营销计划，SP表示定向计划，COMMON表示通用计划商品信息-佣金类型。MKT表示营销计划，SP表示定向计划，COMMON表示通用计划 └ coupon_end_time String 2021-10-29 优惠券信息-优惠券结束时间 bybt_info BybtInfoDTO 百亿补贴信息 └ bybt_end_time String 1559750399000 商品的百亿补贴结束时间 └ bybt_item_tags String [] 百亿补贴商品特征标签，eg.今日发货、晚发补偿、限购一件等 └ bybt_lowest_price String 200.00 全网对比参考价格 └ bybt_pic_url String //img.alicdn.com/bao/uploaded/i4/745957850/TB1WzSRmV9gSKJjSspbXXbeNXXa_!!0-item_pic.jpg 百亿补贴白底图 └ bybt_brand_logo String //img.alicdn.com/bao/uploaded/i4/745957850/TB1WzSRmV9gSKJjSspbXXbeNXXa_!!0-item_pic.jpg 百亿补贴品牌logo └ bybt_coupon_amount String 10.00 百亿补贴专属券面额，仅限百亿补贴场景透出 └ bybt_start_time String 1559750399000 商品的百亿补贴开始时间 └ bybt_show_price String 100.00 百亿补贴页面实时价 └ presale_discount_fee_text String 付定金立减5元预售商品-优惠 └ provcity String 杭州商品信息-宝贝所在地 └ shop_title String xx旗舰店店铺信息-店铺名称 └ category_id Number 162201 商品信息-叶子类目id ysyl_info_dto YsylInfoDTO 预售有礼信息 └ ysyl_tlj_use_start_time String 2019-11-10 21:59:59 预售有礼-淘礼金使用开始时间 └ ysyl_tlj_face String 0.6 预售有礼-预估淘礼金（元） └ ysyl_commission_rate String 2030（表示20.3%）预售有礼-佣金比例（预售有礼活动享受的推广佣金比例，注：推广该活动有特殊分成规则，请详见：https://tbk.bbs.taobao.com/detail.html?appId=45301&postId=9334376 ） └ ysyl_tlj_send_time String 2019-11-10 21:59:59 预售有礼-淘礼金发放时间 └ ysyl_tlj_use_end_time String 2019-11-10 21:59:59 预售有礼-淘礼金使用结束时间 └ ysyl_click_url String https://uland.taobao.com/coupon/edetail?e=nqUNB1NOF3Bt3vqbdXnGloankzPYmeEFkgNrw6YHQf9pZTj41Orn8MwBAs06HAOzqQomYNedOiHDYPmqkFXqLR0HgBdG%2FDDL%2F1M%2FBw7Sf%2FesGXLf%2BqX4cbeC%2F2cR0p0NlWH0%2BknxpnCJJP%2FQkZSsyo1HvKjXo4uz&pid=mm_26381042_12970066_52864659&af=1 预售有礼-推广链接 └ item_url String https://item.taobao.com/item.htm?id=564591813536 链接-宝贝地址 └ tpwd String 38￥CXlf2X6RvlF￥ https://m.tb.cn/h.flR407l 安安粉刺洗面奶200g 去痘去黑头洁面乳温和清洁国货护肤品男女淘口令 └ info_dxjh String {"19013551":"2850","74510538":"2550"} 商品信息-定向计划信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
OvsTbkDgMaterialOptionalGetRequest req = new OvsTbkDgMaterialOptionalGetRequest();
req.setIsTmall(false);
req.setUnid("123456");
req.setLockRateStartTime(1567440000000L);
req.setPageSize(20L);
req.setAdzoneId(12345678L);
req.setPlatform(1L);
req.setHasCoupon(false);
req.setStartTkRate(1234L);
req.setNeedPrepay(true);
req.setIncludePayRate30(true);
req.setPageNo(1L);
req.setCat("16,18");
OvsTbkDgMaterialOptionalGetRequest.Ucrowdrankitems obj1 = new OvsTbkDgMaterialOptionalGetRequest.Ucrowdrankitems();
obj1.setCommirate(1234L);
obj1.setItemId("542808901898");
obj1.setPrice("10.12");
req.setUcrowdRankItems(obj1);
req.setLockRateEndTime(1567440000000L);
req.setUcrowdId(1L);
req.setStartPrice(10L);
req.setDeviceType("IMEI");
req.setStartKaTkRate(1234L);
req.setIncludeRfdRate(true);
req.setEndTkRate(1234L);
req.setGetTopnRate(0L);
req.setDeviceEncrypt("MD5");
req.setEndPrice(10L);
req.setSort("tk_rate_des");
req.setMaterialId(2836L);
req.setIsOverseas(false);
req.setItemloc("杭州");
req.setQ("女装");
req.setNpxLevel(2L);
req.setSite("TW");
req.setIncludeGoodRate(true);
req.setEndKaTkRate(1234L);
req.setCreateTpwd(false);
req.setDeviceValue("xxx");
req.setStartDsr(10L);
OvsTbkDgMaterialOptionalGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
OvsTbkDgMaterialOptionalGetRequest req = new OvsTbkDgMaterialOptionalGetRequest();
req.IsTmall = false;
req.Unid = "123456";
req.LockRateStartTime = 1567440000000L;
req.PageSize = 20L;
req.AdzoneId = 12345678L;
req.Platform = 1L;
req.HasCoupon = false;
req.StartTkRate = 1234L;
req.NeedPrepay = true;
req.IncludePayRate30 = true;
req.PageNo = 1L;
req.Cat = "16,18";
OvsTbkDgMaterialOptionalGetRequest.UcrowdrankitemsDomain obj1 = new OvsTbkDgMaterialOptionalGetRequest.UcrowdrankitemsDomain();
obj1.Commirate = 1234L;
obj1.ItemId = "542808901898";
obj1.Price = "10.12";
req.UcrowdRankItems_ = obj1;
req.LockRateEndTime = 1567440000000L;
req.UcrowdId = 1L;
req.StartPrice = 10L;
req.DeviceType = "IMEI";
req.StartKaTkRate = 1234L;
req.IncludeRfdRate = true;
req.EndTkRate = 1234L;
req.GetTopnRate = 0L;
req.DeviceEncrypt = "MD5";
req.EndPrice = 10L;
req.Sort = "tk_rate_des";
req.MaterialId = 2836L;
req.IsOverseas = false;
req.Itemloc = "杭州";
req.Q = "女装";
req.NpxLevel = 2L;
req.Site = "TW";
req.IncludeGoodRate = true;
req.EndKaTkRate = 1234L;
req.CreateTpwd = false;
req.DeviceValue = "xxx";
req.StartDsr = 10L;
OvsTbkDgMaterialOptionalGetResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new OvsTbkDgMaterialOptionalGetRequest;
$req->setIsTmall("false");
$req->setUnid("123456");
$req->setLockRateStartTime("1567440000000");
$req->setPageSize("20");
$req->setAdzoneId("12345678");
$req->setPlatform("1");
$req->setHasCoupon("false");
$req->setStartTkRate("1234");
$req->setNeedPrepay("true");
$req->setIncludePayRate30("true");
$req->setPageNo("1");
$req->setCat("16,18");
$ucrowd_rank_items = new Ucrowdrankitems;
$ucrowd_rank_items->commirate="1234";
$ucrowd_rank_items->item_id="542808901898";
$ucrowd_rank_items->price="10.12";
$req->setUcrowdRankItems(json_encode($ucrowd_rank_items));
$req->setLockRateEndTime("1567440000000");
$req->setUcrowdId("1");
$req->setStartPrice("10");
$req->setDeviceType("IMEI");
$req->setStartKaTkRate("1234");
$req->setIncludeRfdRate("true");
$req->setEndTkRate("1234");
$req->setGetTopnRate("0");
$req->setDeviceEncrypt("MD5");
$req->setEndPrice("10");
$req->setSort("tk_rate_des");
$req->setMaterialId("2836");
$req->setIsOverseas("false");
$req->setItemloc("杭州");
$req->setQ("女装");
$req->setNpxLevel("2");
$req->setSite("TW");
$req->setIncludeGoodRate("true");
$req->setEndKaTkRate("1234");
$req->setCreateTpwd("false");
$req->setDeviceValue("xxx");
$req->setStartDsr("10");
$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.ovs.tbk.dg.material.optional.get' \
-d 'partner_id=apidoc' \
-d 'sign=BAD935EFDEFBF217350BBAEDA5E2668D' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-27+23%3A01%3A03' \
-d 'v=2.0' \
-d 'adzone_id=12345678' \
-d 'cat=16%2C18' \
-d 'create_tpwd=false' \
-d 'device_encrypt=MD5' \
-d 'device_type=IMEI' \
-d 'device_value=xxx' \
-d 'end_ka_tk_rate=1234' \
-d 'end_price=10' \
-d 'end_tk_rate=1234' \
-d 'get_topn_rate=0' \
-d 'has_coupon=false' \
-d 'include_good_rate=true' \
-d 'include_pay_rate30=true' \
-d 'include_rfd_rate=true' \
-d 'is_overseas=false' \
-d 'is_tmall=false' \
-d 'itemloc=%E6%9D%AD%E5%B7%9E' \
-d 'lock_rate_end_time=1567440000000' \
-d 'lock_rate_start_time=1567440000000' \
-d 'material_id=2836' \
-d 'need_prepay=true' \
-d 'npx_level=2' \
-d 'page_no=1' \
-d 'page_size=20' \
-d 'platform=1' \
-d 'q=%E5%A5%B3%E8%A3%85' \
-d 'site=TW' \
-d 'sort=tk_rate_des' \
-d 'start_dsr=10' \
-d 'start_ka_tk_rate=1234' \
-d 'start_price=10' \
-d 'start_tk_rate=1234' \
-d 'ucrowd_id=1' \
-d 'ucrowd_rank_items=null' \
-d 'unid=123456'

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

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

req.is_tmall=false
req.unid="123456"
req.lock_rate_start_time=1567440000000
req.page_size=20
req.adzone_id=12345678
req.platform=1
req.has_coupon=false
req.start_tk_rate=1234
req.need_prepay=true
req.include_pay_rate30=true
req.page_no=1
req.cat="16,18"
req.ucrowd_rank_items="数据结构示例JSON格式"
req.lock_rate_end_time=1567440000000
req.ucrowd_id=1
req.start_price=10
req.device_type="IMEI"
req.start_ka_tk_rate=1234
req.include_rfd_rate=true
req.end_tk_rate=1234
req.get_topn_rate=0
req.device_encrypt="MD5"
req.end_price=10
req.sort="tk_rate_des"
req.material_id=2836
req.is_overseas=false
req.itemloc="杭州"
req.q="女装"
req.npx_level=2
req.site="TW"
req.include_good_rate=true
req.end_ka_tk_rate=1234
req.create_tpwd=false
req.device_value="xxx"
req.start_dsr=10
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.ovs.tbk.dg.material.optional.get");
add_param(pRequest,"is_tmall","false");
add_param(pRequest,"unid","123456");
add_param(pRequest,"lock_rate_start_time","1567440000000");
add_param(pRequest,"page_size","20");
add_param(pRequest,"adzone_id","12345678");
add_param(pRequest,"platform","1");
add_param(pRequest,"has_coupon","false");
add_param(pRequest,"start_tk_rate","1234");
add_param(pRequest,"need_prepay","true");
add_param(pRequest,"include_pay_rate30","true");
add_param(pRequest,"page_no","1");
add_param(pRequest,"cat","16,18");
add_param(pRequest,"ucrowd_rank_items","数据结构JSON示例");
add_param(pRequest,"lock_rate_end_time","1567440000000");
add_param(pRequest,"ucrowd_id","1");
add_param(pRequest,"start_price","10");
add_param(pRequest,"device_type","IMEI");
add_param(pRequest,"start_ka_tk_rate","1234");
add_param(pRequest,"include_rfd_rate","true");
add_param(pRequest,"end_tk_rate","1234");
add_param(pRequest,"get_topn_rate","0");
add_param(pRequest,"device_encrypt","MD5");
add_param(pRequest,"end_price","10");
add_param(pRequest,"sort","tk_rate_des");
add_param(pRequest,"material_id","2836");
add_param(pRequest,"is_overseas","false");
add_param(pRequest,"itemloc","杭州");
add_param(pRequest,"q","女装");
add_param(pRequest,"npx_level","2");
add_param(pRequest,"site","TW");
add_param(pRequest,"include_good_rate","true");
add_param(pRequest,"end_ka_tk_rate","1234");
add_param(pRequest,"create_tpwd","false");
add_param(pRequest,"device_value","xxx");
add_param(pRequest,"start_dsr","10");
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.ovs.tbk.dg.material.optional.get', {
	'is_tmall':'false',
	'unid':'123456',
	'lock_rate_start_time':'1567440000000',
	'page_size':'20',
	'adzone_id':'12345678',
	'platform':'1',
	'has_coupon':'false',
	'start_tk_rate':'1234',
	'need_prepay':'true',
	'include_pay_rate30':'true',
	'page_no':'1',
	'cat':'16,18',
	'ucrowd_rank_items':'数据结构JSON示例',
	'lock_rate_end_time':'1567440000000',
	'ucrowd_id':'1',
	'start_price':'10',
	'device_type':'IMEI',
	'start_ka_tk_rate':'1234',
	'include_rfd_rate':'true',
	'end_tk_rate':'1234',
	'get_topn_rate':'0',
	'device_encrypt':'MD5',
	'end_price':'10',
	'sort':'tk_rate_des',
	'material_id':'2836',
	'is_overseas':'false',
	'itemloc':'杭州',
	'q':'女装',
	'npx_level':'2',
	'site':'TW',
	'include_good_rate':'true',
	'end_ka_tk_rate':'1234',
	'create_tpwd':'false',
	'device_value':'xxx',
	'start_dsr':'10'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<ovs_tbk_dg_material_optional_get_response>
    <total_results>1212</total_results>
    <result_list>
        <item_d_t_o>
            <uv_sum_pre_sale>23</uv_sum_pre_sale>
            <white_image>https://img.alicdn.com/bao/uploaded/i4/745957850/TB1WzSRmV9gSKJjSspbXXbeNXXa_!!0-item_pic.jpg</white_image>
            <price_after_coupon>60.00</price_after_coupon>
            <lock_rate_start_time>1567440000000</lock_rate_start_time>
            <short_title>xxsd</short_title>
            <coupon_id>d62db1ab8d9546b1bf0ff49bda5fc33b</coupon_id>
            <coupon_amount>10.00</coupon_amount>
            <seller_id>232323</seller_id>
            <price>102.00</price>
            <cpa_reward_type>0 1</cpa_reward_type>
            <coupon_start_time>2017-10-29</coupon_start_time>
            <is_brand_flash_sale>1</is_brand_flash_sale>
            <item_description>季凉被 全棉亲肤</item_description>
            <lock_rate_end_time>1567440000000</lock_rate_end_time>
            <level_one_category_id>20</level_one_category_id>
            <level_one_category_name>女装</level_one_category_name>
            <coupon_info>满299元减20元</coupon_info>
            <maifan_promotion>
                <maifan_promotion_discount>200</maifan_promotion_discount>
                <maifan_promotion_condition>100</maifan_promotion_condition>
                <maifan_promotion_end_time>1559750399000</maifan_promotion_end_time>
                <maifan_promotion_start_time>1559750399000</maifan_promotion_start_time>
            </maifan_promotion>
            <presale_start_time>1567440000000</presale_start_time>
            <tmall_play_activity_info>前n件x折</tmall_play_activity_info>
            <topn_info>
                <topn_quantity>3000</topn_quantity>
                <topn_total_count>3000</topn_total_count>
                <topn_rate>30</topn_rate>
                <topn_end_time>1937297392332</topn_end_time>
                <topn_start_time>1937297392332</topn_start_time>
            </topn_info>
            <hot_flag>1</hot_flag>
            <coupon_total_count>23223</coupon_total_count>
            <volume>123</volume>
            <item_id>5678899993</item_id>
            <match_score>10.0</match_score>
            <x_id>uESS0mv8JvfJRMKlIgCD5At9VuHVBXoqBRihfQlo4ybLiKygRlqiN4eoxoZDfe38uSogWy6GB971jD2N8tLuuc</x_id>
            <reward_info>1</reward_info>
            <user_type>1</user_type>
            <click_url>s.click.xxx</click_url>
            <commission_rate>1550表示15.5%</commission_rate>
            <reserve_price>102.00</reserve_price>
            <include_dxjh>false</include_dxjh>
            <presale_deposit>100</presale_deposit>
            <superior_brand>1</superior_brand>
            <title>毛呢阔腿裤港味复古女裤子秋冬九分裤萝卜裤显瘦高腰韩版2017新款</title>
            <category_name>连衣裙</category_name>
            <coupon_share_url>s.click.xxx</coupon_share_url>
            <zk_final_price>88.00</zk_final_price>
            <nick>旗舰店</nick>
            <commi_score>20.0</commi_score>
            <tk_total_sales>11</tk_total_sales>
            <presale_end_time>1567440000000</presale_end_time>
            <presale_tail_end_time>1567440000000</presale_tail_end_time>
            <shop_dsr>13</shop_dsr>
            <commission>0.52</commission>
            <include_mkt>false</include_mkt>
            <coupon_start_fee>29.00</coupon_start_fee>
            <coupon_remain_count>111</coupon_remain_count>
            <sale_price>168</sale_price>
            <pintuan_info_dto>
                <jdd_price>5</jdd_price>
                <ostime>2018-08-21 11:23:43</ostime>
                <orig_price>25</orig_price>
                <total_stock>5555</total_stock>
                <stock>4444</stock>
                <oetime>2018-08-21 11:23:43</oetime>
                <jdd_num>10</jdd_num>
                <sell_num>1111</sell_num>
            </pintuan_info_dto>
            <lock_rate>1567440000000</lock_rate>
            <pict_url>https://img.alicdn.com/bao/uploaded/i4/745957850/TB1WzSRmV9gSKJjSspbXXbeNXXa_!!0-item_pic.jpg</pict_url>
            <kuadian_promotion_info>[&quot;每100减20&quot;,&quot;每200减50&quot;]</kuadian_promotion_info>
            <presale_tail_start_time>1567440000000</presale_tail_start_time>
            <real_post_fee>0.00</real_post_fee>
            <commission_type>MKT表示营销计划，SP表示定向计划，COMMON表示通用计划</commission_type>
            <coupon_end_time>2021-10-29</coupon_end_time>
            <bybt_info>
                <bybt_end_time>1559750399000</bybt_end_time>
                <bybt_lowest_price>200.00</bybt_lowest_price>
                <bybt_pic_url>//img.alicdn.com/bao/uploaded/i4/745957850/TB1WzSRmV9gSKJjSspbXXbeNXXa_!!0-item_pic.jpg</bybt_pic_url>
                <bybt_brand_logo>//img.alicdn.com/bao/uploaded/i4/745957850/TB1WzSRmV9gSKJjSspbXXbeNXXa_!!0-item_pic.jpg</bybt_brand_logo>
                <bybt_coupon_amount>10.00</bybt_coupon_amount>
                <bybt_start_time>1559750399000</bybt_start_time>
                <bybt_show_price>100.00</bybt_show_price>
            </bybt_info>
            <presale_discount_fee_text>付定金立减5元</presale_discount_fee_text>
            <provcity>杭州</provcity>
            <shop_title>xx旗舰店</shop_title>
            <category_id>162201</category_id>
            <ysyl_info_dto>
                <ysyl_tlj_use_start_time>2019-11-10 21:59:59</ysyl_tlj_use_start_time>
                <ysyl_tlj_face>0.6</ysyl_tlj_face>
                <ysyl_commission_rate>2030（表示20.3%）</ysyl_commission_rate>
                <ysyl_tlj_send_time>2019-11-10 21:59:59</ysyl_tlj_send_time>
                <ysyl_tlj_use_end_time>2019-11-10 21:59:59</ysyl_tlj_use_end_time>
                <ysyl_click_url>https://uland.taobao.com/coupon/edetail?e=nqUNB1NOF3Bt3vqbdXnGloankzPYmeEFkgNrw6YHQf9pZTj41Orn8MwBAs06HAOzqQomYNedOiHDYPmqkFXqLR0HgBdG%2FDDL%2F1M%2FBw7Sf%2FesGXLf%2BqX4cbeC%2F2cR0p0NlWH0%2BknxpnCJJP%2FQkZSsyo1HvKjXo4uz&amp;pid=mm_26381042_12970066_52864659&amp;af=1</ysyl_click_url>
            </ysyl_info_dto>
            <item_url>https://item.taobao.com/item.htm?id=564591813536</item_url>
            <tpwd>38￥CXlf2X6RvlF￥ https://m.tb.cn/h.flR407l  安安粉刺洗面奶200g 去痘去黑头洁面乳温和清洁国货护肤品男女</tpwd>
            <info_dxjh>{&quot;19013551&quot;:&quot;2850&quot;,&quot;74510538&quot;:&quot;2550&quot;}</info_dxjh>
        </item_d_t_o>
    </result_list>
</ovs_tbk_dg_material_optional_get_response>

{
    "ovs_tbk_dg_material_optional_get_response":{
        "total_results":1212,
        "result_list":{
            "item_d_t_o":[
                {
                    "uv_sum_pre_sale":23,
                    "white_image":"https:\/\/img.alicdn.com\/bao\/uploaded\/i4\/745957850\/TB1WzSRmV9gSKJjSspbXXbeNXXa_!!0-item_pic.jpg",
                    "price_after_coupon":"60.00",
                    "lock_rate_start_time":1567440000000,
                    "short_title":"xxsd",
                    "coupon_id":"d62db1ab8d9546b1bf0ff49bda5fc33b",
                    "coupon_amount":10.00,
                    "seller_id":232323,
                    "price":"102.00",
                    "cpa_reward_type":"0 1",
                    "coupon_start_time":"2017-10-29",
                    "is_brand_flash_sale":"1",
                    "item_description":"季凉被 全棉亲肤",
                    "lock_rate_end_time":1567440000000,
                    "level_one_category_id":20,
                    "level_one_category_name":"女装",
                    "coupon_info":"满299元减20元",
                    "maifan_promotion":{
                        "maifan_promotion_discount":"200",
                        "maifan_promotion_condition":"100",
                        "maifan_promotion_end_time":"1559750399000",
                        "maifan_promotion_start_time":"1559750399000"
                    },
                    "presale_start_time":1567440000000,
                    "tmall_play_activity_info":"前n件x折",
                    "topn_info":{
                        "topn_quantity":3000,
                        "topn_total_count":3000,
                        "topn_rate":"30",
                        "topn_end_time":"1937297392332",
                        "topn_start_time":"1937297392332"
                    },
                    "hot_flag":"1",
                    "coupon_total_count":23223,
                    "volume":"123",
                    "item_id":"5678899993",
                    "match_score":"10.0",
                    "x_id":"uESS0mv8JvfJRMKlIgCD5At9VuHVBXoqBRihfQlo4ybLiKygRlqiN4eoxoZDfe38uSogWy6GB971jD2N8tLuuc",
                    "reward_info":1,
                    "user_type":1,
                    "click_url":"s.click.xxx",
                    "commission_rate":"1550表示15.5%",
                    "reserve_price":"102.00",
                    "include_dxjh":"false",
                    "presale_deposit":"100",
                    "superior_brand":"1",
                    "title":"毛呢阔腿裤港味复古女裤子秋冬九分裤萝卜裤显瘦高腰韩版2017新款",
                    "category_name":"连衣裙",
                    "coupon_share_url":"s.click.xxx",
                    "zk_final_price":"88.00",
                    "nick":"旗舰店",
                    "commi_score":"20.0",
                    "tk_total_sales":"11",
                    "presale_end_time":1567440000000,
                    "presale_tail_end_time":1567440000000,
                    "shop_dsr":13,
                    "commission":"0.52",
                    "include_mkt":"false",
                    "coupon_start_fee":"29.00",
                    "coupon_remain_count":111,
                    "sale_price":"168",
                    "pintuan_info_dto":{
                        "jdd_price":"5",
                        "ostime":"2018-08-21 11:23:43",
                        "orig_price":"25",
                        "total_stock":5555,
                        "stock":4444,
                        "oetime":"2018-08-21 11:23:43",
                        "jdd_num":10,
                        "sell_num":1111
                    },
                    "lock_rate":"1567440000000",
                    "pict_url":"https:\/\/img.alicdn.com\/bao\/uploaded\/i4\/745957850\/TB1WzSRmV9gSKJjSspbXXbeNXXa_!!0-item_pic.jpg",
                    "kuadian_promotion_info":"[\"每100减20\",\"每200减50\"]",
                    "presale_tail_start_time":1567440000000,
                    "real_post_fee":"0.00",
                    "commission_type":"MKT表示营销计划，SP表示定向计划，COMMON表示通用计划",
                    "coupon_end_time":"2021-10-29",
                    "bybt_info":{
                        "bybt_end_time":"1559750399000",
                        "bybt_lowest_price":"200.00",
                        "bybt_pic_url":"\/\/img.alicdn.com\/bao\/uploaded\/i4\/745957850\/TB1WzSRmV9gSKJjSspbXXbeNXXa_!!0-item_pic.jpg",
                        "bybt_brand_logo":"\/\/img.alicdn.com\/bao\/uploaded\/i4\/745957850\/TB1WzSRmV9gSKJjSspbXXbeNXXa_!!0-item_pic.jpg",
                        "bybt_coupon_amount":"10.00",
                        "bybt_start_time":"1559750399000",
                        "bybt_show_price":"100.00"
                    },
                    "presale_discount_fee_text":"付定金立减5元",
                    "provcity":"杭州",
                    "shop_title":"xx旗舰店",
                    "category_id":162201,
                    "ysyl_info_dto":{
                        "ysyl_tlj_use_start_time":"2019-11-10 21:59:59",
                        "ysyl_tlj_face":"0.6",
                        "ysyl_commission_rate":"2030（表示20.3%）",
                        "ysyl_tlj_send_time":"2019-11-10 21:59:59",
                        "ysyl_tlj_use_end_time":"2019-11-10 21:59:59",
                        "ysyl_click_url":"https:\/\/uland.taobao.com\/coupon\/edetail?e=nqUNB1NOF3Bt3vqbdXnGloankzPYmeEFkgNrw6YHQf9pZTj41Orn8MwBAs06HAOzqQomYNedOiHDYPmqkFXqLR0HgBdG%2FDDL%2F1M%2FBw7Sf%2FesGXLf%2BqX4cbeC%2F2cR0p0NlWH0%2BknxpnCJJP%2FQkZSsyo1HvKjXo4uz&pid=mm_26381042_12970066_52864659&af=1"
                    },
                    "item_url":"https:\/\/item.taobao.com\/item.htm?id=564591813536",
                    "tpwd":"38￥CXlf2X6RvlF￥ https:\/\/m.tb.cn\/h.flR407l  安安粉刺洗面奶200g 去痘去黑头洁面乳温和清洁国货护肤品男女",
                    "info_dxjh":"{\"19013551\":\"2850\",\"74510538\":\"2550\"}"
                }
            ]
        }
    }
}

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"
	}
}

错误码	错误描述	解决方案
50001	该item_id对应宝贝已下架或非淘客宝贝	更换商品查询
30002	参数q与cat不能都为空	参数q与cat不能都为空

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

开放平台

海外-淘宝客API

taobao.ovs.tbk.dg.material.optional.get (海外淘宝客-推广者-物料搜索-V2)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ