接口使用场景等说明:本接口是2023年最新升级版搜索接口,可以精准获取商品最后到手价,为您的APP直接显示和淘宝同步价格提供一步到位的信息。
同时本接口还可以显示商品到手价、促销信息、百亿补贴、跨店满减、店铺券。并显示“88VIP”、“花呗免息”、“猫超买返”等信息。
如果商品是定向计划,还可以显示定向计划申请链接。
【FAQ】
淘客搜索升级版如何判断旧版接口的单品优惠券?
答:在返回值 final_promotion_path_map_data下匹配优惠券,匹配 promotion_id 为32位数字字母的商品券就是之前的单品券。如图:
环境 | http 地址 | https 地址 |
---|---|---|
正式环境 | http://api.veapi.cn/tbk/tb_search_update | 暂无 |
参数名称 | 参数类型 | 必填 | 示例值 | 描述 |
---|---|---|---|---|
vekey | String | 是 | V123M56 | 公共参数,接口秘钥,请在会员中心获取 |
pid | String | 否 | mm_11_22_33 | 您的PID,可以在会员中心授权时设置默认值 |
relation_id | Number | 否 | 12313232 | 渠道关系ID,仅适用于渠道推广场景 |
special_id | Number | 否 | 56652123 | 会员运营ID |
para | String | 否 | 23883488910 | 主参数,可以是产品ID或关键字等,para和item_id和cat不能同时为空。 |
item_id | String | 否 | 23883488910 | 如果您直接查询指定商品ID,那么可以直接使用“item_id=商品ID”,比“para=商品ID”传参方式更直接。 |
cat | Number | 否 | 商品分类ID。搜索该类别的淘客商品。cat和para参数不可同时为空。 | |
start_dsr | Number | 否 | 商品筛选-店铺dsr评分。筛选大于等于当前设置的店铺dsr评分的商品0-50000之间 | |
page | Number | 否 | 1 | 页码 |
pagesize | Number | 否 | 20 | 每页大小 |
start_tk_rate | Number | 否 | 12345 | 商品筛选-淘客佣金比率下限。注意是千位表示法,如:1234表示12.34% |
end_tk_rate | Number | 否 | 12345 | 商品筛选-淘客佣金比率上限。如:1234表示12.34% |
start_price | Number | 否 | 23 | 商品筛选-折扣价范围下限。可和end_price配合使用,单位:元 |
end_price | Number | 否 | 31 | 商品筛选-折扣价范围上限。可和start_price配合使用,单位:元 |
is_overseas | Number | 否 | 默认为0 | 是否海外商品,可选值1 指定为海外产品。 |
is_tmall | Number | 否 | 默认0 | 是否商城商品,设为1表示商品是天猫商城商品,不设置或0表示不限制。 |
sort | String | 否 | tk_rate_des | 排序,_des(降序),排序_asc(升序),销量(total_sales),淘客收入比率(tk_rate), 累计推广量(tk_total_sales),总支出佣金(tk_total_commi),价格(price),匹配分(match),支持按照营销佣金(tk_mkt_rate)降序(_des)排序,即入参tk_mkt_rate_des。注意区分:总支出佣金(tk_total_commi)为按通用计划佣金排序。 |
itemloc | String | 否 | 商品筛选-所在地 | |
material_id | Number | 否 | 5612 | 指定物料ID。不传时默认物料material_id=80309;如果直接对消费者投放,可使用官方个性化算法优化的搜索物料material_id=17004(注意:若物料id=17004没查询到结果则出系统默认物料id=80309的查询结果),点这看更多新物料ID |
has_coupon | Number | 否 | 默认0 | 优惠券筛选-是否有优惠券。true表示该商品有优惠券,false或不设置表示不限。 |
virtual | Number | 否 | 默认0 | 可选值0,1,指定是否过滤或检测虚拟类产品,苹果APP或微信小程序上架时需要用到,可临时开启,参数值:默认0表示不检查虚拟类商品,1表示检测并拒绝虚拟类商品搜索(此时接口error为91) |
ip | String | 否 | 12.71.3.2 | 当需要限制包邮时,最好传递顾客的IP参数,比如ip=122.71.37.32 ,最好和freeship一起使用。 |
npx_level | Number | 否 | 2 | 商品筛选-牛皮癣程度。取值:1不限,2无,3轻微 |
include_rfd_rate | Number | 否 | 1 | 可选0或1,商品筛选-退款率是否低于行业均值。1表示大于等于,0或不设置表示不限 |
include_good_rate | Number | 否 | 1 | 可选0或1,商品筛选-好评率是否高于行业均值。1表示大于等于,0或不设置表示不限 |
include_pay_rate_30 | Number | 否 | 1 | 可选0或1,商品筛选-成交转化是否高于行业均值。1表示大于等于,0或不设置表示不限 |
need_prepay | Number | 否 | 1 | 参数值1或0,商品筛选-是否加入消费者保障。1表示加入,0或不设置表示不限 |
need_free_shipment | Number | 否 | 1 | 参数值1或0,商品筛选-是否包邮。1表示包邮,0或不设置表示不限 |
device_value | String | 否 | 智能匹配-设备号加密后的值(MD5加密需32位小写);使用智能推荐请先签署协议https://pub.alimama.com/fourth/protocol/common.htm?key=hangye_laxin | |
device_encrypt | String | 否 | 智能匹配-设备号加密类型:MD5;使用智能推荐请先签署协议https://pub.alimama.com/fourth/protocol/common.htm?key=hangye_laxin | |
device_type | String | 否 | 智能匹配-设备号类型:IMEI,或者IDFA,或者UTDID(UTDID不支持MD5加密),或者OAID;使用智能推荐请先签署协议https://pub.alimama.com/fourth/protocol/common.htm?key=hangye_laxin | |
get_topn_rate | Number | 否 | 0 | 是否获取前N件佣金信息,0否,1是,其他值否 |
mgc_start_time | String | 否 | 1695281620000 | 线报内容筛选—内容生产开始时间,13毫秒时间戳 |
mgc_end_time | String | 否 | 1695281620000 | 线报内容筛选—内容生产截止时间,13毫秒时间戳 |
mgc_status | String | 否 | 0 | 线报状态筛选,0-全部 1-过期 2-实时生效 3-未来生效 不传默认过滤有效 |
sessionkey | String | 否 | 7002 | 多用户专用。如果您的会员卡是多用户版订单查询接口,若要查不同的帐号,请提供该帐号授权的sessionkey值 |
account_id | String | 否 | 联盟号id | 会员中心有多个授权时,用本参数指定要查询哪一个联盟号id,联盟号ID请到会员中心授权页查看。 |
GET/POST http://api.veapi.cn/tbk/tb_search_update?vekey=xxx¶=手机【例子】例子1:搜索指定商品
https://api.veapi.cn/tbk/tb_search_update?vekey=xxx¶=Kqzd6W0I3toMk6p6VRIz6GSJtW-g8Da92sp0ny2aqpUX【例子】例子2:搜索指定商品(同上)
https://api.veapi.cn/tbk/tb_search_update?vekey=xxx&item_id=Kqzd6W0I3toMk6p6VRIz6GSJtW-g8Da92sp0ny2aqpUX【例子】例子2:搜索分类
http://api.veapi.cn/tbk/tb_search_update?vekey=xxx&cat=201536602
$api="http://api.veapi.cn/tbk/tb_search_update?vekey=xxx¶=手机"; $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, $api); //curl_setopt($ch, CURLOPT_POST, true); //POST方式时启用 //curl_setopt($ch, CURLOPT_POSTFIELDS, $postData ); //POST方式时传参 curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); //如果使用https请启用 curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false); //如果使用https请启用 curl_setopt($ch, CURLOPT_RETURNTRANSFER, true ); //返回数据流,不直接输出 curl_setopt($ch, CURLOPT_ENCODING, 'gzip'); //使用gzip压缩传输让访问更快 curl_setopt($ch, CURLOPT_TIMEOUT, 6); //允许执行的最长秒数。这里设定6S curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5); $result = curl_exec($ch); $info = curl_getinfo($ch); curl_close($ch); echo $result; //返回值
import cn.hutool.http.HttpResponse; import cn.hutool.http.HttpRequest; public class testGetParam { public static void main(String[] args) { // API网址 String url = "http://api.veapi.cn/tbk/tb_search_update?vekey=xxx¶=手机"; // JDK 8u111版本后,若目标页面为HTTPS协议,请启用proxy用户密码鉴权 //System.setProperty("jdk.http.auth.tunneling.disabledSchemes", ""); // 发送请求 String result = HttpRequest.get(url) .timeout(10000)//设置超时,毫秒 .execute().body(); System.out.println(result); } }
import requests # 要访问的API网页 target_url = "http://api.veapi.cn/tbk/tb_search_update?vekey=xxx¶=手机" # 发送请求 response = requests.get(target_url) # 获取页面内容 if response.status_code == 200: print response.text
参数名称 | 参数类型 | 示例值 | 描述 |
---|---|---|---|
total_results | Number | 1212 | 搜索到符合条件的结果总数 |
search_type | Number | 10 | 对接口入参搜索类型描述:10表示搜索淘口令或链接中的指定商品,30表示搜索关键字 |
item_id | String | AAA-BBB | 商品信息-淘宝客新商品id; |
price_promotion_info | Promotioninfomapdata | 价格促销信息 | |
└─ final_promotion_path_list | Object[] | 到手价优惠路径列表 | |
└─ promotion_title | String | 商品券 | 优惠名称,如“商品券”、“店铺券”(满XX元减Y)、“跨店满减”、“单品直降”、“官方立减”(官方立减x.xx元)等 |
└─ promotion_desc | String | 满7999减1300 | 优惠利益点文案,如“1件7.92折”、“每200减20”等 |
└─ promotion_fee | String | 1300.00 | 优惠金额(元) |
└─ promotion_start_time | String | 2019-11-10 21:59:59 | 优惠开始时间 |
└─ promotion_end_time | String | 2019-11-10 21:59:59 | 优惠结束时间 |
└─ promotion_id | String | xx | 优惠ID |
└─ predict_rounding_up_price | String | 56.1 | 促销信息-预估凑单价(元)。预估凑单叠加优惠后的商品单价 |
└─ predict_rounding_up_price_desc | String | 需买1件 | 促销信息-凑单价说明,描述凑单价的实现说明。如 “可凑单”或“需买X件” |
└─ more_promotion_list | Object[] | 更多活动优惠 | |
└─ promotion_title | String | 满件折 | 预热优惠名称,如“商品券”、“跨店满减”、“单品直降”、“淘金币”(淘金币可抵3%)等 |
└─ promotion_desc | String | 2件9折 | 预热优惠利益点文案,如“1件7.92折”、“每200减20”等 |
└─ promotion_start_time | String | 1661222400000 | 优惠开始时间 |
└─ promotion_end_time | String | 1662393600000 | 优惠结束时间 |
└─ reserve_price | String | 102.00 | 商品信息-一口价通常显示为划线价 |
└─ zk_final_price | String | 79.9 | 促销信息-销售价格,无促销时等于一口价,有促销时为促销价。若属于预售商品,付定金时间内,在线售卖价=预售价 |
└─ final_promotion_price | String | 69.9 | 促销信息-预估到手价(元)。若属于预售商品,付定金时间内,预估到手价价=定金+尾款的预估到手价 |
└─ future_activity_promotion_price | String | 99.5 | 预热预估到手价(元) |
└─ future_activity_promotion_path_list | Object[] | 预热到手价优惠路径列表 | |
└─ promotion_title | String | 商品券 | 预热优惠名称,如“商品券”、“跨店满减”、“单品直降”等 |
└─ promotion_desc | String | 满7999减1300 | 预热优惠利益点文案,如“1件7.92折”、“每200减20”等 |
└─ promotion_fee | String | 1300 | 预热实际优惠金额(元) |
└─ promotion_start_time | String | 1661184000000 | 优惠开始时间 |
└─ promotion_end_time | String | 1661788799000 | 优惠结束时间 |
└─ promotion_tag_list | Object[] | 标签信息列表 | |
└─ tag_name | String | 88VIP | 标签名称,如“88VIP”、“花呗免息”、“猫超买返” |
publish_info | Object | 淘客推广信息 | |
└─ income_rate | String | 5.50 | 商品信息-收入比率(%);商品佣金比率+补贴比率 |
└─ topn_info | Object[] | 前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件佣金率 |
└─ click_url | String | https://s.click.taobao.com/... | 链接-宝贝推广链接 |
└─ coupon_share_url | String | https://uland.taobao.com/coupon/edetail... | 链接-宝贝+券二合一页面链接 |
└─ cpa_reward_type | String | 0 1 2 | 额外奖励活动类型,如果一个商品有多个奖励类型,返回结果使用空格分割,0=预售单单奖励,1=618超级U选单单补 |
└─ cpa_reward_amount | String | 1.11 2.22 3.21 | 额外奖励活动金额,活动奖励金额的类型与cpa_reward_type字段对应,如果一个商品有多个奖励类型,返回结果使用空格分割 |
└─ future_activity_commission_rate | String | 1550表示15.5% | 预热活动到手价对应的佣金比率 |
└─ future_activity_time | String | 1665504000000 | 预热价活动开始时间 |
└─ sp_campaign_list | Object[] | 定向计划集合 | |
└─ sp_cid | String | 123 | 定向计划活动ID |
└─ sp_name | String | 定向计划活动1 | 定向计划名称 |
└─ sp_rate | String | 1550表示15.5% | 定向佣金率 |
└─ sp_lock_status | String | 0 | 定向是否锁佣,0=不锁佣 1=锁佣 |
└─ sp_apply_link | String | http://pub.alimama.com/por... | 定向计划申请链接 |
└─ sp_status | String | 1 | 定向计划是否可用 1-可用 0-不可用 |
└─ rank_page_url | String | s.clicl.xxx | 榜单url |
└─ commission_type | String | MKT表示营销计划,SP表示定向计划,COMMON表示通用计划 | 推广信息-商品信息-佣金类型。MKT表示营销计划,SP表示定向计划,COMMON表示通用计划 |
└─ income_info | Object | 商品佣金信息 | |
└─ commission_rate | String | 55 | 商品佣金比率 |
└─ commission_amount | String | 12 | 商品佣金金额 |
└─ subsidy_rate | String | 11 | 补贴比率 |
└─ subsidy_amount | String | 4 | 补贴金额 |
└─ subsidy_upper_limit | String | 10 | 补贴上限;仅在单笔订单命中补贴上限时返回结果否则出参为空 |
└─ subsidy_type | String | 三元三件 | 补贴类型,如:三元三件、品牌U享等,补贴类型随业务发展可能会有所调整。 |
item_basic_info | Object | 商品基础信息 | |
└─ title | String | 九分裤萝卜裤显瘦高腰 | 商品信息-商品标题 |
└─ short_title | String | 九分裤显瘦高腰韩版 | 商品信息-商品短标题 |
└─ pict_url | String | //img.alicdn.com/bao/uploaded/i4/745957850/TB1WzSRmV9gSKJjSspbXXbeNXXa_!!0-item_pic.jpg | 商品信息-商品主图 |
└─ white_image | String | https://img.alicdn.com/bao/uploaded/i4/745957850/TB1WzSRmV9gSKJjSspbXXbeNXXa_!!0-item_pic.jpg | 商品信息-商品白底图 |
└─ level_one_category_id | Number | 1 | 商品信息-一级类目ID |
└─ category_id | Number | 162201 | 商品信息-叶子类目id |
└─ category_name | String | 牛仔裤 | 商品信息-叶子类目名称 |
└─ seller_id | Number | 123 | 店铺信息-卖家id |
└─ user_type | Number | 1 | 店铺信息-卖家类型,0表示淘宝,1表示天猫,3表示特价版 |
└─ shop_title | String | 魔黛娅内衣旗舰店 | 店铺信息-店铺名称 |
└─ volume | Number | 30 | 本字段已失效,值总是0,请使用annual_vol字段。商品信息-30天销量;数据统计截止昨日非实时更新 |
└─ annual_vol | Number | 30 | 年销量,不是实时变化。是T+1更新过去365天的数据,显示规则:0,展示“0” (0,100],展示精确值 (100,1000],每层100递增,如展示100+、200+、900+ (1000,10000],每层1000递增,如展示1000+、2000+、9000+ (10000,100000],每层1w递增,如展示1万+、2万+、9万+ (100000,1000000],每层10万递增,如展示10万+、20万+、90万+ (1000000,~),展示“100万+” |
└─ sub_title | String | 吉品鲍鱼 | 商品信息-商品子标题 |
└─ brand_name | String | 淘宝心选 | 商品信息-品牌名称 |
└─ level_one_category_name | String | 美妆 | 商品信息-一级类目名称 |
└─ real_post_fee | String | 0.00 | 商品邮费。配合请求参数“ip”字段入参具体ip,根据邮费(real_post_fee)实际返回情况判定是否该地区包邮 |
tmall_rank_info | Object | 天猫榜单信息 | |
└─ tmall_rank_text | String | 白茶热销榜·第5名 | 榜单排行描述 |
└─ tmall_rank_url | String | https://pages.tmall.com/wow/a/act/tmall/dailygroup/16220/16661/wupr?wh_pid=daily-459438&disableNav=YES | 榜单url |
presale_info | Object | 预售信息 | |
└─ presale_start_time | Number | 1567440000000 | 预售商品-付定金开始时间(毫秒) |
└─ presale_end_time | Number | 1567440000000 | 预售商品-付定金结束时间(毫秒) |
└─ presale_tail_start_time | Number | 1567440000000 | 预售商品-付尾款开始时间(毫秒) |
└─ presale_tail_end_time | Number | 1567440000000 | 预售商品-付尾款结束时间(毫秒) |
└─ presale_deposit | String | 100 | 预售商品-定金(元) |
└─ presale_discount_fee_text | String | 付定金立减5元 | 预售商品-优惠信息 |
scope_info | Object | 商品库范围信息 | |
└─ superior_brand | Number | 1 | 是否品牌精选,0不是,1是 |
mgc_info | Object | 线报内容 | |
└─ price | String | 0.66 | 价格 |
└─ price_desc | String | xxx | 价格描述 |
└─ promotion_summary | String | xxx | 文案 |
└─ publish_time | String | 1695265124771 | 发布时间,13位毫秒时间戳 |
└─ valid_time | String | 0 | 生效时间,实时线报为0,未来线报为13位毫秒时间戳 |
uvid_msg | String | 123 | uvid结果信息,传入但未使用uvid时会返回原因 |
include_dxjh | String | false | 商品是否包含定向计划 |
{ "error": "0", "msg": "升级版搜索查询成功!", "search_type": 10, "total_results": "1", "result_list": [ { "isv_mktid": "MPb96oVtKt9m60ATXz3iQtA-P7gx3ysnxnayXytGb", "item_basic_info": { "brand_name": "A&B", "category_id": "50006846", "category_name": "中筒袜", "level_one_category_id": "1625", "level_one_category_name": "女士内衣/男士内衣/家居服", "pict_url": "https://img.alicdn.com/bao/uploaded/i1/416097139/O1CN01XeUrhe22biDuhdvpl_!!0-item_pic.jpg", "provcity": "江苏 苏州", "seller_id": "145383475141300409", "shop_title": "ab内衣旗舰店", "short_title": "ab女本命年红色中筒休闲情侣袜子", "small_images": { "string": [ "https://img.alicdn.com/i1/416097139/O1CN01NaeSDh22biDyy2QD6_!!416097139.jpg", "https://img.alicdn.com/i3/416097139/O1CN01BcvgAs22biE0QgeEY_!!416097139.jpg", "https://img.alicdn.com/i3/416097139/O1CN01os9E2d22biDxTDFaM_!!416097139.jpg", "https://img.alicdn.com/i3/416097139/O1CN01o3xV0h22biE32RGM5_!!416097139.jpg" ] }, "sub_title": "本命年大红色 吸湿透气", "title": "AB袜子女本命年红色女棉袜中筒休闲情侣袜子5641", "tk_total_sales": "10", "user_type": "1", "volume": "100", "white_image": "https://img.alicdn.com/bao/uploaded/O1CN01BoHSfF1HWsDUdbZpR_!!6000000000766-0-yinhe.jpg", "item_url": "https://uland.taobao.com/item/edetail?id=o2Q3x8qTrtKMKvem3ZU9JGsqUN-P7gx3ysnxnayXytGb" }, "item_id": "o2Q3x8qTrtKMKvem3ZU9JGsqUN-P7gx3ysnxnayXytGb", "presale_info": { "presale_deposit": "" }, "price_promotion_info": { "final_promotion_price": "12.5", "more_promotion_list": { "more_promotion_map_data": [ { "promotion_desc": "满99减3", "promotion_end_time": "1706716799000", "promotion_id": "32d191c4381349708069f4e76f2c0a41", "promotion_start_time": "1703692800000", "promotion_title": "店铺券" }, { "promotion_desc": "每200减30", "promotion_end_time": "1706716799000", "promotion_id": "76011336300-20000-3000", "promotion_start_time": "1705492800000", "promotion_title": "跨店满减" } ] }, "predict_rounding_up_price": "10.25", "predict_rounding_up_price_desc": "需凑单,需买8件", "promotion_tag_list": { "promotion_tag_map_data": { "tag_name": "每200减30" } }, "reserve_price": "28.00", "zk_final_price": "12.5" }, "publish_info": { "click_url": "https://s.click.taobao.com/t?e=m%3D2%26s%3DwGBSuR%2BQpihw4vFB6t2Z2ueEDrYVVa64r4ll3HtqqoxyINtkUhsv0Hi1tY2ds%2FDxLfB6JrS6PRQL60FsZM9I2TIgTwpFUxJ%2BJzdJ3rdo4hcyJwaoKcyDsvAy%2Fay3dFHhx7askdMTXKCBOqkBi7qzff8iS4YjqDYn7izrPeBozCERXp1uRE4Xd2hBEXzOD2UsMZLedKM%2FlhJLJiwFP%2BFrxUCkcO4K8QIeptCgZOITTGyV%2FZ5FBeKIoeei79hRDyfknBf80C6qOF8%3D&union_lens=lensId%3AMAPI%401706176205%40212bd081_12c2_18d4006d244_a9c6%4001%40eyJmbG9vcklkIjo4MDMwOX0ie", "commission_type": "MKT", "income_info": { "commission_amount": "0.57", "commission_rate": "453", "subsidy_amount": "0", "subsidy_rate": "0" }, "income_rate": "4.53" }, "scope_info": { "superior_brand": "0" } } ], "request_id": "rngZG1a" }