淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
scp_code	String	必须	123	SCP单号
owner_id	Number	必须	123	货主id
operator_nick	String	可选	123	操作人名称
mail_nos	String	必须		运单号

名称	类型	示例值	描述
result	BaseResult		结果
└ success Boolean true false：失败 true：成功 result HiErpIntOperateResp [] 数据 └ scp_code String 123 履约单号 └ mail_no String 123 运单号 └ tms_cut_result_text String 拦截失败拦截结果文案描述 └ out_order_code String 123 外部订单号 └ error_code String 错误编码通常用于success为false时的页面错误类型判定 └ error_msg String 错误信息通常用于success为false时的页面错误信息提示 └ msg String 描述通常用于success为true时的页面提示

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaTianmaoUopInterceptRequest req = new AlibabaTianmaoUopInterceptRequest();
req.setScpCode("123");
req.setOwnerId(123L);
req.setOperatorNick("123");
req.setMailNos("");
AlibabaTianmaoUopInterceptResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaTianmaoUopInterceptRequest req = new AlibabaTianmaoUopInterceptRequest();
req.ScpCode = "123";
req.OwnerId = 123L;
req.OperatorNick = "123";
req.MailNos = "";
AlibabaTianmaoUopInterceptResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaTianmaoUopInterceptRequest;
$req->setScpCode("123");
$req->setOwnerId("123");
$req->setOperatorNick("123");
$req->setMailNos("");
$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=alibaba.tianmao.uop.intercept' \
-d 'partner_id=apidoc' \
-d 'session=2cb2200e-f987-4e5c-918e-ba54b9ede1f2' \
-d 'sign=8C22EEFB6AF952CD77078CF0ECED06B2' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-04+15%3A34%3A43' \
-d 'v=2.0' \
-d 'mail_nos=null' \
-d 'operator_nick=123' \
-d 'owner_id=123' \
-d 'scp_code=123'

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

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

req.scp_code="123"
req.owner_id=123
req.operator_nick="123"
req.mail_nos="数据结构示例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,"alibaba.tianmao.uop.intercept");
add_param(pRequest,"scp_code","123");
add_param(pRequest,"owner_id","123");
add_param(pRequest,"operator_nick","123");
add_param(pRequest,"mail_nos","");
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('alibaba.tianmao.uop.intercept', {
	'scp_code':'123',
	'owner_id':'123',
	'operator_nick':'123',
	'mail_nos':''
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_tianmao_uop_intercept_response>
    <result>
        <success>true</success>
        <result>
            <hi_erp_int_operate_resp>
                <scp_code>123</scp_code>
                <mail_no>123</mail_no>
                <tms_cut_result_text>拦截失败</tms_cut_result_text>
                <out_order_code>123</out_order_code>
            </hi_erp_int_operate_resp>
        </result>
        <error_code>错误编码</error_code>
        <error_msg>错误信息</error_msg>
        <msg>描述</msg>
    </result>
</alibaba_tianmao_uop_intercept_response>

{
    "alibaba_tianmao_uop_intercept_response":{
        "result":{
            "success":true,
            "result":{
                "hi_erp_int_operate_resp":[
                    {
                        "scp_code":"123",
                        "mail_no":"123",
                        "tms_cut_result_text":"拦截失败",
                        "out_order_code":"123"
                    }
                ]
            },
            "error_code":"错误编码",
            "error_msg":"错误信息",
            "msg":"描述"
        }
    }
}

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下载

开放平台

天猫供应链

alibaba.tianmao.uop.intercept (阿里巴巴.天猫. 履约订单. 配送拦截)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ