淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
returnWarehouseBill	ReturnWarehouseBill	必须			退仓单
└ returnWarehouseBillId String 必须 2343243241 退仓单号 └ warehouseCode String 必须 DRF1102 仓编码 └ sourceMerchantCode String 必须 DARUNFA 来源商家编码 └ sourceNodeCode String 必须 UDDRF1001 来源配送站编码\仓编码(若存在配送站，给配送站编码；若不存在配送站，给仓编码) └ contactInfo String 可选手机号：3334443434 联系方式 └ remark String 可选退仓备注 └ isTest Boolean 必须 true 是否测试单 └ containerList String [] 必须容器列表 └ isVirtual Boolean 必须 false 是否是虚拟退仓单 skuInfoList ReverseSkuInfo [] 必须子单列表 └ reverseFulfillOrderId String 必须 4352345 逆向履约主单号 └ reverseFulfillSubOrderId String 必须 2341241324 逆向履约子单号 └ relatedFulfillOrderId String 必须 13423324 关联的正向履约单号 └ relatedFulfillSubOrderId String 必须 2435345345 关联的正向履约子单号 └ relatedSourceOrderId String 必须 4563345654 关联的正向淘系交易主单号 └ relatedSubSourceOrderId String 必须 34546436 关联的正向淘系交易子单号 └ relatedBizOrderId String 可选 3454354 关联的正向盒马交易主单号 └ relatedSubBizOrderId String 必须 324535345 关联的正向盒马交易子单号 └ reverseSaleOrderCode String 可选 5464536345 盒马逆向退货单号 └ refundId String 可选 43534 退款单号 └ orderChannel String 必须 APP 销售渠道："POS"，"APP" └ reverseOrderSource String 必须 AFTER_SALE 逆向单来源： 1,AFTER_SALE （售后退货）; 2,IN_SALE（售中取消）; └ skuCode String 必须 100344 商品编码 └ skuName String 必须可口可乐商品名称 └ stockUnit String 必须瓶库存单位 └ isStandardSku Boolean 必须 true 是否是标品：true（“标品”），false（“非标品”） └ refundStockQuantity String 必须 10 退款数量（库存单位） └ shouldFetchStockQuantity String 必须 10 应取数量（库存单位） └ enterDockStockQuantity String 必须 8 入站数量（库存单位） └ returnBoundStockQuantity String 必须 6 退仓数量（库存单位） └ customerLossStockQuantity String 必须 0 客损数量（库存单位）：退款数量-应取数量 └ riderLossStockQuantity String 必须 2 骑手损数量（库存单位）：应取数量-入站数量 └ deliveryLossStockQuantity String 必须 2 站损数量（库存单位）：入站数量-退仓数量 └ sourceSellerId String 可选 725677994 卖家id └ attribute String 可选 {"name":"zhangsan"} 扩展属性，json串 └ attribute String 可选 {"name":"zhangsan"} 扩展属性，json串

名称	类型	示例值	描述
success	Boolean	true	调用是否成功
errorCode	String	SYSTEM_ERROR	错误码
errorDesc	String	系统异常	返回码含义描述

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

QimenCloudClient client = new DefaultQimenCloudClient(url, appkey, secret);
AlibabaCainaoWhcFulfillDoReturnWarehouseTaskRequest req = new AlibabaCainaoWhcFulfillDoReturnWarehouseTaskRequest();
AlibabaCainaoWhcFulfillDoReturnWarehouseTaskRequest.ReturnWarehouseBill obj1 = new AlibabaCainaoWhcFulfillDoReturnWarehouseTaskRequest.ReturnWarehouseBill();
obj1.setReturnWarehouseBillId("2343243241");
obj1.setWarehouseCode("DRF1102");
obj1.setSourceMerchantCode("DARUNFA");
obj1.setSourceNodeCode("UDDRF1001");
obj1.setContactInfo("手机号：3334443434");
obj1.setRemark("退仓");
obj1.setIsTest(true);
obj1.setContainerList("");
obj1.setIsVirtual(false);
List<AlibabaCainaoWhcFulfillDoReturnWarehouseTaskRequest.ReverseSkuInfo> list3 = new ArrayList<AlibabaCainaoWhcFulfillDoReturnWarehouseTaskRequest.ReverseSkuInfo>();
AlibabaCainaoWhcFulfillDoReturnWarehouseTaskRequest.ReverseSkuInfo obj4 = new AlibabaCainaoWhcFulfillDoReturnWarehouseTaskRequest.ReverseSkuInfo();
list3.add(obj4);
obj4.setReverseFulfillOrderId("4352345");
obj4.setReverseFulfillSubOrderId("2341241324");
obj4.setRelatedFulfillOrderId("13423324");
obj4.setRelatedFulfillSubOrderId("2435345345");
obj4.setRelatedSourceOrderId("4563345654");
obj4.setRelatedSubSourceOrderId("34546436");
obj4.setRelatedBizOrderId("3454354");
obj4.setRelatedSubBizOrderId("324535345");
obj4.setReverseSaleOrderCode("5464536345");
obj4.setRefundId("43534");
obj4.setOrderChannel("APP");
obj4.setReverseOrderSource("AFTER_SALE");
obj4.setSkuCode("100344");
obj4.setSkuName("可口可乐");
obj4.setStockUnit("瓶");
obj4.setIsStandardSku(true);
obj4.setRefundStockQuantity("10");
obj4.setShouldFetchStockQuantity("10");
obj4.setEnterDockStockQuantity("8");
obj4.setReturnBoundStockQuantity("6");
obj4.setCustomerLossStockQuantity("0");
obj4.setRiderLossStockQuantity("2");
obj4.setDeliveryLossStockQuantity("2");
obj4.setSourceSellerId("725677994");
obj4.setAttribute("{\"name\":\"zhangsan\"}");
obj1.setSkuInfoList(list3);
obj1.setAttribute("{\"name\":\"zhangsan\"}");
req.setReturnWarehouseBill(obj1);
AlibabaCainaoWhcFulfillDoReturnWarehouseTaskResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaCainaoWhcFulfillDoReturnWarehouseTaskRequest req = new AlibabaCainaoWhcFulfillDoReturnWarehouseTaskRequest();
AlibabaCainaoWhcFulfillDoReturnWarehouseTaskRequest.ReturnWarehouseBillDomain obj1 = new AlibabaCainaoWhcFulfillDoReturnWarehouseTaskRequest.ReturnWarehouseBillDomain();
obj1.ReturnWarehouseBillId = "2343243241";
obj1.WarehouseCode = "DRF1102";
obj1.SourceMerchantCode = "DARUNFA";
obj1.SourceNodeCode = "UDDRF1001";
obj1.ContactInfo = "手机号：3334443434";
obj1.Remark = "退仓";
obj1.IsTest = true;
obj1.ContainerList = "";
obj1.IsVirtual = false;
List<AlibabaCainaoWhcFulfillDoReturnWarehouseTaskRequest.ReverseSkuInfoDomain> list3 = new List<AlibabaCainaoWhcFulfillDoReturnWarehouseTaskRequest.ReverseSkuInfoDomain>();
AlibabaCainaoWhcFulfillDoReturnWarehouseTaskRequest.ReverseSkuInfoDomain obj4 = new AlibabaCainaoWhcFulfillDoReturnWarehouseTaskRequest.ReverseSkuInfoDomain();
list3.Add(obj4);
obj4.ReverseFulfillOrderId = "4352345";
obj4.ReverseFulfillSubOrderId = "2341241324";
obj4.RelatedFulfillOrderId = "13423324";
obj4.RelatedFulfillSubOrderId = "2435345345";
obj4.RelatedSourceOrderId = "4563345654";
obj4.RelatedSubSourceOrderId = "34546436";
obj4.RelatedBizOrderId = "3454354";
obj4.RelatedSubBizOrderId = "324535345";
obj4.ReverseSaleOrderCode = "5464536345";
obj4.RefundId = "43534";
obj4.OrderChannel = "APP";
obj4.ReverseOrderSource = "AFTER_SALE";
obj4.SkuCode = "100344";
obj4.SkuName = "可口可乐";
obj4.StockUnit = "瓶";
obj4.IsStandardSku = true;
obj4.RefundStockQuantity = "10";
obj4.ShouldFetchStockQuantity = "10";
obj4.EnterDockStockQuantity = "8";
obj4.ReturnBoundStockQuantity = "6";
obj4.CustomerLossStockQuantity = "0";
obj4.RiderLossStockQuantity = "2";
obj4.DeliveryLossStockQuantity = "2";
obj4.SourceSellerId = "725677994";
obj4.Attribute = "{\"name\":\"zhangsan\"}";
obj1.SkuInfoList= list3;
obj1.Attribute = "{\"name\":\"zhangsan\"}";
req.ReturnWarehouseBill_ = obj1;
AlibabaCainaoWhcFulfillDoReturnWarehouseTaskResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaCainaoWhcFulfillDoReturnWarehouseTaskRequest;
$returnWarehouseBill = new ReturnWarehouseBill;
$returnWarehouseBill->return_warehouse_bill_id="2343243241";
$returnWarehouseBill->warehouse_code="DRF1102";
$returnWarehouseBill->source_merchant_code="DARUNFA";
$returnWarehouseBill->source_node_code="UDDRF1001";
$returnWarehouseBill->contact_info="手机号：3334443434";
$returnWarehouseBill->remark="退仓";
$returnWarehouseBill->is_test="true";
$returnWarehouseBill->container_list="";
$returnWarehouseBill->is_virtual="false";
$skuInfoList = new ReverseSkuInfo;
$skuInfoList->reverse_fulfill_order_id="4352345";
$skuInfoList->reverse_fulfill_sub_order_id="2341241324";
$skuInfoList->related_fulfill_order_id="13423324";
$skuInfoList->related_fulfill_sub_order_id="2435345345";
$skuInfoList->related_source_order_id="4563345654";
$skuInfoList->related_sub_source_order_id="34546436";
$skuInfoList->related_biz_order_id="3454354";
$skuInfoList->related_sub_biz_order_id="324535345";
$skuInfoList->reverse_sale_order_code="5464536345";
$skuInfoList->refund_id="43534";
$skuInfoList->order_channel="APP";
$skuInfoList->reverse_order_source="AFTER_SALE";
$skuInfoList->sku_code="100344";
$skuInfoList->sku_name="可口可乐";
$skuInfoList->stock_unit="瓶";
$skuInfoList->is_standard_sku="true";
$skuInfoList->refund_stock_quantity="10";
$skuInfoList->should_fetch_stock_quantity="10";
$skuInfoList->enter_dock_stock_quantity="8";
$skuInfoList->return_bound_stock_quantity="6";
$skuInfoList->customer_loss_stock_quantity="0";
$skuInfoList->rider_loss_stock_quantity="2";
$skuInfoList->delivery_loss_stock_quantity="2";
$skuInfoList->source_seller_id="725677994";
$skuInfoList->attribute="{\"name\":\"zhangsan\"}";
$returnWarehouseBill->skuInfoList = $skuInfoList;
$returnWarehouseBill->attribute="{\"name\":\"zhangsan\"}";
$req->setReturnWarehouseBill(json_encode($returnWarehouseBill));
$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=qimen.alibaba.cainao.whc.fulfill.do.return.warehouse.task' \
-d 'partner_id=apidoc' \
-d 'sign=360E406F69A96DCFA0C121C8509476D2' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-02+09%3A13%3A41' \
-d 'v=2.0' \
-d 'returnWarehouseBill=null'

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

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

req.returnWarehouseBill="数据结构示例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,"qimen.alibaba.cainao.whc.fulfill.do.return.warehouse.task");
add_param(pRequest,"returnWarehouseBill","数据结构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('qimen.alibaba.cainao.whc.fulfill.do.return.warehouse.task', {
	'returnWarehouseBill':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<success>true</success>
<errorCode>SYSTEM_ERROR</errorCode>
<errorDesc>系统异常</errorDesc>

{
    "success":true,
    "errorCode":"SYSTEM_ERROR",
    "errorDesc":"系统异常"
}

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

qimen.alibaba.cainao.whc.fulfill.do.return.warehouse.task (退仓单下发)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ