开放平台-文档中心 taobao.tbk.dg.material.optional( 淘宝客-推广者-物料搜索 )
taobao.tbk.dg.material.optional( 淘宝客-推广者-物料搜索 )
通用物料搜索API（导购）
公共参数
请求地址:
环境
HTTP地址
HTTPS地址
正式环境
http://gw.api.taobao.com/router/rest
https://eco.taobao.com/router/rest
公共请求参数:
名称
类型
必须
描述
method
String
是
API接口名称，例如:taobao.tbk.dg.material.optional
app_key
String
是
TOP分配给应用的AppKey，例如：12345678
session
String
否
用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选
timestamp
String
是
时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟
v
String
是
API协议版本，可选值：2.0
sign_method
String
是
签名的摘要算法，可选值为：hmac，md5，hmac-sha256。
sign
String
是
API输入参数签名结果，签名算法介绍请点击这里
format
String
否
响应格式。默认为xml格式，可选值：xml，json。
simplify
Boolean
否
是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false
公共响应参数:
名称
类型
描述
request_id
String
平台颁发的每次请求访问的唯一标识
error_response
String
请求访问失败时返回的根节点
code
String
请求失败返回的错误码
msg
String
请求失败返回的错误信息
sub_code
String
请求失败返回的子错误码
sub_msg
String
请求失败返回的子错误信息
*_response
String
请求成功返回的根节点，'*' 为API名称的下划线模式
请求参数
名称
类型
必须
示例值
描述
start_dsr
Number
false
10
商品筛选(特定媒体支持)-店铺dsr评分。筛选大于等于当前设置的店铺dsr评分的商品0-50000之间
page_size
Number
false
20
页大小，默认20，1~100
page_no
Number
false
1
第几页，默认：１
platform
Number
false
1
链接形式：1：PC，2：无线，默认：１
end_tk_rate
Number
false
1234
商品筛选-淘客佣金比率上限。如：1234表示12.34%
start_tk_rate
Number
false
1234
商品筛选-淘客佣金比率下限。如：1234表示12.34%
end_price
Number
false
10
商品筛选-折扣价范围上限。单位：元
start_price
Number
false
10
商品筛选-折扣价范围下限。单位：元
is_overseas
Boolean
false
false
商品筛选-是否海外商品。true表示属于海外商品，false或不设置表示不限
is_tmall
Boolean
false
false
商品筛选-是否天猫商品。true表示属于天猫商品，false或不设置表示不限
sort
String
false
tk_rate_des
排序_des（降序），排序_asc（升序），销量（total_sales），淘客佣金比率（tk_rate）， 累计推广量（tk_total_sales），总支出佣金（tk_total_commi），价格（price），匹配分（match）
itemloc
String
false
杭州
商品筛选-所在地
cat
String
false
16,18
商品筛选-后台类目ID。用,分割，最大10个，该ID可以通过taobao.itemcats.get接口获取到
q
String
false
女装
商品筛选-查询词
material_id
Number
false
2836
不传时默认物料id=2836；如果直接对消费者投放，可使用官方个性化算法优化的搜索物料id=17004
has_coupon
Boolean
false
false
优惠券筛选-是否有优惠券。true表示该商品有优惠券，false或不设置表示不限
ip
String
false
13.2.33.4
ip参数影响邮费获取，如果不传或者传入不准确，邮费无法精准提供
adzone_id
Number
true
12345678
mm_xxx_xxx_12345678三段式的最后一段数字
need_free_shipment
Boolean
false
true
商品筛选-是否包邮。true表示包邮，false或不设置表示不限
need_prepay
Boolean
false
true
商品筛选-是否加入消费者保障。true表示加入，false或不设置表示不限
include_pay_rate_30
Boolean
false
true
商品筛选(特定媒体支持)-成交转化是否高于行业均值。True表示大于等于，false或不设置表示不限
include_good_rate
Boolean
false
true
商品筛选-好评率是否高于行业均值。True表示大于等于，false或不设置表示不限
include_rfd_rate
Boolean
false
true
商品筛选(特定媒体支持)-退款率是否低于行业均值。True表示大于等于，false或不设置表示不限
npx_level
Number
false
2
商品筛选-牛皮癣程度。取值：1不限，2无，3轻微
end_ka_tk_rate
Number
false
1234
商品筛选-KA媒体淘客佣金比率上限。如：1234表示12.34%
start_ka_tk_rate
Number
false
1234
商品筛选-KA媒体淘客佣金比率下限。如：1234表示12.34%
device_encrypt
String
false
MD5
智能匹配-设备号加密类型：MD5
device_value
String
false
xxx
智能匹配-设备号加密后的值（MD5加密需32位小写）
device_type
String
false
IMEI
智能匹配-设备号类型：IMEI，或者IDFA，或者UTDID（UTDID不支持MD5加密），或者OAID
lock_rate_end_time
Number
false
1567440000000
锁佣结束时间
lock_rate_start_time
Number
false
1567440000000
锁佣开始时间
longitude
String
false
121.473701
本地化业务入参-LBS信息-经度
latitude
String
false
31.230370
本地化业务入参-LBS信息-纬度
city_code
String
false
310000
本地化业务入参-LBS信息-国标城市码，仅支持单个请求，请求饿了么卡券物料时，该字段必填。 （详细城市ID见：https://mo.m.taobao.com/page_2020010315120200508）
seller_ids
String
false
1,2,3,4
商家id，仅支持饿了么卡券商家ID，支持批量请求1-100以内，多个商家ID使用英文逗号分隔
special_id
String
false
2323
会员运营ID
relation_id
String
false
3243
渠道关系ID，仅适用于渠道推广场景
page_result_key
String
false
abcdef
本地化业务入参-分页唯一标识，非首页的请求必传，值为上一页返回结果中的page_result_key字段值
ucrowd_id
Number
false
1
人群ID，仅适用于物料评估场景material_id=41377
ucrowd_rank_items
Ucrowdrankitems[]
false
物料评估-商品列表
commirate
Number
false
1234
物料评估-商品佣金率，如：1234表示12.34%，material_id=41377时选填
price
String
false
10.12
物料评估-商品价格，单位：元，material_id=41377时选填
item_id
String
false
542808901898
物料评估-商品ID，material_id=41377时必填
get_topn_rate
Number
false
0
是否获取前N件佣金信息 0否，1是，其他值否
响应参数
名称
类型
示例值
描述
total_results
Number
1212
搜索到符合条件的结果总数
result_list
MapData []
resultList
coupon_start_time
String
2017-10-29
优惠券信息-优惠券开始时间
coupon_end_time
String
2017-10-29
优惠券信息-优惠券结束时间
info_dxjh
Json
{"19013551":"2850","74510538":"2550"}
商品信息-定向计划信息
tk_total_sales
String
11
商品信息-淘客30天推广量
tk_total_commi
String
323
商品信息-月支出佣金(该字段废弃，请勿再用)
coupon_id
String
d62db1ab8d9546b1bf0ff49bda5fc33b
优惠券信息-优惠券id
num_iid
Number
556633720749
商品信息-宝贝id(该字段废弃，请勿再用)
title
String
毛呢阔腿裤港味复古女裤子秋冬九分裤萝卜裤显瘦高腰韩版2017新款
商品信息-商品标题
pict_url
String
https://img.alicdn.com/bao/uploaded/i4/745957850/TB1WzSRmV9gSKJjSspbXXbeNXXa_!!0-item_pic.jpg
商品信息-商品主图
small_images
String[]
https://img.alicdn.com/i4/3077291146/TB2NA3poDnI8KJjSszgXXc8ApXa_!!3077291146.jpg
商品信息-商品小图列表
reserve_price
String
102.00
商品信息-商品一口价格
zk_final_price
String
88.00
折扣价（元） 若属于预售商品，付定金时间内，折扣价=预售价
user_type
Number
1
店铺信息-卖家类型。0表示集市，1表示天猫
provcity
String
杭州
商品信息-宝贝所在地
item_url
String
https://item.taobao.com/item.htm?id=564591813536
链接-宝贝地址
include_mkt
String
false
商品信息-是否包含营销计划
include_dxjh
String
false
商品信息-是否包含定向计划
commission_rate
String
1550表示15.5%
商品信息-佣金比率。1550表示15.5%
volume
Number
123
商品信息-30天销量（饿了么卡券信息-总销量）
seller_id
Number
232332
店铺信息-卖家id
coupon_total_count
Number
22323
优惠券信息-优惠券总量
coupon_remain_count
Number
111
优惠券信息-优惠券剩余量
coupon_info
String
满299元减20元
优惠券信息-优惠券满减信息
commission_type
String
MKT表示营销计划，SP表示定向计划，COMMON表示通用计划
商品信息-佣金类型。MKT表示营销计划，SP表示定向计划，COMMON表示通用计划
shop_title
String
xx旗舰店
店铺信息-店铺名称
shop_dsr
Number
13
店铺信息-店铺dsr评分
coupon_share_url
String
uland.xxx
链接-宝贝+券二合一页面链接
url
String
s.click.xxx
链接-宝贝推广链接
level_one_category_name
String
女装
商品信息-一级类目名称
level_one_category_id
Number
20
商品信息-一级类目ID
category_name
String
连衣裙
商品信息-叶子类目名称
category_id
Number
162201
商品信息-叶子类目id
short_title
String
xxsd
商品信息-商品短标题
white_image
String
https://img.alicdn.com/bao/uploaded/i4/745957850/TB1WzSRmV9gSKJjSspbXXbeNXXa_!!0-item_pic.jpg
商品信息-商品白底图
oetime
String
2018-08-21 11:23:43
拼团专用-拼团结束时间
ostime
String
2018-08-21 11:23:43
拼团专用-拼团开始时间
jdd_num
Number
10
拼团专用-拼团几人团
jdd_price
String
5
拼团专用-拼团拼成价，单位元
uv_sum_pre_sale
Number
23
预售专用-预售数量
x_id
String
uESS0mv8JvfJRMKlIgCD5At9VuHVBXoqBRihfQlo4ybLiKygRlqiN4eoxoZDfe38uSogWy6GB971jD2N8tLuuc
链接-物料块id(测试中请勿使用)
coupon_start_fee
String
29.00
优惠券信息-优惠券起用门槛，满X元可用。如：满299元减20元
coupon_amount
String
10.00
优惠券（元） 若属于预售商品，该优惠券付尾款可用，付定金不可用
item_description
String
季凉被 全棉亲肤
商品信息-宝贝描述(推荐理由)
nick
String
旗舰店
店铺信息-卖家昵称
orig_price
String
25
拼团专用-拼团一人价（原价)，单位元
total_stock
Number
5555
拼团专用-拼团库存数量
sell_num
Number
1111
拼团专用-拼团已售数量
stock
Number
4444
拼团专用-拼团剩余库存
tmall_play_activity_info
String
前n件x折
营销-天猫营销玩法
item_id
Number
5678899993
商品信息-宝贝id
real_post_fee
String
0.00
商品邮费
lock_rate
String
1567440000000
锁住的佣金率
lock_rate_end_time
Number
1567440000000
锁佣结束时间
lock_rate_start_time
Number
1567440000000
锁佣开始时间
presale_discount_fee_text
String
付定金立减5元
预售商品-优惠
presale_tail_end_time
Number
1567440000000
预售商品-付尾款结束时间（毫秒）
presale_tail_start_time
Number
1567440000000
预售商品-付尾款开始时间（毫秒）
presale_end_time
Number
1567440000000
预售商品-付定金结束时间（毫秒）
presale_start_time
Number
1567440000000
预售商品-付定金开始时间（毫秒）
presale_deposit
String
100
预售商品-定金（元）
ysyl_tlj_send_time
String
2019-11-10 21:59:59
预售有礼-淘礼金发放时间
ysyl_commission_rate
String
2030（表示20.3%）
预售有礼-佣金比例（ 预售有礼活动享受的推广佣金比例，注：推广该活动有特殊分成规则，请详见：https://tbk.bbs.taobao.com/detail.html?appId=45301&postId=9334376 ）
ysyl_tlj_face
String
0.6
预售有礼-预估淘礼金（元）
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
预售有礼-推广链接
ysyl_tlj_use_end_time
String
2019-11-10 21:59:59
预售有礼-淘礼金使用结束时间
ysyl_tlj_use_start_time
String
2019-11-10 21:59:59
预售有礼-淘礼金使用开始时间
sale_begin_time
String
1567440000000
本地化-销售开始时间
sale_end_time
String
1567440000000
本地化-销售结束时间
distance
String
300
本地化-到门店距离（米）
usable_shop_id
String
10001
本地化-可用店铺id
usable_shop_name
String
饿了么卡券专营店
本地化-可用店铺名称
sale_price
String
168
活动价
kuadian_promotion_info
String
["每100减20","每200减50"]
跨店满减信息
superior_brand
String
1
是否品牌精选，0不是，1是
reward_info
Number
1
比价场景专用，当系统检测到入参消费者ID购买当前商品会获得《天天开彩蛋》玩法的彩蛋时，该字段显示1，否则为0
is_brand_flash_sale
String
1
是否品牌快抢，0不是，1是
localization_extend
LocalizationMapData
本地化-扩展信息
order_lead_time
String
45
本地化-配送时间
user_rating
String
4.8
本地化-用户评分
delivery_min_price
String
20
本地化-起送价
delivery_fee
String
1
本地化-配送费
original_delivery_fee
String
3
本地化-配送费原价
delivery_type
String
1
本地化-配送类型；0：蜂鸟专送 1：蜂鸟快送 2：商家自配 3: 全城送
recommend_reasons
String[]
["酱油无骨炸鸡性价比很高","韩国炸鸡中的热卖餐厅"]
本地化-推荐理由
sale_tags
String[]
["15减10","吃货联盟","首次光顾减1"]
本地化-营销标签
food_item_list
FoodMapData[]
本地化-单店商品列表
food_pic
String
https://cube.elemecdn.com/f/7d/7e6f36533e279518460043f81a9c4jpeg.jpeg
本地化-商品图片
food_title
String
单人超巨1+1+1+1自选套餐
本地化-商品标题
food_promotion_price
String
39.88
本地化-商品促销价
food_reserve_price
String
76.8
本地化-商品原价
match_score
String
10.0
物料评估-匹配分
commi_score
String
20.0
物料评估-收益分
hot_flag
String
1
是否是热门商品，0不是，1是
topn_info
TopNInfoDTO
前N件佣金信息-前N件佣金生效或预热时透出以下字段
topn_quantity
Number
3000
前N件剩余库存
topn_total_count
Number
3000
前N件初始总库存
topn_end_time
String
1937297392332
前N件佣金结束时间
topn_start_time
String
1937297392332
前N件佣金开始时间
topn_rate
String
30
前N件佣金率
bybt_info
BybtInfoDTO
百亿补贴信息
bybt_brand_logo
String
//img.alicdn.com/bao/uploaded/i4/745957850/TB1WzSRmV9gSKJjSspbXXbeNXXa_!!0-item_pic.jpg
百亿补贴品牌logo
bybt_pic_url
String
//img.alicdn.com/bao/uploaded/i4/745957850/TB1WzSRmV9gSKJjSspbXXbeNXXa_!!0-item_pic.jpg
百亿补贴白底图
bybt_item_tags
String[]
["https://gw.alicdn.com/tfs/TB1CvN50KH2gK0jSZJnXXaT1FXa-167-42.png?getAvatar=avatar","https://gw.alicdn.com/tfs/TB10rZqkCR26e4jSZFEXXbwuXXa-132-42.png?getAvatar=avatar"]
百亿补贴商品特征标签，eg.今日发货、晚发补偿、限购一件等
bybt_coupon_amount
String
10.00
百亿补贴专属券面额，仅限百亿补贴场景透出
bybt_show_price
String
100.00
百亿补贴页面实时价
bybt_lowest_price
String
200.00
全网对比参考价格
bybt_end_time
String
1559750399000
商品的百亿补贴开始时间
bybt_start_time
String
1559750399000
商品的百亿补贴结束时间
page_result_key
String
abcde
本地化-lbs分页标识，请在下一次翻页时作为入参传入
请求示例
JAVA
PHP
.NET
CURL
Python
NodeJS
C/C++
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TbkDgMaterialOptionalRequest req = new TbkDgMaterialOptionalRequest();
req.setStartDsr(10L);
req.setPageSize(20L);
req.setPageNo(1L);
req.setPlatform(1L);
req.setEndTkRate(1234L);
req.setStartTkRate(1234L);
req.setEndPrice(10L);
req.setStartPrice(10L);
req.setIsOverseas(false);
req.setIsTmall(false);
req.setSort("tk_rate_des");
req.setItemloc("杭州");
req.setCat("16,18");
req.setQ("女装");
req.setMaterialId(2836L);
req.setHasCoupon(false);
req.setIp("13.2.33.4");
req.setAdzoneId(12345678L);
req.setNeedFreeShipment(true);
req.setNeedPrepay(true);
req.setIncludePayRate30(true);
req.setIncludeGoodRate(true);
req.setIncludeRfdRate(true);
req.setNpxLevel(2L);
req.setEndKaTkRate(1234L);
req.setStartKaTkRate(1234L);
req.setDeviceEncrypt("MD5");
req.setDeviceValue("xxx");
req.setDeviceType("IMEI");
req.setLockRateEndTime(1567440000000L);
req.setLockRateStartTime(1567440000000L);
req.setLongitude("121.473701");
req.setLatitude("31.230370");
req.setCityCode("310000");
req.setSellerIds("1,2,3,4");
req.setSpecialId("2323");
req.setRelationId("3243");
req.setPageResultKey("abcdef");
req.setUcrowdId(1L);
List<Ucrowdrankitems> list2 = new ArrayList<Ucrowdrankitems>();
Ucrowdrankitems obj3 = new Ucrowdrankitems();
list2.add(obj3);
obj3.setCommirate(1234L);
obj3.setPrice("10.12");
obj3.setItemId("542808901898");
req.setUcrowdRankItems(list2);
req.setGetTopnRate(0L);
TbkDgMaterialOptionalResponse rsp = client.execute(req);
System.out.println(rsp.getBody());$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TbkDgMaterialOptionalRequest;
$req->setStartDsr("10");
$req->setPageSize("20");
$req->setPageNo("1");
$req->setPlatform("1");
$req->setEndTkRate("1234");
$req->setStartTkRate("1234");
$req->setEndPrice("10");
$req->setStartPrice("10");
$req->setIsOverseas("false");
$req->setIsTmall("false");
$req->setSort("tk_rate_des");
$req->setItemloc("杭州");
$req->setCat("16,18");
$req->setQ("女装");
$req->setMaterialId("2836");
$req->setHasCoupon("false");
$req->setIp("13.2.33.4");
$req->setAdzoneId("12345678");
$req->setNeedFreeShipment("true");
$req->setNeedPrepay("true");
$req->setIncludePayRate30("true");
$req->setIncludeGoodRate("true");
$req->setIncludeRfdRate("true");
$req->setNpxLevel("2");
$req->setEndKaTkRate("1234");
$req->setStartKaTkRate("1234");
$req->setDeviceEncrypt("MD5");
$req->setDeviceValue("xxx");
$req->setDeviceType("IMEI");
$req->setLockRateEndTime("1567440000000");
$req->setLockRateStartTime("1567440000000");
$req->setLongitude("121.473701");
$req->setLatitude("31.230370");
$req->setCityCode("310000");
$req->setSellerIds("1,2,3,4");
$req->setSpecialId("2323");
$req->setRelationId("3243");
$req->setPageResultKey("abcdef");
$req->setUcrowdId("1");
$ucrowd_rank_items = new Ucrowdrankitems;
$ucrowd_rank_items->commirate="1234";
$ucrowd_rank_items->price="10.12";
$ucrowd_rank_items->item_id="542808901898";
$req->setUcrowdRankItems(json_encode($ucrowd_rank_items));
$req->setGetTopnRate("0");
$resp = $c->execute($req);ITopClient client = new DefaultTopClient(url, appkey, secret);
TbkDgMaterialOptionalRequest req = new TbkDgMaterialOptionalRequest();
req.StartDsr = 10L;
req.PageSize = 20L;
req.PageNo = 1L;
req.Platform = 1L;
req.EndTkRate = 1234L;
req.StartTkRate = 1234L;
req.EndPrice = 10L;
req.StartPrice = 10L;
req.IsOverseas = false;
req.IsTmall = false;
req.Sort = "tk_rate_des";
req.Itemloc = "杭州";
req.Cat = "16,18";
req.Q = "女装";
req.MaterialId = 2836L;
req.HasCoupon = false;
req.Ip = "13.2.33.4";
req.AdzoneId = 12345678L;
req.NeedFreeShipment = true;
req.NeedPrepay = true;
req.IncludePayRate30 = true;
req.IncludeGoodRate = true;
req.IncludeRfdRate = true;
req.NpxLevel = 2L;
req.EndKaTkRate = 1234L;
req.StartKaTkRate = 1234L;
req.DeviceEncrypt = "MD5";
req.DeviceValue = "xxx";
req.DeviceType = "IMEI";
req.LockRateEndTime = 1567440000000L;
req.LockRateStartTime = 1567440000000L;
req.Longitude = "121.473701";
req.Latitude = "31.230370";
req.CityCode = "310000";
req.SellerIds = "1,2,3,4";
req.SpecialId = "2323";
req.RelationId = "3243";
req.PageResultKey = "abcdef";
req.UcrowdId = 1L;
List<TbkDgMaterialOptionalRequest.UcrowdrankitemsDomain> list2 = new List<TbkDgMaterialOptionalRequest.UcrowdrankitemsDomain>();
TbkDgMaterialOptionalRequest.UcrowdrankitemsDomain obj3 = new TbkDgMaterialOptionalRequest.UcrowdrankitemsDomain();
list2.Add(obj3);
obj3.Commirate = 1234L;
obj3.Price = "10.12";
obj3.ItemId = "542808901898";
req.UcrowdRankItems_ = list2;
req.GetTopnRate = 0L;
TbkDgMaterialOptionalResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);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.tbk.dg.material.optional' \
-d 'partner_id=apidoc' \
-d 'sign=17BAB45A2B63E51A81C29053340A21B9' \
-d 'sign_method=hmac' \
-d 'timestamp=2021-08-03+10%3A39%3A36' \
-d 'v=2.0' \
-d 'adzone_id=12345678' \
-d 'cat=16%2C18' \
-d 'city_code=310000' \
-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_rate_30=true' \
-d 'include_rfd_rate=true' \
-d 'ip=13.2.33.4' \
-d 'is_overseas=false' \
-d 'is_tmall=false' \
-d 'itemloc=%E6%9D%AD%E5%B7%9E' \
-d 'latitude=31.230370' \
-d 'lock_rate_end_time=1567440000000' \
-d 'lock_rate_start_time=1567440000000' \
-d 'longitude=121.473701' \
-d 'material_id=2836' \
-d 'need_free_shipment=true' \
-d 'need_prepay=true' \
-d 'npx_level=2' \
-d 'page_no=1' \
-d 'page_result_key=abcdef' \
-d 'page_size=20' \
-d 'platform=1' \
-d 'q=%E5%A5%B3%E8%A3%85' \
-d 'relation_id=3243' \
-d 'seller_ids=1%2C2%2C3%2C4' \
-d 'sort=tk_rate_des' \
-d 'special_id=2323' \
-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'# -*- coding: utf-8 -*-
import top.api
req=top.api.TbkDgMaterialOptionalRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))
req.start_dsr=10
req.page_size=20
req.page_no=1
req.platform=1
req.end_tk_rate=1234
req.start_tk_rate=1234
req.end_price=10
req.start_price=10
req.is_overseas=false
req.is_tmall=false
req.sort="tk_rate_des"
req.itemloc="杭州"
req.cat="16,18"
req.q="女装"
req.material_id=2836
req.has_coupon=false
req.ip="13.2.33.4"
req.adzone_id=12345678
req.need_free_shipment=true
req.need_prepay=true
req.include_pay_rate_30=true
req.include_good_rate=true
req.include_rfd_rate=true
req.npx_level=2
req.end_ka_tk_rate=1234
req.start_ka_tk_rate=1234
req.device_encrypt="MD5"
req.device_value="xxx"
req.device_type="IMEI"
req.lock_rate_end_time=1567440000000
req.lock_rate_start_time=1567440000000
req.longitude="121.473701"
req.latitude="31.230370"
req.city_code="310000"
req.seller_ids="1,2,3,4"
req.special_id="2323"
req.relation_id="3243"
req.page_result_key="abcdef"
req.ucrowd_id=1
req.ucrowd_rank_items=""
req.get_topn_rate=0
try:
resp= req.getResponse()
print(resp)
except Exception,e:
print(e)
TopClient = require('./topClient').TopClient;
var client = new TopClient({
'appkey': 'appkey',
'appsecret': 'secret',
'REST_URL': 'http://gw.api.taobao.com/router/rest'
});
client.execute('taobao.tbk.dg.material.optional', {
'start_dsr':'10',
'page_size':'20',
'page_no':'1',
'platform':'1',
'end_tk_rate':'1234',
'start_tk_rate':'1234',
'end_price':'10',
'start_price':'10',
'is_overseas':'false',
'is_tmall':'false',
'sort':'tk_rate_des',
'itemloc':'杭州',
'cat':'16,18',
'q':'女装',
'material_id':'2836',
'has_coupon':'false',
'ip':'13.2.33.4',
'adzone_id':'12345678',
'need_free_shipment':'true',
'need_prepay':'true',
'include_pay_rate_30':'true',
'include_good_rate':'true',
'include_rfd_rate':'true',
'npx_level':'2',
'end_ka_tk_rate':'1234',
'start_ka_tk_rate':'1234',
'device_encrypt':'MD5',
'device_value':'xxx',
'device_type':'IMEI',
'lock_rate_end_time':'1567440000000',
'lock_rate_start_time':'1567440000000',
'longitude':'121.473701',
'latitude':'31.230370',
'city_code':'310000',
'seller_ids':'1,2,3,4',
'special_id':'2323',
'relation_id':'3243',
'page_result_key':'abcdef',
'ucrowd_id':'1',
'ucrowd_rank_items':'数据结构JSON示例',
'get_topn_rate':'0'
}, function(error, response) {
if (!error) console.log(response);
else console.log(error);
})
pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"taobao.tbk.dg.material.optional");
add_param(pRequest,"start_dsr","10");
add_param(pRequest,"page_size","20");
add_param(pRequest,"page_no","1");
add_param(pRequest,"platform","1");
add_param(pRequest,"end_tk_rate","1234");
add_param(pRequest,"start_tk_rate","1234");
add_param(pRequest,"end_price","10");
add_param(pRequest,"start_price","10");
add_param(pRequest,"is_overseas","false");
add_param(pRequest,"is_tmall","false");
add_param(pRequest,"sort","tk_rate_des");
add_param(pRequest,"itemloc","杭州");
add_param(pRequest,"cat","16,18");
add_param(pRequest,"q","女装");
add_param(pRequest,"material_id","2836");
add_param(pRequest,"has_coupon","false");
add_param(pRequest,"ip","13.2.33.4");
add_param(pRequest,"adzone_id","12345678");
add_param(pRequest,"need_free_shipment","true");
add_param(pRequest,"need_prepay","true");
add_param(pRequest,"include_pay_rate_30","true");
add_param(pRequest,"include_good_rate","true");
add_param(pRequest,"include_rfd_rate","true");
add_param(pRequest,"npx_level","2");
add_param(pRequest,"end_ka_tk_rate","1234");
add_param(pRequest,"start_ka_tk_rate","1234");
add_param(pRequest,"device_encrypt","MD5");
add_param(pRequest,"device_value","xxx");
add_param(pRequest,"device_type","IMEI");
add_param(pRequest,"lock_rate_end_time","1567440000000");
add_param(pRequest,"lock_rate_start_time","1567440000000");
add_param(pRequest,"longitude","121.473701");
add_param(pRequest,"latitude","31.230370");
add_param(pRequest,"city_code","310000");
add_param(pRequest,"seller_ids","1,2,3,4");
add_param(pRequest,"special_id","2323");
add_param(pRequest,"relation_id","3243");
add_param(pRequest,"page_result_key","abcdef");
add_param(pRequest,"ucrowd_id","1");
add_param(pRequest,"ucrowd_rank_items","数据结构JSON示例");
add_param(pRequest,"get_topn_rate","0");
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);
响应示例
XML
JSON
<tbk_dg_material_optional_response>
<total_results>1212</total_results>
<result_list>
<map_data>
<coupon_start_time>2017-10-29</coupon_start_time>
<coupon_end_time>2017-10-29</coupon_end_time>
<info_dxjh>{"19013551":"2850","74510538":"2550"}</info_dxjh>
<tk_total_sales>11</tk_total_sales>
<tk_total_commi>323</tk_total_commi>
<coupon_id>d62db1ab8d9546b1bf0ff49bda5fc33b</coupon_id>
<num_iid>556633720749</num_iid>
<title>毛呢阔腿裤港味复古女裤子秋冬九分裤萝卜裤显瘦高腰韩版2017新款</title>
<pict_url>https://img.alicdn.com/bao/uploaded/i4/745957850/TB1WzSRmV9gSKJjSspbXXbeNXXa_!!0-item_pic.jpg</pict_url>
<small_images>
<string>https://img.alicdn.com/i4/3077291146/TB2NA3poDnI8KJjSszgXXc8ApXa_!!3077291146.jpg</string>
</small_images>
<reserve_price>102.00</reserve_price>
<zk_final_price>88.00</zk_final_price>
<user_type>1</user_type>
<provcity>杭州</provcity>
<item_url>https://item.taobao.com/item.htm?id=564591813536</item_url>
<include_mkt>false</include_mkt>
<include_dxjh>false</include_dxjh>
<commission_rate>1550表示15.5%</commission_rate>
<volume>123</volume>
<seller_id>232332</seller_id>
<coupon_total_count>22323</coupon_total_count>
<coupon_remain_count>111</coupon_remain_count>
<coupon_info>满299元减20元</coupon_info>
<commission_type>MKT表示营销计划，SP表示定向计划，COMMON表示通用计划</commission_type>
<shop_title>xx旗舰店</shop_title>
<shop_dsr>13</shop_dsr>
<coupon_share_url>uland.xxx</coupon_share_url>
<url>s.click.xxx</url>
<level_one_category_name>女装</level_one_category_name>
<level_one_category_id>20</level_one_category_id>
<category_name>连衣裙</category_name>
<category_id>162201</category_id>
<short_title>xxsd</short_title>
<white_image>https://img.alicdn.com/bao/uploaded/i4/745957850/TB1WzSRmV9gSKJjSspbXXbeNXXa_!!0-item_pic.jpg</white_image>
<oetime>2018-08-21 11:23:43</oetime>
<ostime>2018-08-21 11:23:43</ostime>
<jdd_num>10</jdd_num>
<jdd_price>5</jdd_price>
<uv_sum_pre_sale>23</uv_sum_pre_sale>
<x_id>uESS0mv8JvfJRMKlIgCD5At9VuHVBXoqBRihfQlo4ybLiKygRlqiN4eoxoZDfe38uSogWy6GB971jD2N8tLuuc</x_id>
<coupon_start_fee>29.00</coupon_start_fee>
<coupon_amount>10.00</coupon_amount>
<item_description>季凉被 全棉亲肤</item_description>
<nick>旗舰店</nick>
<orig_price>25</orig_price>
<total_stock>5555</total_stock>
<sell_num>1111</sell_num>
<stock>4444</stock>
<tmall_play_activity_info>前n件x折</tmall_play_activity_info>
<item_id>5678899993</item_id>
<real_post_fee>0.00</real_post_fee>
<lock_rate>1567440000000</lock_rate>
<lock_rate_end_time>1567440000000</lock_rate_end_time>
<lock_rate_start_time>1567440000000</lock_rate_start_time>
<presale_discount_fee_text>付定金立减5元</presale_discount_fee_text>
<presale_tail_end_time>1567440000000</presale_tail_end_time>
<presale_tail_start_time>1567440000000</presale_tail_start_time>
<presale_end_time>1567440000000</presale_end_time>
<presale_start_time>1567440000000</presale_start_time>
<presale_deposit>100</presale_deposit>
<ysyl_tlj_send_time>2019-11-10 21:59:59</ysyl_tlj_send_time>
<ysyl_commission_rate>2030（表示20.3%）</ysyl_commission_rate>
<ysyl_tlj_face>0.6</ysyl_tlj_face>
<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</ysyl_click_url>
<ysyl_tlj_use_end_time>2019-11-10 21:59:59</ysyl_tlj_use_end_time>
<ysyl_tlj_use_start_time>2019-11-10 21:59:59</ysyl_tlj_use_start_time>
<sale_begin_time>1567440000000</sale_begin_time>
<sale_end_time>1567440000000</sale_end_time>
<distance>300</distance>
<usable_shop_id>10001</usable_shop_id>
<usable_shop_name>饿了么卡券专营店</usable_shop_name>
<sale_price>168</sale_price>
<kuadian_promotion_info>["每100减20","每200减50"]</kuadian_promotion_info>
<superior_brand>1</superior_brand>
<reward_info>1</reward_info>
<is_brand_flash_sale>1</is_brand_flash_sale>
<localization_extend>
<order_lead_time>45</order_lead_time>
<user_rating>4.8</user_rating>
<delivery_min_price>20</delivery_min_price>
<delivery_fee>1</delivery_fee>
<original_delivery_fee>3</original_delivery_fee>
<delivery_type>1</delivery_type>
<recommend_reasons>
<string>["酱油无骨炸鸡性价比很高"</string>
<string>"韩国炸鸡中的热卖餐厅"]</string>
</recommend_reasons>
<sale_tags>
<string>["15减10"</string>
<string>"吃货联盟"</string>
<string>"首次光顾减1"]</string>
</sale_tags>
<food_item_list>
<food_map_data>
<food_pic>https://cube.elemecdn.com/f/7d/7e6f36533e279518460043f81a9c4jpeg.jpeg</food_pic>
<food_title>单人超巨1+1+1+1自选套餐</food_title>
<food_promotion_price>39.88</food_promotion_price>
<food_reserve_price>76.8</food_reserve_price>
</food_map_data>
</food_item_list>
</localization_extend>
<match_score>10.0</match_score>
<commi_score>20.0</commi_score>
<hot_flag>1</hot_flag>
<topn_info>
<topn_quantity>3000</topn_quantity>
<topn_total_count>3000</topn_total_count>
<topn_end_time>1937297392332</topn_end_time>
<topn_start_time>1937297392332</topn_start_time>
<topn_rate>30</topn_rate>
</topn_info>
<bybt_info>
<bybt_brand_logo>//img.alicdn.com/bao/uploaded/i4/745957850/TB1WzSRmV9gSKJjSspbXXbeNXXa_!!0-item_pic.jpg</bybt_brand_logo>
<bybt_pic_url>//img.alicdn.com/bao/uploaded/i4/745957850/TB1WzSRmV9gSKJjSspbXXbeNXXa_!!0-item_pic.jpg</bybt_pic_url>
<bybt_item_tags>
<string>["https://gw.alicdn.com/tfs/TB1CvN50KH2gK0jSZJnXXaT1FXa-167-42.png?getAvatar=avatar"</string>
<string>"https://gw.alicdn.com/tfs/TB10rZqkCR26e4jSZFEXXbwuXXa-132-42.png?getAvatar=avatar"]</string>
</bybt_item_tags>
<bybt_coupon_amount>10.00</bybt_coupon_amount>
<bybt_show_price>100.00</bybt_show_price>
<bybt_lowest_price>200.00</bybt_lowest_price>
<bybt_end_time>1559750399000</bybt_end_time>
<bybt_start_time>1559750399000</bybt_start_time>
</bybt_info>
</map_data>
</result_list>
<page_result_key>abcde</page_result_key>
</tbk_dg_material_optional_response>{
"tbk_dg_material_optional_response":{
"total_results":1212,
"result_list":{
"map_data":[
{
"coupon_start_time":"2017-10-29",
"coupon_end_time":"2017-10-29",
"info_dxjh":"{\"19013551\":\"2850\",\"74510538\":\"2550\"}",
"tk_total_sales":"11",
"tk_total_commi":"323",
"coupon_id":"d62db1ab8d9546b1bf0ff49bda5fc33b",
"num_iid":556633720749,
"title":"毛呢阔腿裤港味复古女裤子秋冬九分裤萝卜裤显瘦高腰韩版2017新款",
"pict_url":"https:\/\/img.alicdn.com\/bao\/uploaded\/i4\/745957850\/TB1WzSRmV9gSKJjSspbXXbeNXXa_!!0-item_pic.jpg",
"small_images":{
"string":[
"https:\/\/img.alicdn.com\/i4\/3077291146\/TB2NA3poDnI8KJjSszgXXc8ApXa_!!3077291146.jpg"
]
},
"reserve_price":"102.00",
"zk_final_price":"88.00",
"user_type":1,
"provcity":"杭州",
"item_url":"https:\/\/item.taobao.com\/item.htm?id=564591813536",
"include_mkt":"false",
"include_dxjh":"false",
"commission_rate":"1550表示15.5%",
"volume":123,
"seller_id":232332,
"coupon_total_count":22323,
"coupon_remain_count":111,
"coupon_info":"满299元减20元",
"commission_type":"MKT表示营销计划，SP表示定向计划，COMMON表示通用计划",
"shop_title":"xx旗舰店",
"shop_dsr":13,
"coupon_share_url":"uland.xxx",
"url":"s.click.xxx",
"level_one_category_name":"女装",
"level_one_category_id":20,
"category_name":"连衣裙",
"category_id":162201,
"short_title":"xxsd",
"white_image":"https:\/\/img.alicdn.com\/bao\/uploaded\/i4\/745957850\/TB1WzSRmV9gSKJjSspbXXbeNXXa_!!0-item_pic.jpg",
"oetime":"2018-08-21 11:23:43",
"ostime":"2018-08-21 11:23:43",
"jdd_num":10,
"jdd_price":"5",
"uv_sum_pre_sale":23,
"x_id":"uESS0mv8JvfJRMKlIgCD5At9VuHVBXoqBRihfQlo4ybLiKygRlqiN4eoxoZDfe38uSogWy6GB971jD2N8tLuuc",
"coupon_start_fee":"29.00",
"coupon_amount":"10.00",
"item_description":"季凉被 全棉亲肤",
"nick":"旗舰店",
"orig_price":"25",
"total_stock":5555,
"sell_num":1111,
"stock":4444,
"tmall_play_activity_info":"前n件x折",
"item_id":5678899993,
"real_post_fee":"0.00",
"lock_rate":"1567440000000",
"lock_rate_end_time":1567440000000,
"lock_rate_start_time":1567440000000,
"presale_discount_fee_text":"付定金立减5元",
"presale_tail_end_time":1567440000000,
"presale_tail_start_time":1567440000000,
"presale_end_time":1567440000000,
"presale_start_time":1567440000000,
"presale_deposit":"100",
"ysyl_tlj_send_time":"2019-11-10 21:59:59",
"ysyl_commission_rate":"2030（表示20.3%）",
"ysyl_tlj_face":"0.6",
"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",
"ysyl_tlj_use_end_time":"2019-11-10 21:59:59",
"ysyl_tlj_use_start_time":"2019-11-10 21:59:59",
"sale_begin_time":"1567440000000",
"sale_end_time":"1567440000000",
"distance":"300",
"usable_shop_id":"10001",
"usable_shop_name":"饿了么卡券专营店",
"sale_price":"168",
"kuadian_promotion_info":"[\"每100减20\",\"每200减50\"]",
"superior_brand":"1",
"reward_info":1,
"is_brand_flash_sale":"1",
"localization_extend":{
"order_lead_time":"45",
"user_rating":"4.8",
"delivery_min_price":"20",
"delivery_fee":"1",
"original_delivery_fee":"3",
"delivery_type":"1",
"recommend_reasons":{
"string":[
"[\"酱油无骨炸鸡性价比很高\"",
"\"韩国炸鸡中的热卖餐厅\"]"
]
},
"sale_tags":{
"string":[
"[\"15减10\"",
"\"吃货联盟\"",
"\"首次光顾减1\"]"
]
},
"food_item_list":{
"food_map_data":[
{
"food_pic":"https:\/\/cube.elemecdn.com\/f\/7d\/7e6f36533e279518460043f81a9c4jpeg.jpeg",
"food_title":"单人超巨1+1+1+1自选套餐",
"food_promotion_price":"39.88",
"food_reserve_price":"76.8"
}
]
}
},
"match_score":"10.0",
"commi_score":"20.0",
"hot_flag":"1",
"topn_info":{
"topn_quantity":3000,
"topn_total_count":3000,
"topn_end_time":"1937297392332",
"topn_start_time":"1937297392332",
"topn_rate":"30"
},
"bybt_info":{
"bybt_brand_logo":"\/\/img.alicdn.com\/bao\/uploaded\/i4\/745957850\/TB1WzSRmV9gSKJjSspbXXbeNXXa_!!0-item_pic.jpg",
"bybt_pic_url":"\/\/img.alicdn.com\/bao\/uploaded\/i4\/745957850\/TB1WzSRmV9gSKJjSspbXXbeNXXa_!!0-item_pic.jpg",
"bybt_item_tags":{
"string":[
"[\"https:\/\/gw.alicdn.com\/tfs\/TB1CvN50KH2gK0jSZJnXXaT1FXa-167-42.png?getAvatar=avatar\"",
"\"https:\/\/gw.alicdn.com\/tfs\/TB10rZqkCR26e4jSZFEXXbwuXXa-132-42.png?getAvatar=avatar\"]"
]
},
"bybt_coupon_amount":"10.00",
"bybt_show_price":"100.00",
"bybt_lowest_price":"200.00",
"bybt_end_time":"1559750399000",
"bybt_start_time":"1559750399000"
}
}
]
},
"page_result_key":"abcde"
}
}异常示例
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"
}
}错误码解释
错误码
错误消息
解决方案
4
查询不到对应的adzoneId
请检查adzoneId是否正确
30002
参数q与cat都为空值
参数q与cat不能都为空，至少一个参数有值
2
pid不正确
请检查是否输入了正确的adzoneId和siteId
50001
无结果
宝贝数据为空，请重新查询
30001
无效物料ID
请传入有效的物料ID
isp.entry-sys-error
内部服务出错
稍后重试
isp.pid-check-error
pid校验服务出错
检查pid相关参数，稍后重试
isp.sys-error
内部服务异常
稍后重试
50002
调用频率高，请稍后再试
调用频率高，请稍后再试
1201
口令类型无效
请重试
70001
17002
17003
1302
isv.invalid-argument
API 工具
如何获得此API
拥有此API的权限组
可获得/可申请此API权限组的应用类型
淘宝客【推广者】物料搜索
联盟通用应用 联盟合作网站
文档有帮助吗？
原网址: 访问
创建于: 2021-08-03 10:41:06
目录: default
标签: 无
未标明原创文章均为采集，版权归作者所有，转载无需和我联系，请注明原出处，南摩阿彌陀佛，知识，不只知道，要得到
最新评论