淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
cancel_consignorder_request	CancelConsignOrderRequest	必须			取消仓内发货入参
└ warehouse_code String 可选 123456 仓库编码(统仓统配等无需ERP指定仓储编码的情况填OTHER) └ owner_code String 可选 123456 货主编码 └ consign_order_code String 可选 123456 翱象的发货单号（翱象发货单号、交易主单号两个字段必须填一个） └ trade_id String 可选 123456 交易主单号（翱象发货单号、交易主单号两个字段必须填一个） └ sub_trade_ids String [] 可选 [1234567,2345678] 交易子单号 └ cancel_reason String 可选用户发起部分退款取消原因 └ extend_props String 可选 {"xxx":"xxx"} 扩展属性 └ request_time Number 必须 1639123068000 业务请求时间 └ request_id String 必须 xxx 业务请求Id，用于幂等

名称	类型	示例值	描述
cancel_consignorder_response	CancelConsignOrderResponse		返回结果
└ success Boolean true 成功或者失败 └ message String xxx 返回信息 └ code String xxx 返回信息码

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaDchainAoxiangConsignorderCancelRequest req = new AlibabaDchainAoxiangConsignorderCancelRequest();
AlibabaDchainAoxiangConsignorderCancelRequest.CancelConsignOrderRequest obj1 = new AlibabaDchainAoxiangConsignorderCancelRequest.CancelConsignOrderRequest();
obj1.setWarehouseCode("123456");
obj1.setOwnerCode("123456");
obj1.setConsignOrderCode("123456");
obj1.setTradeId("123456");
obj1.setSubTradeIds("1234567,2345678");
obj1.setCancelReason("用户发起部分退款");
obj1.setExtendProps("{\"xxx\":\"xxx\"}");
obj1.setRequestTime(1639123068000L);
obj1.setRequestId("xxx");
req.setCancelConsignorderRequest(obj1);
AlibabaDchainAoxiangConsignorderCancelResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaDchainAoxiangConsignorderCancelRequest req = new AlibabaDchainAoxiangConsignorderCancelRequest();
AlibabaDchainAoxiangConsignorderCancelRequest.CancelConsignOrderRequestDomain obj1 = new AlibabaDchainAoxiangConsignorderCancelRequest.CancelConsignOrderRequestDomain();
obj1.WarehouseCode = "123456";
obj1.OwnerCode = "123456";
obj1.ConsignOrderCode = "123456";
obj1.TradeId = "123456";
obj1.SubTradeIds = "1234567,2345678";
obj1.CancelReason = "用户发起部分退款";
obj1.ExtendProps = "{\"xxx\":\"xxx\"}";
obj1.RequestTime = 1639123068000L;
obj1.RequestId = "xxx";
req.CancelConsignorderRequest_ = obj1;
AlibabaDchainAoxiangConsignorderCancelResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaDchainAoxiangConsignorderCancelRequest;
$cancel_consignorder_request = new CancelConsignOrderRequest;
$cancel_consignorder_request->warehouse_code="123456";
$cancel_consignorder_request->owner_code="123456";
$cancel_consignorder_request->consign_order_code="123456";
$cancel_consignorder_request->trade_id="123456";
$cancel_consignorder_request->sub_trade_ids="[1234567,2345678]";
$cancel_consignorder_request->cancel_reason="用户发起部分退款";
$cancel_consignorder_request->extend_props="{\"xxx\":\"xxx\"}";
$cancel_consignorder_request->request_time="1639123068000";
$cancel_consignorder_request->request_id="xxx";
$req->setCancelConsignorderRequest(json_encode($cancel_consignorder_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.dchain.aoxiang.consignorder.cancel' \
-d 'partner_id=apidoc' \
-d 'session=9e7d3523-5fb7-43a3-b061-da71fd5d461d' \
-d 'sign=BD262B99970F611E22B42A1FCFB84878' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-04+15%3A50%3A59' \
-d 'v=2.0' \
-d 'cancel_consignorder_request=null'

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

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

req.cancel_consignorder_request="数据结构示例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.dchain.aoxiang.consignorder.cancel");
add_param(pRequest,"cancel_consignorder_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',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('alibaba.dchain.aoxiang.consignorder.cancel', {
	'cancel_consignorder_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_dchain_aoxiang_consignorder_cancel_response>
    <cancel_consignorder_response>
        <success>true</success>
        <message>xxx</message>
        <code>xxx</code>
    </cancel_consignorder_response>
</alibaba_dchain_aoxiang_consignorder_cancel_response>

{
    "alibaba_dchain_aoxiang_consignorder_cancel_response":{
        "cancel_consignorder_response":{
            "success":true,
            "message":"xxx",
            "code":"xxx"
        }
    }
}

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.dchain.aoxiang.consignorder.cancel (自动流转单据取消仓内发货)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ