淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
idle_fish_ship_order_cancel_request	IdleFishShipOrderCancelRequest	可选			寄件单批量取消请求
order_list IdleFishShipOrderCancelItem [] 必须待取消列表，上限 20 个，超限做请求级拒绝。同一次请求内寄件单号不可重复 └ order_id String 必须 22648510111421501 寄件单号，必须属于当前授权卖家名下 └ cancel_reason_code Number 必须 3001001 取消原因码。本期仅 3001001（用户取消），其他值返回 isv.cancel-reason-not-supported

名称	类型	示例值	描述
result	IdleFishShipOrderCancelResult		返回结果
└ success Boolean true 是否成功。仅全部成功为 true，部分成功为 false，实际结果以 data.success_num 为准 └ error_code String isv.order-status-not-cancelable 错误码，失败时返回。请求级拒绝时是唯一原因，逐单失败时取第一个失败单 └ error_msg String 核价后不可取消错误信息，请按错误码判断，不要匹配文案 data IdleFishShipOrderCancelData 取消业务数据，请求级拒绝时为空 └ success_num Number 1 取消成功数量 └ fail_num Number 0 取消失败数量 order_result_list IdleFishShipOrderCancelResultItem [] 逐单结果，与请求 order_list 等长同序 └ success Boolean true 该单是否取消成功 └ order_id String 22648510111421501 回传请求中的寄件单号 └ error_code String isv.order-status-not-cancelable 该单失败错误码 └ error_msg String 核价后不可取消该单失败描述

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaLogisticsIdlefishShipOrderCancelListRequest req = new AlibabaLogisticsIdlefishShipOrderCancelListRequest();
AlibabaLogisticsIdlefishShipOrderCancelListRequest.IdleFishShipOrderCancelRequest obj1 = new AlibabaLogisticsIdlefishShipOrderCancelListRequest.IdleFishShipOrderCancelRequest();
List<AlibabaLogisticsIdlefishShipOrderCancelListRequest.IdleFishShipOrderCancelItem> list3 = new ArrayList<AlibabaLogisticsIdlefishShipOrderCancelListRequest.IdleFishShipOrderCancelItem>();
AlibabaLogisticsIdlefishShipOrderCancelListRequest.IdleFishShipOrderCancelItem obj4 = new AlibabaLogisticsIdlefishShipOrderCancelListRequest.IdleFishShipOrderCancelItem();
list3.add(obj4);
obj4.setOrderId("22648510111421501");
obj4.setCancelReasonCode(3001001L);
obj1.setOrderList(list3);
req.setIdleFishShipOrderCancelRequest(obj1);
AlibabaLogisticsIdlefishShipOrderCancelListResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaLogisticsIdlefishShipOrderCancelListRequest req = new AlibabaLogisticsIdlefishShipOrderCancelListRequest();
AlibabaLogisticsIdlefishShipOrderCancelListRequest.IdleFishShipOrderCancelRequestDomain obj1 = new AlibabaLogisticsIdlefishShipOrderCancelListRequest.IdleFishShipOrderCancelRequestDomain();
List<AlibabaLogisticsIdlefishShipOrderCancelListRequest.IdleFishShipOrderCancelItemDomain> list3 = new List<AlibabaLogisticsIdlefishShipOrderCancelListRequest.IdleFishShipOrderCancelItemDomain>();
AlibabaLogisticsIdlefishShipOrderCancelListRequest.IdleFishShipOrderCancelItemDomain obj4 = new AlibabaLogisticsIdlefishShipOrderCancelListRequest.IdleFishShipOrderCancelItemDomain();
list3.Add(obj4);
obj4.OrderId = "22648510111421501";
obj4.CancelReasonCode = 3001001L;
obj1.OrderList= list3;
req.IdleFishShipOrderCancelRequest_ = obj1;
AlibabaLogisticsIdlefishShipOrderCancelListResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaLogisticsIdlefishShipOrderCancelListRequest;
$idle_fish_ship_order_cancel_request = new IdleFishShipOrderCancelRequest;
$order_list = new IdleFishShipOrderCancelItem;
$order_list->order_id="22648510111421501";
$order_list->cancel_reason_code="3001001";
$idle_fish_ship_order_cancel_request->order_list = $order_list;
$req->setIdleFishShipOrderCancelRequest(json_encode($idle_fish_ship_order_cancel_request));
$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.logistics.idlefish.ship.order.cancel.list' \
-d 'partner_id=apidoc' \
-d 'session=f4e66483-3701-45e2-934f-00c7aca9d949' \
-d 'sign=2928F50C834A67B08D844EBDA9CBFF2B' \
-d 'sign_method=hmac' \
-d 'timestamp=2026-09-27+14%3A13%3A18' \
-d 'v=2.0' \
-d 'idle_fish_ship_order_cancel_request=null'

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

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

req.idle_fish_ship_order_cancel_request=""
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.logistics.idlefish.ship.order.cancel.list");
add_param(pRequest,"idle_fish_ship_order_cancel_request","数据结构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',
	'url': 'http://gw.api.taobao.com/router/rest'
});

client.execute('alibaba.logistics.idlefish.ship.order.cancel.list', {
	'idle_fish_ship_order_cancel_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_logistics_idlefish_ship_order_cancel_list_response>
    <result>
        <success>true</success>
        <error_code>isv.order-status-not-cancelable</error_code>
        <error_msg>核价后不可取消</error_msg>
        <data>
            <success_num>1</success_num>
            <fail_num>0</fail_num>
            <order_result_list>
                <idle_fish_ship_order_cancel_result_item>
                    <success>true</success>
                    <order_id>22648510111421501</order_id>
                    <error_code>isv.order-status-not-cancelable</error_code>
                    <error_msg>核价后不可取消</error_msg>
                </idle_fish_ship_order_cancel_result_item>
            </order_result_list>
        </data>
    </result>
</alibaba_logistics_idlefish_ship_order_cancel_list_response>

{
    "alibaba_logistics_idlefish_ship_order_cancel_list_response":{
        "result":{
            "success":true,
            "error_code":"isv.order-status-not-cancelable",
            "error_msg":"核价后不可取消",
            "data":{
                "success_num":1,
                "fail_num":0,
                "order_result_list":{
                    "idle_fish_ship_order_cancel_result_item":[
                        {
                            "success":true,
                            "order_id":"22648510111421501",
                            "error_code":"isv.order-status-not-cancelable",
                            "error_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下载

开放平台

闲鱼电商SAAS

alibaba.logistics.idlefish.ship.order.cancel.list (寄件单批量取消)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ