淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
order_cancel_report_request	OrderCancelReportRequest	必须			单据取消回传上报请求
└ warehouse_code String 必须 W1234 仓库编码(统仓统配等无需ERP指定仓储编码的情况填OTHER) └ owner_code String 必须 H1234 货主编码 └ order_code String 必须 O1234 单据编码 └ order_id String 可选 WQ1234 仓储系统单据编码 └ order_type String 可选 JYCK 单据类型(JYCK=一般交易出库单;HHCK= 换货出库;BFCK=补发出库;PTCK=普通出库单;DBCK=调拨出库;B2BRK=B2B入库;B2BCK=B2B出库;QTCK=其他出库;SCRK=生产入库;LYRK=领用入库;CCRK=残次品入库;CGRK=采购入库;DBRK= 调拨入库;QTRK=其他入库;XTRK= 销退入库;THRK=退货入库;HHRK= 换货入库;CNJG= 仓内加工单;CGTH=采购退货出库单) └ cancel_reason String 可选已经退货取消原因 └ extend_props String 可选扩展属性 sub_source_orders SubSourceOrder [] 可选交易平台子订单信息 └ sub_source_order_code String 可选 21324234 交易平台子订单编码 └ request_id String 必须 xxxxxxxx 业务请求ID，用于做幂等 └ request_time Number 必须 1656410207 业务请求时间（时间戳）

名称	类型	示例值	描述
order_cancel_report_response	OrderCancelReportResponse		回传结果
└ trace_id String XXXXXXXXXXX traceId，类似于requestId └ code String XXXX 返回码 └ success Boolean true 成功或者失败 └ message String XXXXXXXXXXX 返回信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaDchainAoxiangWmsOrderCancelRequest req = new AlibabaDchainAoxiangWmsOrderCancelRequest();
AlibabaDchainAoxiangWmsOrderCancelRequest.OrderCancelReportRequest obj1 = new AlibabaDchainAoxiangWmsOrderCancelRequest.OrderCancelReportRequest();
obj1.setWarehouseCode("W1234");
obj1.setOwnerCode("H1234");
obj1.setOrderCode("O1234");
obj1.setOrderId("WQ1234");
obj1.setOrderType("JYCK");
obj1.setCancelReason("已经退货");
obj1.setExtendProps("");
List<AlibabaDchainAoxiangWmsOrderCancelRequest.SubSourceOrder> list3 = new ArrayList<AlibabaDchainAoxiangWmsOrderCancelRequest.SubSourceOrder>();
AlibabaDchainAoxiangWmsOrderCancelRequest.SubSourceOrder obj4 = new AlibabaDchainAoxiangWmsOrderCancelRequest.SubSourceOrder();
list3.add(obj4);
obj4.setSubSourceOrderCode("21324234");
obj1.setSubSourceOrders(list3);
obj1.setRequestId("xxxxxxxx");
obj1.setRequestTime(1656410207L);
req.setOrderCancelReportRequest(obj1);
AlibabaDchainAoxiangWmsOrderCancelResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaDchainAoxiangWmsOrderCancelRequest req = new AlibabaDchainAoxiangWmsOrderCancelRequest();
AlibabaDchainAoxiangWmsOrderCancelRequest.OrderCancelReportRequestDomain obj1 = new AlibabaDchainAoxiangWmsOrderCancelRequest.OrderCancelReportRequestDomain();
obj1.WarehouseCode = "W1234";
obj1.OwnerCode = "H1234";
obj1.OrderCode = "O1234";
obj1.OrderId = "WQ1234";
obj1.OrderType = "JYCK";
obj1.CancelReason = "已经退货";
obj1.ExtendProps = "";
List<AlibabaDchainAoxiangWmsOrderCancelRequest.SubSourceOrderDomain> list3 = new List<AlibabaDchainAoxiangWmsOrderCancelRequest.SubSourceOrderDomain>();
AlibabaDchainAoxiangWmsOrderCancelRequest.SubSourceOrderDomain obj4 = new AlibabaDchainAoxiangWmsOrderCancelRequest.SubSourceOrderDomain();
list3.Add(obj4);
obj4.SubSourceOrderCode = "21324234";
obj1.SubSourceOrders= list3;
obj1.RequestId = "xxxxxxxx";
obj1.RequestTime = 1656410207L;
req.OrderCancelReportRequest_ = obj1;
AlibabaDchainAoxiangWmsOrderCancelResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaDchainAoxiangWmsOrderCancelRequest;
$order_cancel_report_request = new OrderCancelReportRequest;
$order_cancel_report_request->warehouse_code="W1234";
$order_cancel_report_request->owner_code="H1234";
$order_cancel_report_request->order_code="O1234";
$order_cancel_report_request->order_id="WQ1234";
$order_cancel_report_request->order_type="JYCK";
$order_cancel_report_request->cancel_reason="已经退货";
$order_cancel_report_request->extend_props="";
$sub_source_orders = new SubSourceOrder;
$sub_source_orders->sub_source_order_code="21324234";
$order_cancel_report_request->sub_source_orders = $sub_source_orders;
$order_cancel_report_request->request_id="xxxxxxxx";
$order_cancel_report_request->request_time="1656410207";
$req->setOrderCancelReportRequest(json_encode($order_cancel_report_request));
$resp = $c->execute($req);

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.wms.order.cancel' \
-d 'partner_id=apidoc' \
-d 'sign=99A0B71A012FDC45D7E288B036C24785' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-04+16%3A18%3A57' \
-d 'v=2.0' \
-d 'order_cancel_report_request=null'

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

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

req.order_cancel_report_request="数据结构示例JSON格式"
try:
	resp= req.getResponse()
	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.wms.order.cancel");
add_param(pRequest,"order_cancel_report_request","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,NULL);
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.wms.order.cancel', {
	'order_cancel_report_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_dchain_aoxiang_wms_order_cancel_response>
    <order_cancel_report_response>
        <trace_id>XXXXXXXXXXX</trace_id>
        <code>XXXX</code>
        <success>true</success>
        <message>XXXXXXXXXXX</message>
    </order_cancel_report_response>
</alibaba_dchain_aoxiang_wms_order_cancel_response>

{
    "alibaba_dchain_aoxiang_wms_order_cancel_response":{
        "order_cancel_report_response":{
            "trace_id":"XXXXXXXXXXX",
            "code":"XXXX",
            "success":true,
            "message":"XXXXXXXXXXX"
        }
    }
}

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.wms.order.cancel (回传发货单取消通知)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ