淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	描述
mobile	String	可选	13724153200	下单操作人手机号
td_order_id	Number	必须	2037921210947395	需要取消的订单号
reason_code	String	必须	1	取消原因code
reason_desc	String	可选	小件员迟到	取消原因描述

名称	类型	示例值	描述
result	TdOpenServiceResult	{}	返回对象
data TdInterResult {} 返回对象 └ data Boolean false 是否取消成功 └ status_message String 订单已揽收，不允许取消取消失败时显示取消原因 └ status_code String 10 取消失败原因code └ identity String 7678267387781 发起取消的订单号 └ success Boolean true 是否执行成功 └ success Boolean true 是否操作成功 └ retry Boolean false 是否需要重试 └ status_message String 系统错误错误描述，如果不能使用服务，会在这里提示错误信息 └ status_code String SYS_ERROIR 错误码

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoPickupBusinessOrderCancelRequest req = new CainiaoPickupBusinessOrderCancelRequest();
req.setMobile("13724153200");
req.setTdOrderId(2037921210947395L);
req.setReasonCode("1");
req.setReasonDesc("小件员迟到");
CainiaoPickupBusinessOrderCancelResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoPickupBusinessOrderCancelRequest req = new CainiaoPickupBusinessOrderCancelRequest();
req.Mobile = "13724153200";
req.TdOrderId = 2037921210947395L;
req.ReasonCode = "1";
req.ReasonDesc = "小件员迟到";
CainiaoPickupBusinessOrderCancelResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoPickupBusinessOrderCancelRequest;
$req->setMobile("13724153200");
$req->setTdOrderId("2037921210947395");
$req->setReasonCode("1");
$req->setReasonDesc("小件员迟到");
$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=cainiao.pickup.business.order.cancel' \
-d 'partner_id=apidoc' \
-d 'session=50e60970-f84e-440c-8dc7-79f826b87e96' \
-d 'sign=446A8A1F75C24188210057B2E093F463' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-05+03%3A25%3A52' \
-d 'v=2.0' \
-d 'mobile=13724153200' \
-d 'reason_code=1' \
-d 'reason_desc=%E5%B0%8F%E4%BB%B6%E5%91%98%E8%BF%9F%E5%88%B0' \
-d 'td_order_id=2037921210947395'

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

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

req.mobile="13724153200"
req.td_order_id=2037921210947395
req.reason_code="1"
req.reason_desc="小件员迟到"
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,"cainiao.pickup.business.order.cancel");
add_param(pRequest,"mobile","13724153200");
add_param(pRequest,"td_order_id","2037921210947395");
add_param(pRequest,"reason_code","1");
add_param(pRequest,"reason_desc","小件员迟到");
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('cainiao.pickup.business.order.cancel', {
	'mobile':'13724153200',
	'td_order_id':'2037921210947395',
	'reason_code':'1',
	'reason_desc':'小件员迟到'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<cainiao_pickup_business_order_cancel_response>
    <result>
        <data>
            <data>false</data>
            <status_message>订单已揽收，不允许取消</status_message>
            <status_code>10</status_code>
            <identity>7678267387781</identity>
            <success>true</success>
        </data>
        <success>true</success>
        <retry>false</retry>
        <status_message>系统错误</status_message>
        <status_code>SYS_ERROIR</status_code>
    </result>
</cainiao_pickup_business_order_cancel_response>

{
    "cainiao_pickup_business_order_cancel_response":{
        "result":{
            "data":{
                "data":false,
                "status_message":"订单已揽收，不允许取消",
                "status_code":"10",
                "identity":"7678267387781",
                "success":true
            },
            "success":true,
            "retry":false,
            "status_message":"系统错误",
            "status_code":"SYS_ERROIR"
        }
    }
}

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

cainiao.pickup.business.order.cancel (菜鸟商家寄件取消订单)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ