API文档中心

热门接口：产品ID找同款全量维权查询万能转链字符串ID转换 （有API需求可联系本站）

淘宝联盟超级搜索接口-淘客商品搜索、物料搜索、分类搜索

调用权限：核心接口会员卡调用
接口使用场景等说明：

淘宝联盟商品超级搜索开发文档，用法说明请参考搜索接口文档指引


【注意】本接口将停用，请使用升级版（到手价）https://www.veapi.cn/apidoc/taobaolianmeng/362 

调用说明

本接口需要您在会员中心授权（如果多用户可传入sessionkey参数）

接口请求地址

环境 http 地址 https 地址
正式环境 http://api.veapi.cn/tbk/tb_search 暂无

请求方式：GET 或 POST

请求参数

参数名称 参数类型 必填 示例值 描述
vekey String 是 V123M56 公共参数，接口秘钥，请在会员中心获取
para String 否 23883488910 主参数，可以是产品ID、淘宝链接、淘口令、链接等
item_id String 否 23883488910 如果您直接查询指定商品ID，那么可以直接使用“item_id=商品ID”，比“para=商品ID”传参方式更直接。
cat Number 否   商品分类ID。搜索该类别的淘客商品。cat和para参数不可同时为空。
page Number 否 1 页码
pagesize Number 否 20 每页大小
deepcoupon Number 否 默认0 可选值1：指是否要搜索商品的店铺券，值为1时搜索para指定的商品的店铺券
coupon Number 否 默认0 是否仅搜索有券商品，可选coupon=1时则搜索有券产品。
virtual Number 否 默认0 可选值0，1，2，指定是否过滤或检测虚拟类产品，苹果APP或微信小程序上架时需要用到，可临时开启，参数值：默认0表示不检查虚拟类商品，1表示检测并拒绝虚拟类商品搜索（此时接口error为91），2表示只检测不过滤，这时返回值中增加一个字段is_virtual（值0表示不是虚拟产品，1表示是虚拟产品）
similar Number 否 默认0 可选值0和1，是指自动使用找相似功能。仅当接口搜索指定商品ID时有效（默认此时只返回指定商品信息，当similar=1时则同时返回该商品近似商品）。
start_price Number 否 23 商品筛选-折扣价范围下限。可和end_price配合使用，单位：元
end_price Number 否 31 商品筛选-折扣价范围上限。可和start_price配合使用，单位：元
start_tk_rate Number 否 12345 商品筛选-淘客佣金比率下限。注意是千位表示法，如：1234表示12.34%
end_tk_rate Number 否 12345 商品筛选-淘客佣金比率上限。如：1234表示12.34%
is_overseas Number 否 默认为0 是否海外商品，可选值1 指定为海外产品。
is_tmall Number 否 默认0 是否商城商品，设为1表示商品是天猫商城商品，不设置或0表示不限制。
sort String 否 tk_rate_des 排序，默认 total_sales_des（销量降序），可选值如下：global（综合排序）,tk_rate_des（淘客佣金比率降序）,tk_rate_asc（淘客佣金比率升序）, total_sales_des（销量降序，默认）, total_sales_asc（销量升序）,tk_total_sales_des（累计推广量降序）,tk_total_sales_asc（累计推广量升序）,tk_total_commi_des（总支出佣金降序）,tk_total_commi_asc（总支出佣金升序）,price_des（价格降序）,price_asc（价格升序）
ip String 否 12.71.3.2 当需要限制包邮时，最好传递顾客的IP参数，比如ip=122.71.37.32 ，最好和freeship一起使用。
freeship Number 否 默认0 是否只查包邮产品，默认值不限。可选值1
npx Number 否 默认1 牛皮癣程度，此参数影响主图美观度，可用取值范围 1-不限，2-无，3-轻微
relation_id Number 否 12313232 渠道关系ID，仅适用于渠道推广场景
special_id Number 否 56652123 会员运营ID
tklink Number 否 默认0 可选值1，如果您需要直接生成推广链接请指定1，返回 item_id、url、coupon_share_url 这三个字段。
pid String 否 mm_11_22_33 推广位，如果您设置了tklink参数，则必须提供pid参数。
force_index String 否 40049_e1142 位点字段，强制使用标题提词功能（有需要时调用，不要高频使用，影响效率）：有时关键词如“95%绒子羽绒被白鹅绒被蓬松羽绒被芯被子”淘宝官方返回全是不相关的宠物玩具等产品，接口已做了自动分析返回值，如果不符合则自动用“标题提词”功能介入优化搜索，得到正确结果，但有时可能有的词仍然被分析方法漏掉，得到的仍是不准确的结果，这时你可以使用本参数，把相同关键字上次搜索结果的返回值中“force_index”值做为本参数入参，比如“force_index=16007_e1473”，这样就可以对“相同的关键词”强制使用标题提词功能。本参数不能直接使用，要依赖于上次搜索结果返回的force_index字段值，且有时效性。且关键字必须相同。
presale Number 否 默认0 可选值1（仅双11期间有效），表示关键字搜索的商品均为双11预售商品。
material_id Number 否 5612 指定物料ID。当presale参数为1时，本参数失效。
include_pay_rate_30 Number 否 默认0 可选值1，商品筛选(特定媒体支持)-成交转化是否高于行业均值。1表示大于等于，0或不设置表示不限
include_good_rate Number 否 默认0 参数值1或0，商品筛选-好评率是否高于行业均值。1表示大于等于，0或不设置表示不限
end_ka_tk_rate Number 否 1234 商品筛选-KA媒体淘客佣金比率上限。如：1234表示12.34%
start_ka_tk_rate Number 否 1234 商品筛选-KA媒体淘客佣金比率下限。如：1234表示12.34%
device_value String 否   智能匹配-设备号加密后的值（MD5加密需32位小写）
device_encrypt String 否   设备号加密类型MD5
device_type String 否   设备号类型：IMEI，或者IDFA，或者UTDID（UTDID不支持MD5加密），或者OAID
lock_rate_end_time Number 否 1567440000000 锁佣结束时间
lock_rate_start_time Number 否 1567440000000 商品筛选-锁佣开始时间
checksalestatus Number 否 默认值0 检测商品是否为淘客商品且有效（比如优惠券过期等），当参数中商品为非淘客或下架时，不再搜索相似商品，直接返回下架。
seller_ids String 否 1,2,3,4 商家id，仅支持饿了么卡券商家ID，支持批量请求1-100以内，多个商家ID使用英文逗号分隔
city_code String 否 110100 本地化业务入参-LBS信息-国标城市码，仅支持单个请求，请求饿了么卡券物料时该字段是（附详细城市ID清单）
latitude String 否 31.230370 本地化业务入参-LBS信息-纬度
longitude String 否 121.473701 本地化业务入参-LBS信息-经度
need_prepay String 否 1 参数值1或0，商品筛选-是否加入消费者保障。1表示加入，0或不设置表示不限
sessionkey String 否 7002 多用户专用。当传入tklink时需要本参数。如果您的会员卡是多用户版订单查询接口，若要查不同的帐号，请提供该帐号授权的sessionkey值
account_id String 否 联盟号id 会员中心有多个授权时，用本参数指定要查询哪一个联盟号id，联盟号ID请到会员中心授权页查看。当传入tklink时需要本参数。

请求示例

  • HTTP
  • PHP
  • JAVA
  • PYTHON
GET/POST  http://api.veapi.cn/tbk/tb_search?vekey=xxx&para=xxx 

【例子】关键字搜索：搜索“华为手机”
http://api.veapi.cn/tbk/tb_search?vekey=xxx&para=华为手机


【例子】搜索ID为"651196798743"的淘客商品
http://api.veapi.cn/tbk/tb_search?vekey=xxx&para=651196798743


【例子】搜索淘口令￥a8yTdef93D0￥的商品
http://api.veapi.cn/tbk/tb_search?vekey=xxx&para=58￥ CZ3457 a8yTdef93D0￥短袖t恤女


【例子】搜索商品分类为“1512”的商品
http://api.veapi.cn/tbk/tb_search?vekey=xxx&cat=1512
使用curl函数，curl不是php原生库，需要安装才能使用

$api="http://api.veapi.cn/tbk/tb_search?vekey=xxx&para=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; //返回值
使用okhttp3/httpclient/jsoup/hutool，以hutool为例：

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?vekey=xxx&para=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);
    }
}
推荐使用 requests，支持访问http,https网页：

import requests
		
# 要访问的API网页
target_url = "http://api.veapi.cn/tbk/tb_search?vekey=xxx&para=xxx"

# 发送请求
response = requests.get(target_url)

# 获取页面内容
if response.status_code == 200:
	print response.text

返回值（JSON）

参数名称 参数类型 示例值 描述
search_type Number 10 搜索类型：0表示未启动搜索，10表示搜索淘口令或链接中的产品，21和22表示搜索非淘客商品找相似结果，30表示搜索关键字，60其它
is_similar Number 0 是否是相似搜索：0-否，1-是
is_splitWord Number 0 是否触发精准提词功能：0-否，1-是
force_index String 11_22 取决于is_splitWord类型，参考参数说明。当无提词时，则本参数可能为空。
total_results Number 1 返回的商品数量。
coupon_start_time String 2017-10-29 优惠券开始时间
coupon_end_time String 2017-10-29 优惠券开始时间
info_dxjh String {"19013551":"2850","74510538":"2550"} 是否包含定向计划
tk_total_sales String 11 淘客30天推广量
tk_total_commi String 323 月支出佣金(该字段废弃，请勿再用)
coupon_id String d62db1abfc33b 优惠券id
num_iid String 5566337749 宝贝id(该字段废弃，请勿再用)
title String 毛呢阔腿裤2017新款 商品标题
pict_url String https://....jpg 商品主图
small_images String[] https://...jpg 商品小图列表
reserve_price String 102.00 商品原价，通常显示为划线价
zk_final_price String 88.00 在线售卖价(元)。若属于预售商品，付定金时间内，在线售卖价=预售价
user_type Number 1 卖家类型。0表示集市，1表示天猫，3淘特
provcity String 杭州 宝贝所在地
item_url String https://.. 商品地址
include_mkt String false 是否包含营销计划
include_dxjh String false 是否包含定向计划
commission_rate String 1550 佣金比率。1550表示15.5%
volume Number 123 30天销量(饿了么卡券信息-总销量）
seller_id Number 232332 卖家id
shop_title String xx旗舰店 店铺名称
coupon_total_count Number 22323 优惠券总量
coupon_remain_count Number 111 优惠券剩余量
coupon_info String 满29元减20元 优惠券满减信息
coupon_amount String 10.00 优惠券(元)。若属于预售商品，该优惠券付尾款可用，付定金不可用
coupon_start_fee String 29.00 优惠券起用门槛，满X元可用，如：满29元减20元
commission_type String MKT 佣金类型。MKT表示营销计划，SP表示定向计划，COMMON表示通用计划
url String s.click.xxx 宝贝推广链接
coupon_share_url String uland.xxx 宝贝+券二合一页面链接
shop_dsr Number 13 店铺dsr评分
white_image String https://...jpg 商品白底图
short_title String xxsd 商品短标题
category_id Number 162201 叶子类目id
category_name String 连衣裙 叶子类目名称
level_one_category_id Number 20 一级类目ID
level_one_category_name String 女装 一级类目名称
oetime String 2018-08-21 11:23:31 拼团专用-拼团结束时间
ostime String 2018-08-21 11:23:31 拼团专用-拼团开始时间
jdd_num Number 10 拼团专用--拼团几人团
jdd_price String 5 拼团专用-拼团拼成价，单位元
uv_sum_pre_sale Number 23 预售专用-预售数量
item_description String 夏季凉被全棉亲肤 宝贝描述(推荐理由,不一定有)
nick String 旗舰店 卖家昵称
x_id String uESS0N8tLuuc 物料块id(测试中请勿使用)
orig_price String 25 拼团专用-拼团一人价(原价)，单位元
total_stock Number 5555 拼团专用-拼团库存数量
sell_num Number 1111 拼团专用-拼团已售数量
stock Number 4444 拼团专用-拼团剩余库存
tmall_play_activity_info String 前n件x折 营销-天猫营销玩法
item_id String 5678899993 宝贝id
real_post_fee String 0.00 商品邮费
lock_rate_start_time Number 1567440000000 锁佣开始时间
lock_rate_end_time Number 1567440000000 锁佣结束时间
lock_rate String 110 锁住的佣金率
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_click_url String https://... 预售有礼-推广链接
ysyl_commission_rate String 2030（表示20.3%） 预售有礼-佣金比例(预售有礼活动享受的推广佣金比例，注：推广该活动有特殊分成规则）
ysyl_tlj_face String 0.6 预售有礼-预估淘礼金(元)
ysyl_tlj_use_end_time String 2019-11-10 21:59:59 预售有礼-淘礼金使用结束时间
ysyl_tlj_use_start_time String 2019-11-10 21:59:59 预售有礼-淘礼金使用开始时间
usable_shop_name String   饿了么卡券专营店,本地化-可用店铺名称
usable_shop_id String 10001 本地化-可用店铺id
distance String 300 本地化-到门店距离(米)
sale_end_time String 1567440000000 本地化-销售开始时间
sale_begin_time String 1567440000000 本地化-销售结束时间
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 String   本地化-扩展信息
commi_score String 20.0 物料评估-收益分
match_score String 10.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....jpg 百亿补贴品牌logo
 └─ bybt_pic_url String //img...jpg 百亿补贴白底图
 └─ bybt_item_tags String[] ["https://...png"] 百亿补贴商品特征标签，如：今日发货、晚发补偿、限购一件等
 └─ 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 商品的百亿补贴结束时间
tt_sold_count String 200+ 商品入驻淘特后产生的所有销量量级，不特指某段具体时间
maifan_promotion Maifanpromotiondto   猫超买返卡信息
 └─ maifan_promotion_end_time String 1559750399000 猫超买返卡活动结束时间
 └─ maifan_promotion_start_time String 1559750399000 猫超买返卡活动开始时间
 └─ maifan_promotion_discount String 200 猫超买返卡面额
 └─ maifan_promotion_condition String 100 猫超买返卡总数，-1代表不限量，其他大于等于0的值为总数
cpa_reward_type String 0 1 2 额外奖励活动类型，如果一个商品有多个奖励类型，返回结果使用空格分割，0=预售单单奖励，1=618超级U选单单补
cpa_reward_amount String 1.11 2.22 3.21 额外奖励活动金额，活动奖励金额的类型与cpa_reward_type字段对应，如果一个商品有多个奖励类型，返回结果使用空格分割
activity_id String 188 合作伙伴单单补ID，用作“年货节超级单单补”活动合作伙伴奖励统计依据
rank_page_url String s.click.xxx 榜单url
sp_campaign_list Spcampaign[]   定向计划集合
 └─ 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... 定向计划申请链接
 └─ sp_status String 1 定向计划是否可用 1-可用 0-不可用
item_search_type String 1-1 搜索类型
page_result_key String abcde 本地化-lbs唯一分页标示，请在翻页时作为入参透传

返回示例

【提示】推广链接通常有时效性，示例中的链接为创建文档时生成，仅用于展示返回结果使用，有可能已失效。
{ "error": "0", "msg": "查询成功！", "search_type": 30, "is_similar": "0", "is_splitWord": 0, "force_index": "", "total_results": 1, "result_list": [ { "category_id": 127830005, "category_name": "植物蛋白饮料/植物奶/植物酸奶", "commission_rate": "135", "coupon_info": "", "coupon_remain_count": 0, "coupon_total_count": 0, "item_description": "", "item_id": "5NPr3x5fxtyXAXeh0Ort7uV-8P9O0eC0YrG5n8GCAr", "item_url": "https://uland.taobao.com/item/edetail?id=5NPr3x5fxtyXAXeh0Ort7uV-8P9O0eC0YrG5n8GCAr", "level_one_category_id": 50026316, "level_one_category_name": "咖啡/麦片/冲饮", "nick": "天猫超市", "num_iid": "5NPr3x5fxtyXAXeh0Ort7uV-8P9O0eC0YrG5n8GCAr", "pict_url": "https://img.alicdn.com/bao/uploaded/i4/6000000001876/O1CN011YEDBM1PjFofFgoYy_!!6000000001876-0-picassoopen.jpg", "presale_deposit": "0", "presale_end_time": 0, "presale_start_time": 0, "presale_tail_end_time": 0, "presale_tail_start_time": 0, "provcity": "上海", "real_post_fee": "5.00", "reserve_price": "74", "seller_id": 144185701108507162, "shop_dsr": 48829, "shop_title": "天猫超市", "short_title": "维他奶真豆醇麦豆奶营养早餐植物奶", "small_images": [ "https://img.alicdn.com/i2/725677994/O1CN0137BfOk28vIvIzEw1I_!!725677994.jpg", "https://img.alicdn.com/i1/725677994/O1CN01mF8XdP28vIvLgh4ms_!!725677994.jpg", "https://img.alicdn.com/i4/725677994/O1CN01heYWpE28vIvCcHeR1_!!725677994.jpg", "https://img.alicdn.com/i4/725677994/O1CN01hhvOvl28vIvE5jtAi_!!725677994.jpg" ], "superior_brand": "1", "title": "维他奶真豆醇麦豆奶营养早餐植物奶250ml*24盒低糖低脂0胆固醇", "tk_total_commi": "12707.24", "tk_total_sales": "10000", "user_type": 1, "volume": 10000, "white_image": "https://img.alicdn.com/bao/uploaded/O1CN01GtVXFp1whJROFQPiH_!!6000000006339-0-yinhe.jpg", "zk_final_price": "67.2", "coupon_id": "" } ], "request_id": "CzY1nPJ" }

错误码

如果error不为0时，请点此查看错误码表格

在线
客服

点此【QQ在线咨询】QQ号：3252444923

会员请加QQ群交流：

微信
咨询

加微信咨询
顶部