文档中心 > API类目 > 物流API

cainiao.pickup.store.consign.order.batchcancel (菜鸟商家门店发货批量取消)

与外部isv打单平台对接，将裹裹寄件服务嵌入到外部平台中，期望以此获得更多寄件单量。商家在外部平台上操作时，以批量操作最方便，因此提供批量取消的能力。订单在小件员揽收前均可取消，小件员揽收后无法取消。

公共参数

请求地址：

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
biz_type	String	可选	guoguo		业务场景
mobile	String	可选	13722223333		电话
cancel_order_request_list	CancelOrderRequest []	必须		最大列表长度：20	需要取消的订单列表
└ td_order_id Number 必须 2111230057266095 裹裹交易订单号 └ reason_code String 必须 -1 取消原因code。先获取可用的取消原因 └ extend_info String 可选扩展信息 └ reason_desc String 必须信息填错了取消原因的描述

响应参数

名称	类型	示例值	描述
result	TdOpenServiceResult	{}	返回结果
data_list TdInterResult [] {} 返回结果 └ success Boolean ture 取消订单执行成功 └ status_message String 当前订单不允许取消取消失败时，失败msg └ status_code String CAN_NOT_CANCEL 取消失败时，失败code └ identity String 2111230057266095 裹裹交易单号 └ data Boolean true 订单取消成功 └ success Boolean true 批量取消请求成功 └ retry Boolean false 是否重试 └ status_message String 系统异常失败信息 └ status_code String SYSTEM_ERROR 失败code

请求示例

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoPickupStoreConsignOrderBatchcancelRequest req = new CainiaoPickupStoreConsignOrderBatchcancelRequest();
req.setBizType("guoguo");
req.setMobile("13722223333");
List<CainiaoPickupStoreConsignOrderBatchcancelRequest.CancelOrderRequest> list2 = new ArrayList<CainiaoPickupStoreConsignOrderBatchcancelRequest.CancelOrderRequest>();
CainiaoPickupStoreConsignOrderBatchcancelRequest.CancelOrderRequest obj3 = new CainiaoPickupStoreConsignOrderBatchcancelRequest.CancelOrderRequest();
list2.add(obj3);
obj3.setTdOrderId(2111230057266095L);
obj3.setReasonCode("-1");
obj3.setExtendInfo("");
obj3.setReasonDesc("信息填错了");
req.setCancelOrderRequestList(list2);
CainiaoPickupStoreConsignOrderBatchcancelResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoPickupStoreConsignOrderBatchcancelRequest req = new CainiaoPickupStoreConsignOrderBatchcancelRequest();
req.BizType = "guoguo";
req.Mobile = "13722223333";
List<CainiaoPickupStoreConsignOrderBatchcancelRequest.CancelOrderRequestDomain> list2 = new List<CainiaoPickupStoreConsignOrderBatchcancelRequest.CancelOrderRequestDomain>();
CainiaoPickupStoreConsignOrderBatchcancelRequest.CancelOrderRequestDomain obj3 = new CainiaoPickupStoreConsignOrderBatchcancelRequest.CancelOrderRequestDomain();
list2.Add(obj3);
obj3.TdOrderId = 2111230057266095L;
obj3.ReasonCode = "-1";
obj3.ExtendInfo = "";
obj3.ReasonDesc = "信息填错了";
req.CancelOrderRequestList_ = list2;
CainiaoPickupStoreConsignOrderBatchcancelResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoPickupStoreConsignOrderBatchcancelRequest;
$req->setBizType("guoguo");
$req->setMobile("13722223333");
$cancel_order_request_list = new CancelOrderRequest;
$cancel_order_request_list->td_order_id="2111230057266095";
$cancel_order_request_list->reason_code="-1";
$cancel_order_request_list->extend_info="";
$cancel_order_request_list->reason_desc="信息填错了";
$req->setCancelOrderRequestList(json_encode($cancel_order_request_list));
$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.store.consign.order.batchcancel' \
-d 'partner_id=apidoc' \
-d 'session=5018c7d8-d789-4603-b400-b1d1602fdb9a' \
-d 'sign=5A261077361F5D24E1070D878AEF375A' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-04+15%3A51%3A47' \
-d 'v=2.0' \
-d 'biz_type=guoguo' \
-d 'cancel_order_request_list=null' \
-d 'mobile=13722223333'

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

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

req.biz_type="guoguo"
req.mobile="13722223333"
req.cancel_order_request_list=""
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.store.consign.order.batchcancel");
add_param(pRequest,"biz_type","guoguo");
add_param(pRequest,"mobile","13722223333");
add_param(pRequest,"cancel_order_request_list","数据结构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('cainiao.pickup.store.consign.order.batchcancel', {
	'biz_type':'guoguo',
	'mobile':'13722223333',
	'cancel_order_request_list':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

XML示例
JSON示例

<cainiao_pickup_store_consign_order_batchcancel_response>
    <result>
        <data_list>
            <td_inter_result>
                <success>ture</success>
                <status_message>当前订单不允许取消</status_message>
                <status_code>CAN_NOT_CANCEL</status_code>
                <identity>2111230057266095</identity>
                <data>true</data>
            </td_inter_result>
        </data_list>
        <success>true</success>
        <retry>false</retry>
        <status_message>系统异常</status_message>
        <status_code>SYSTEM_ERROR</status_code>
    </result>
</cainiao_pickup_store_consign_order_batchcancel_response>

{
    "cainiao_pickup_store_consign_order_batchcancel_response":{
        "result":{
            "data_list":{
                "td_inter_result":[
                    {
                        "success":ture,
                        "status_message":"当前订单不允许取消",
                        "status_code":"CAN_NOT_CANCEL",
                        "identity":"2111230057266095",
                        "data":true
                    }
                ]
            },
            "success":true,
            "retry":false,
            "status_message":"系统异常",
            "status_code":"SYSTEM_ERROR"
        }
    }
}

异常示例

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工具

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

如何获得此API

FAQ

我要提问

返回
顶部

淘宝开放平台

物流API

cainiao.pickup.store.consign.order.batchcancel (菜鸟商家门店发货批量取消)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ