淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
target_identity	String	必须	身份唯一标识		身份唯一标识
plan_id	String	可选	0	默认值：0	计划ID
params	SfPlanQueryParams	可选			其它入参
tao_token_list LkMaterialDTO [] 可选口令列表 └ tao_token String 可选 4$4Hmq4uVtzV9$:// CZ6135 推广口令

名称	类型	示例值	描述
data	SfPlanDetailDTO	TbkLinkDTO	计划内容
plan_detail SfActionDTO [] 计划列表 └ action_id String 8$nKVv4uVCyk7$:// CZ6135 操作唯一标识 └ action_x_info String 4$4Hmq4uVtzV9$:// CZ6135 操作内容 action_extend ActionExtendDTO 操作扩展信息 └ error_code Number 1001 操作对应错误码（仅失败时有值） └ error_msg String 未查询到商品操作对应错误描述（仅失败时有值） └ plan_id String 0 计划ID └ plan_name String 口令推广计划名称
biz_error_desc	String	1	见错误码描述

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TbkScActionPlanSpoutRequest req = new TbkScActionPlanSpoutRequest();
req.setTargetIdentity("身份唯一标识");
req.setPlanId("0");
TbkScActionPlanSpoutRequest.SfPlanQueryParams obj1 = new TbkScActionPlanSpoutRequest.SfPlanQueryParams();
List<TbkScActionPlanSpoutRequest.LkMaterialDTO> list3 = new ArrayList<TbkScActionPlanSpoutRequest.LkMaterialDTO>();
TbkScActionPlanSpoutRequest.LkMaterialDTO obj4 = new TbkScActionPlanSpoutRequest.LkMaterialDTO();
list3.add(obj4);
obj4.setTaoToken("4$4Hmq4uVtzV9$:// CZ6135");
obj1.setTaoTokenList(list3);
req.setParams(obj1);
TbkScActionPlanSpoutResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TbkScActionPlanSpoutRequest req = new TbkScActionPlanSpoutRequest();
req.TargetIdentity = "身份唯一标识";
req.PlanId = "0";
TbkScActionPlanSpoutRequest.SfPlanQueryParamsDomain obj1 = new TbkScActionPlanSpoutRequest.SfPlanQueryParamsDomain();
List<TbkScActionPlanSpoutRequest.LkMaterialDTODomain> list3 = new List<TbkScActionPlanSpoutRequest.LkMaterialDTODomain>();
TbkScActionPlanSpoutRequest.LkMaterialDTODomain obj4 = new TbkScActionPlanSpoutRequest.LkMaterialDTODomain();
list3.Add(obj4);
obj4.TaoToken = "4$4Hmq4uVtzV9$:// CZ6135";
obj1.TaoTokenList= list3;
req.Params_ = obj1;
TbkScActionPlanSpoutResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TbkScActionPlanSpoutRequest;
$req->setTargetIdentity("身份唯一标识");
$req->setPlanId("0");
$params = new SfPlanQueryParams;
$tao_token_list = new LkMaterialDTO;
$tao_token_list->tao_token="4$4Hmq4uVtzV9$:// CZ6135";
$params->tao_token_list = $tao_token_list;
$req->setParams(json_encode($params));
$resp = $c->execute($req, $sessionKey);

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.sc.action.plan.spout' \
-d 'partner_id=apidoc' \
-d 'session=98ce3302-8047-4c90-85b4-31c688efae00' \
-d 'sign=1538D9E1719FEB55D2E811A149F9D966' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-09-20+11%3A58%3A47' \
-d 'v=2.0' \
-d 'params=null' \
-d 'plan_id=0' \
-d 'target_identity=%E8%BA%AB%E4%BB%BD%E5%94%AF%E4%B8%80%E6%A0%87%E8%AF%86'

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

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

req.target_identity="身份唯一标识"
req.plan_id="0"
req.params="数据结构示例JSON格式"
try:
	resp= req.getResponse(sessionkey)
	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.sc.action.plan.spout");
add_param(pRequest,"target_identity","身份唯一标识");
add_param(pRequest,"plan_id","0");
add_param(pRequest,"params","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,sessionKey);
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.tbk.sc.action.plan.spout', {
	'target_identity':'身份唯一标识',
	'plan_id':'0',
	'params':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tbk_sc_action_plan_spout_response>
    <data>
        <plan_detail>
            <sf_action_d_t_o>
                <action_id>8$nKVv4uVCyk7$:// CZ6135</action_id>
                <action_x_info>4$4Hmq4uVtzV9$:// CZ6135</action_x_info>
                <action_extend>
                    <error_code>1001</error_code>
                    <error_msg>未查询到商品</error_msg>
                </action_extend>
            </sf_action_d_t_o>
        </plan_detail>
        <plan_id>0</plan_id>
        <plan_name>口令推广</plan_name>
    </data>
    <biz_error_desc>1</biz_error_desc>
</tbk_sc_action_plan_spout_response>

{
    "tbk_sc_action_plan_spout_response":{
        "data":{
            "plan_detail":{
                "sf_action_d_t_o":[
                    {
                        "action_id":"8$nKVv4uVCyk7$:\/\/ CZ6135",
                        "action_x_info":"4$4Hmq4uVtzV9$:\/\/ CZ6135",
                        "action_extend":{
                            "error_code":1001,
                            "error_msg":"未查询到商品"
                        }
                    }
                ]
            },
            "plan_id":"0",
            "plan_name":"口令推广"
        },
        "biz_error_desc":"1"
    }
}

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

错误码	错误描述	解决方案

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

淘宝客API

taobao.tbk.sc.action.plan.spout (淘宝客-服务商-推广计划)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ