淘宝客API
taobao.tbk.item.convert
淘宝客-推广者-商品链接转换
taobao.tbk.item.info.get
淘宝客-公用-淘宝客商品详情查询(简版)
taobao.tbk.item.share.convert
淘宝客-推广者-商品三方分成链接转换
taobao.tbk.shop.get
淘宝客-推广者-店铺搜索
taobao.tbk.shop.recommend.get
淘宝客-公用-店铺关联推荐
taobao.tbk.shop.share.convert
淘宝客-推广者-店铺三方分成链接转换
taobao.tbk.spread.get
淘宝客-公用-长链转短链
taobao.tbk.itemid.coupon.get
淘宝客-推广者-根据宝贝id批量查询优惠券
taobao.tbk.item.click.extract
淘宝客-公用-链接解析出商品id
taobao.tbk.data.report
淘宝客-服务商-保护门槛
taobao.tbk.privilege.get
淘宝客-服务商-单品券高效转链
taobao.tbk.coupon.convert
淘宝客-推广者-单品券高效转链
taobao.tbk.coupon.get
淘宝客-公用-阿里妈妈推广券详情查询
taobao.tbk.tpwd.create
淘宝客-公用-淘口令生成
taobao.tbk.adzone.create
淘宝客-推广者-创建推广位
taobao.tbk.tpwd.mix.create
淘宝客-公用-文本淘口令
taobao.tbk.tpwd.share.convert
淘宝客-推广者-淘口令解析&三方分成转链
taobao.tbk.tpwd.convert
淘宝客-推广者-淘口令解析&转链
taobao.tbk.dg.newuser.order.get
淘宝客-推广者-新用户订单明细查询
taobao.tbk.dg.optimus.material
淘宝客-推广者-物料精选
taobao.tbk.sc.adzone.create
淘宝客-服务商-创建推广者位
taobao.tbk.sc.material.optional
淘宝客-服务商-物料搜索
taobao.tbk.dg.material.optional
淘宝客-推广者-物料搜索
taobao.tbk.dg.newuser.order.sum
淘宝客-推广者-拉新活动对应数据查询
taobao.tbk.sc.newuser.order.sum
淘宝客-服务商-拉新活动数据查询
taobao.tbk.sc.publisher.info.save
淘宝客-公用-私域用户备案
taobao.tbk.sc.publisher.info.get
淘宝客-公用-私域用户备案信息查询
taobao.tbk.sc.invitecode.get
淘宝客-公用-私域用户邀请码生成
taobao.tbk.tbkinfo.get
淘宝客-公用-pid校验
taobao.tbk.relation.refund
淘宝客-推广者-售后退款订单查询
taobao.tbk.dg.vegas.tlj.create
淘宝客-推广者-淘礼金创建
taobao.tbk.dg.reports.query
报表查询
taobao.tbk.sc.punish.order.get
淘宝客-服务商-处罚订单查询
taobao.tbk.dg.punish.order.get
淘宝客-推广者-处罚订单查询
taobao.tbk.tpwd.parse
淘宝客-公用-淘口令解析出原链接
taobao.tbk.content.recommend.material.get
淘宝客-推广者-图文智能识别消费者端推荐物料查询
taobao.tbk.content.daren.material.upload
淘宝客-推广者-图文智能识别达人端物料上传
taobao.tbk.order.details.get
淘宝客-推广者-所有订单查询
taobao.tbk.sc.order.details.get
淘宝客-服务商-所有订单查询
taobao.tbk.sc.tpwd.convert
淘宝客-服务商-淘口令解析&转链
taobao.tbk.sc.relation.refund
淘宝客-服务商-售后退款订单查询
taobao.tbk.dg.reports.newquery
淘宝客-推广者-媒体数据报表交换
taobao.tbk.jzf.convert
淘宝客-推广者-官办找福利页
taobao.tbk.dg.reports.query.stat
淘宝客-推广者-媒体数据报表交换-汇总数据
taobao.tbk.item.details.get
淘宝客-公用-淘宝客商品详情查询(详细版)
taobao.tbk.sc.vegas.send.report
淘宝客-服务商-查询红包发放个数
taobao.tbk.dg.vegas.send.report
淘宝客-推广者-查询红包发放个数
qimen.taobao.tbk.item.rule.get
淘宝客商品展示规则获取
taobao.tbk.dg.content.media.daily.report
淘宝客-推广者-微博日报(达人维度)
taobao.tbk.dg.content.media.monthly.report
淘宝客-推广者-微博月报(达人维度)
taobao.tbk.activity.info.get
淘宝客-推广者-官方活动转链
taobao.tbk.sc.activity.info.get
淘宝客-服务商-官方活动转链
taobao.tbk.cp.order.details.get
淘宝客-招商团长-服务费订单明细
taobao.tbk.sc.cp.order.details.get
淘宝客-工具-团长-所有订单查询
taobao.tbk.dg.optimus.promotion
淘宝客-推广者-权益物料精选
taobao.tbk.sc.optimus.promotion
淘宝客-服务商-权益物料精选
taobao.tbk.sc.vegas.send.status
淘宝客-服务商-红包领取状态查询
taobao.tbk.dg.vegas.send.status
淘宝客-推广者-红包领取状态查询
taobao.tbk.dg.pailitao.widget.convert
淘宝客-推广者-拍立淘插件转链
taobao.tbk.sc.ucrowd.create
淘宝客-服务商-创建人群标签
taobao.tbk.dg.pic.embed
淘宝客-推广者-商业化图片生成
taobao.tbk.sc.relation.record
淘宝客-服务商-私域会员标记
taobao.tbk.sc.pailitao.widget.convert
淘宝客-服务商-拍立淘插件转链
taobao.tbk.sc.pic.embed
淘宝客-服务商-商业化图片生成
taobao.tbk.cart.coupon.expire.user.query
购物车催付优惠券到期查询用户信息
taobao.tbk.sc.ucrowd.report.get
淘宝客-服务商-人群推广效果
taobao.tbk.sku.best.coupon
sku维度最优优惠券信息
taobao.tbk.thor.mfrs.promotion.query
淘宝联盟厂商找优惠
taobao.tbk.sc.rta.consumer.match
淘宝客-服务商-定向活动目标发布
taobao.tbk.rta.consumer.match
淘宝客-推广者-定向活动目标发布
taobao.tbk.dg.cpa.activity.detail
淘宝客-推广者-CPA活动执行明细
taobao.tbk.dg.tpwd.report.get
淘宝客-推广者-淘口令回流数据查询
taobao.tbk.sc.tpwd.report.get
淘宝客-服务商-淘口令回流数据查询
taobao.tbk.sc.cpa.activity.detail
淘宝客-服务商-CPA活动执行明细
taobao.tbk.private.tpwd.create
淘宝客-推广者-加密淘口令生成
taobao.tbk.sc.private.tpwd.create
淘宝客-服务商-加密淘口令生成
taobao.tbk.dg.cpa.activity.report
淘宝客-推广者-任务奖励效果报表
taobao.tbk.sc.cpa.activity.report
淘宝客-服务商-任务奖励效果报表
taobao.tbk.dg.vegas.tlj.stop
淘宝客-推广者-淘礼金暂停发放
taobao.tbk.dg.vegas.tlj.report
淘宝客-推广者-淘礼金效果数据
taobao.tbk.dg.tpwd.risk.report
淘宝客-推广者-淘口令预警及拦截查询
taobao.tbk.sc.tpwd.risk.report
淘宝客-服务商-淘口令预警及拦截查询
taobao.tbk.dg.vegas.tlj.share.convert
淘宝客-推广者-淘礼金三方链接转换
taobao.tbk.sc.rec.material
淘宝客-服务商-单品推荐
taobao.tbk.seed.report.get
淘宝客-推广者-种草指标报表
taobao.tbk.sc.material.recommend
淘宝客-服务商-物料精选升级版
taobao.tbk.dg.material.recommend
淘宝客-推广者-物料精选升级版
taobao.tbk.seed.wb.crowd.get
淘宝客-推广者-内容种草人群包数据查询
taobao.tbk.content.order.get
淘宝客-推广者-内容ID订单汇总
taobao.tbk.sc.membergroup.optional
淘宝客-服务商-member组查询&新增
taobao.tbk.itemid.share.transform
淘宝客-推广者-商品id升级（三方）
taobao.tbk.itemid.private.transform
淘宝客-推广者-商品id转化（二方）（专有）
taobao.tbk.optimus.tou.material.ids.get
淘宝客-推广者-物料id列表查询
taobao.tbk.sc.content.material
淘宝客-服务商-爆料分享物料获取
taobao.tbk.dg.content.material
淘宝客-推广者-爆料分享物料获取
taobao.tbk.content.material.save
淘宝客-公用-爆料分享物料上传
taobao.tbk.seed.event.get
淘宝客-推广者-内容种草任务列表下行
taobao.tbk.seed.event.write
淘宝客-推广者-种草内容数据写入
taobao.tbk.media.data.upload
淘宝客-推广者-导购数据上传
taobao.tbk.item.details.upgrade.get
淘宝客-公用-淘宝客商品详情查询升级版（详细版）
taobao.tbk.sc.material.optional.upgrade
淘宝客-服务商-物料搜索升级版
taobao.tbk.dg.material.optional.upgrade
淘宝客-推广者-物料搜索升级版
taobao.tbk.item.info.upgrade.get
淘宝客-公用-淘宝客商品详情查询升级版（简易版）
taobao.tbk.order.refund.get
淘宝客-推广者-全量售后退款订单查询
taobao.tbk.itemid.ineffective.transform
淘宝客-公用-失效商品id转化
taobao.tbk.sc.order.refund.get
淘宝客-服务商-全量售后退款订单查询
taobao.tbk.dg.general.link.convert
淘宝客-推广者-万能转链
taobao.tbk.sc.general.link.convert
淘宝客-服务商-万能转链
taobao.tbk.feed.opt.upload
淘宝客-推广者-内容种草投流明细数据上传
taobao.tbk.dg.item.group.merge
淘宝客-推广者-多品凑单上传
taobao.tbk.feed.relation.upload
淘宝客-推广者-内容投流关系写入
taobao.tbk.feed.indicator.upload
淘宝客-推广者-内容种草投流前链路数据上传
taobao.tbk.feed.indicator.exchange
淘宝客-推广者-内容种草投流数据交换
taobao.tbk.feed.event.get
淘宝客-推广者-投流任务信息下行
taobao.tbk.uvid.encrypt
淘宝客-推广者-加密用户标识生成
taobao.tbk.seed.event.fee.update
淘宝客-推广者-种草商单子任务改价申请
taobao.tbk.seed.event.fee.update.result.get
淘宝客-推广者-种草商单子任务改价结果查询
taobao.tbk.rta.uvid.get
淘宝客-推广者-厂商版加密用户标识获取
taobao.tbk.feed.order.check
淘宝客-推广者-内容种草投流对账单
taobao.tbk.marketing.msg.send
商业化消息推送
taobao.tbk.interest.items.get
淘宝客-推广者-厂商版-个性化推荐商品获取
taobao.tbk.content.general.link.convert
淘宝客-推广者-内容三方万能转链
taobao.tbk.feed.track.upload
通用用户监测数据上传
taobao.tbk.sc.social.crowd.get
淘宝客-服务商-群信息获取
taobao.tbk.sc.social.crowd.create
淘宝客-服务商-社群创建
taobao.tbk.sc.social.crowd.delete
淘宝客-服务商-社群删除
taobao.tbk.sc.social.crowd.add
淘宝客-服务商-群内人群管理
taobao.tbk.sc.uvid.encrypt
淘宝客-服务商-加密用户标识生成
taobao.tbk.seed.kox.write
获取服务商达人数据
taobao.tbk.dg.interest.items.get
淘宝客_推广者_个性化商品获取
taobao.tbk.sc.interest.items.get
淘宝客_服务商_个性化商品获取
taobao.tbk.sc.uvid.behavior.report
淘宝客-服务商-商品行为上报
taobao.tbk.dg.uvid.behavior.report
淘宝客-推广者-商品行为上报
taobao.tbk.dg.general.link.parse
淘宝客-推广者-万能解析
taobao.tbk.sc.general.link.parse
淘宝客-服务商-万能解析
taobao.tbk.sc.uvid.bind.status.get
淘宝-淘宝客-服务商-用户绑定状态查询
taobao.tbk.dg.uvid.bind.status.get
淘宝-淘宝客-推广者-用户绑定状态查询
taobao.tbk.seed.content.update
商单种草任务内容信息变更
taobao.tbk.sc.organization.member.mod
淘宝客-服务商-自定义服务组成员修改
taobao.tbk.sc.organization.member.query
淘宝客-服务商-自定义服务组成员查询
taobao.tbk.dg.rta.uvid.match
淘宝客-推广者-UVID人群挑量
taobao.tbk.sc.rta.uvid.match
淘宝客-服务商-UVID人群挑量
taobao.tbk.content.reports.query.stat
淘宝客-内容三方-媒体数据报表交换-汇总数据
taobao.tbk.dg.vegas.activity.tlj.create
创建社群拉新礼金
taobao.tbk.sc.rta.trade.consumer.match
淘宝客-服务商-订单ID挑量
taobao.tbk.dsp.rta.consumer.match
淘宝客-推广者-目标用户批量匹配
taobao.tbk.sc.reports.query.stat
淘宝客-服务商-拉新CPA奖励明细数据
taobao.tbk.sf.group.activity.pull
生态发单计划拉取
taobao.tbk.sf.group.activity.callback
生态发单结果回调
taobao.tbk.sf.group.status.report
生态发单通路状态上报
taobao.tbk.sc.adzone.query
淘宝客-服务商-联盟推广位查询API
taobao.tbk.sf.content.material.callback
淘宝客-服务商-物料上翻
taobao.tbk.sf.content.source.callback
淘宝客-服务商-物料更新
taobao.tbk.dg.vc.landing.link.convert
淘宝客-推广者-拉新承接页转链
taobao.tbk.sc.vc.landing.link.convert
淘宝客-推广者-拉新承接页转链
taobao.tbk.sf.group.manage.pull
淘宝客-服务商-组管理计划拉取
taobao.tbk.sf.group.manage.callback
淘宝客-服务商-组管理结果回调
taobao.tbk.sf.agent.capability.update
淘宝客-服务商-Agent能力上报
taobao.tbk.sf.agent.relation.report
淘宝客-服务商-机器人好友变更通知
taobao.tbk.sf.agent.abnormal.report
淘宝客-服务商-Agent异常上报
taobao.tbk.sf.private.activity.pull
淘宝客-服务商-私聊计划拉取
taobao.tbk.sf.private.activity.callback
淘宝客-服务商-机器人能力状态同步
taobao.tbk.dg.eshare.link.convert
淘宝客-推广者-KA私域专享转链
taobao.tbk.sc.reports.crowd.query.stat
淘宝客-服务商-社群明细数据
taobao.tbk.sc.action.plan.spout
淘宝客-服务商-推广计划
taobao.tbk.dg.image.ecognition.list.query
淘宝客【推广者】识图找优惠商品List
taobao.tbk.dg.image.ecognition.page.query
淘宝客【推广者】识图找优惠h5
taobao.tbk.dg.rta.sr.issue.match
淘宝客【推广者】超级红包媒体直发状态查询
taobao.tbk.sc.rta.sr.issue.match
淘宝客【服务商】超级红包媒体直发状态查询
taobao.tbk.dg.smart.assistant.link.convert
厂商智能助手转链
taobao.tbk.tpwd.share.convert (淘宝客-推广者-淘口令解析&三方分成转链)
￥开放平台免费API
不需要授权
支持通过淘口令解析商品id，并提供对应的三方分成淘客转链接
公共参数
请求地址：
环境
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。
请求参数
名称
类型
是否必须
示例值
更多限制
描述
password_content
String
必须
￥2kt123e08DjviP￥
需要解析的淘口令
adzone_id
Number
必须
1231212
广告位ID
sub_pid
String
必须
mm_11_11_11
三方pid
dx
String
可选
1
1表示商品转通用计划链接，其他值或不传表示优先转营销计划链接
响应参数
名称
类型
示例值
描述
data
MapData
data
└ num_iid
String
562120815059
商品id
└ click_url
String
https://s.click.taobao.com/t?e=xxx
商品淘客转链
请求示例
JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TbkTpwdShareConvertRequest req = new TbkTpwdShareConvertRequest();
req.setPasswordContent("￥2kt123e08DjviP￥");
req.setAdzoneId(1231212L);
req.setSubPid("mm_11_11_11");
req.setDx("1");
TbkTpwdShareConvertResponse rsp = client.execute(req);
System.out.println(rsp.getBody());
ITopClient client = new DefaultTopClient(url, appkey, secret);
TbkTpwdShareConvertRequest req = new TbkTpwdShareConvertRequest();
req.PasswordContent = "￥2kt123e08DjviP￥";
req.AdzoneId = 1231212L;
req.SubPid = "mm_11_11_11";
req.Dx = "1";
TbkTpwdShareConvertResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);
$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TbkTpwdShareConvertRequest;
$req->setPasswordContent("￥2kt123e08DjviP￥");
$req->setAdzoneId("1231212");
$req->setSubPid("mm_11_11_11");
$req->setDx("1");
$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.tbk.tpwd.share.convert' \
-d 'partner_id=apidoc' \
-d 'sign=B6E60C1E403A631A95DBD2AD29695AF5' \
-d 'sign_method=hmac' \
-d 'timestamp=2026-01-12+04%3A18%3A14' \
-d 'v=2.0' \
-d 'adzone_id=1231212' \
-d 'dx=1' \
-d 'password_content=%EF%BF%A52kt123e08DjviP%EF%BF%A5' \
-d 'sub_pid=mm_11_11_11'
# -*- coding: utf-8 -*-
import top.api
req=top.api.TbkTpwdShareConvertRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))
req.password_content="￥2kt123e08DjviP￥"
req.adzone_id=1231212
req.sub_pid="mm_11_11_11"
req.dx="1"
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.tbk.tpwd.share.convert");
add_param(pRequest,"password_content","￥2kt123e08DjviP￥");
add_param(pRequest,"adzone_id","1231212");
add_param(pRequest,"sub_pid","mm_11_11_11");
add_param(pRequest,"dx","1");
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',
'url': 'http://gw.api.taobao.com/router/rest'
});
client.execute('taobao.tbk.tpwd.share.convert', {
'password_content':'￥2kt123e08DjviP￥',
'adzone_id':'1231212',
'sub_pid':'mm_11_11_11',
'dx':'1'
}, function(error, response) {
if (!error) console.log(response);
else console.log(error);
})
响应示例
XML示例
JSON示例
{
"tbk_tpwd_share_convert_response":{
"data":{
"num_iid":"562120815059",
"click_url":"https:\/\/s.click.taobao.com\/t?e=xxx"
}
}
}
异常示例
XML示例
JSON示例
50
{
"error_response":{
"msg":"Remote service error",
"code":50,
"sub_msg":"非法参数",
"sub_code":"isv.invalid-parameter"
}
}
错误码解释
错误码
错误描述
解决方案
isp.param-error
参数错误
仔细检查参数
isp.sys-error
服务系统异常
请稍后再试
1
服务系统异常
服务系统异常
10000
该item_id对应宝贝已下架或非淘客宝贝
表示对应的商品可能已下架，或者不属于淘客商品，针对这种场景，无法提供媒体商品url，及商品id，需要媒体特别关注，并自行确定解决方案。
20010
淘口令解析失败
检查输入
20011
淘口令解析结果为空
--
20012
淘口令解析输入口令为空
检查输入
20013
淘口令解析输入subPid格式错误
检查输入
20015
淘口令转链结果为空
--
20016
淘口令转链处理异常
--
4
查询不到对应的adzoneId，请检查adzoneId是否正确
检查输入
isv.parse-result-invalid
淘口令解析结果无效，当前淘口令无效
更换淘口令或稍后重试
API工具
API测试工具
错误码查询工具
SDK下载
如何获得此API
FAQ
我要提问