淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
return_order_create_request	ReturnOrderCreateRequest	必须			单据取消参数
return_order ReturnOrder 必须退货单信息 └ return_order_code String 必须 R1234 ERP的退货入库单编码 └ warehouse_code String 必须 W1234 仓库编码(统仓统配等无需ERP指定仓储编码的情况填OTHER) └ order_type String 可选 THRK 单据类型(THRK=退货入库;HHRK=换货入库;只传英文编码) └ order_flag String 可选 1 用字符串格式来表示订单标记列表：比如VISIT^ SELLER_AFFORD^SYNC_RETURN_BILL 等, 中间用“^”来隔开订单标记list (所有字母全部大写) ：VISIT=上门；SELLER_AFFORD=是否卖家承担运费 (默认是) ；SYNC_RETURN_BILL=同时退回发票 └ pre_delivery_order_code String 必须 test002 原出库单号(ERP分配) └ pre_delivery_order_id String 必须 LBX002737152947417 原菜鸟发货单号菜鸟必填 └ logistics_code String 必须 SF 物流公司编码(SF=顺丰、EMS=标准快递、EYB=经济快件、ZJS=宅急送、YTO=圆通、ZTO=中通(ZTO)、HTKY=百世汇通、UC=优速、STO=申通、TTKDEX=天天快递、QFKD=全峰、FAST=快捷、POSTB=邮政小包、GTO=国通、YUNDA=韵达、JD=京东配送、DD=当当宅配、AMAZON=亚马逊物流、OTHER=其他;只传英文编码) └ logistics_name String 可选顺丰物流公司名称 └ express_code String 可选 310000 运单号 └ return_reason String 可选产品失灵退货原因 └ buyer_nick String 可选 nic 买家昵称 └ remark String 可选 1 备注 sender_info SenderInfo 可选发件人信息 └ company String 可选阿里巴巴公司名称菜鸟无此字段，请空值传入 └ name String 必须梁耀中姓名 └ zip_code String 可选 519100 邮编 └ tel String 可选 13191000101 固定电话 └ mobile String 必须 13191000101 移动电话 └ email String 可选 1 电子邮箱菜鸟无此字段，请空值传入 └ country_code String 可选 1 国家二字码菜鸟无此字段，请空值传入 └ province String 必须浙江省省份 └ city String 必须杭州城市 └ area String 可选余杭区区域 └ town String 可选 xxx村村镇 └ detail_address String 必须杭州市余杭区989号详细地址 order_lines OrderLine [] 必须订单信息 └ order_line_no String 必须 426 单据行号 └ source_order_code String 可选 SW-20190816-00003 交易平台订单 └ sub_source_order_code String 可选 1 交易平台子订单编码 └ owner_code String 必须 H1234 货主编码 └ item_code String 必须 I1234 商品编码 └ item_id String 必须 520555845767 菜鸟货品编码菜鸟必填 └ inventory_type String 可选 ZP 库存类型, ZP=正品, CC=残次,JS=机损, XS= 箱损, 默认为ZP └ plan_qty String 必须 11 应发商品数量 └ batch_code String 可选 1 批次编码菜鸟不支持直接指定批次编码出库，支持指定下面批次相关字段 └ product_date String 可选 2019-05-18 生产日期 └ expire_date String 可选 1 过期日期 └ produce_code String 可选 00001 生产批号 └ key String 可选 1 业务流水号

名称	类型	示例值	描述
return_order_create_response	ReturnOrderCreateResponse	COMPLEX	默认描述
└ return_order_id String RID1234 仓储系统退货单编码 └ flag String success 响应结果:success\|failure └ code String 0 响应码 └ message String invalid appkey 响应信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaGscOpenapiEelDeliveryReturnRequest req = new AlibabaGscOpenapiEelDeliveryReturnRequest();
AlibabaGscOpenapiEelDeliveryReturnRequest.ReturnOrderCreateRequest obj1 = new AlibabaGscOpenapiEelDeliveryReturnRequest.ReturnOrderCreateRequest();
AlibabaGscOpenapiEelDeliveryReturnRequest.ReturnOrder obj2 = new AlibabaGscOpenapiEelDeliveryReturnRequest.ReturnOrder();
obj2.setReturnOrderCode("R1234");
obj2.setWarehouseCode("W1234");
obj2.setOrderType("THRK");
obj2.setOrderFlag("1");
obj2.setPreDeliveryOrderCode("test002");
obj2.setPreDeliveryOrderId("LBX002737152947417");
obj2.setLogisticsCode("SF");
obj2.setLogisticsName("顺丰");
obj2.setExpressCode("310000");
obj2.setReturnReason("产品失灵");
obj2.setBuyerNick("nic");
obj2.setRemark("1");
AlibabaGscOpenapiEelDeliveryReturnRequest.SenderInfo obj3 = new AlibabaGscOpenapiEelDeliveryReturnRequest.SenderInfo();
obj3.setCompany("阿里巴巴");
obj3.setName("梁耀中");
obj3.setZipCode("519100");
obj3.setTel("13191000101");
obj3.setMobile("13191000101");
obj3.setEmail("1");
obj3.setCountryCode("1");
obj3.setProvince("浙江省");
obj3.setCity("杭州");
obj3.setArea("余杭区");
obj3.setTown("xxx村");
obj3.setDetailAddress("杭州市余杭区989号");
obj2.setSenderInfo(obj3);
obj1.setReturnOrder(obj2);
List<AlibabaGscOpenapiEelDeliveryReturnRequest.OrderLine> list5 = new ArrayList<AlibabaGscOpenapiEelDeliveryReturnRequest.OrderLine>();
AlibabaGscOpenapiEelDeliveryReturnRequest.OrderLine obj6 = new AlibabaGscOpenapiEelDeliveryReturnRequest.OrderLine();
list5.add(obj6);
obj6.setOrderLineNo("426");
obj6.setSourceOrderCode("SW-20190816-00003");
obj6.setSubSourceOrderCode("1");
obj6.setOwnerCode("H1234");
obj6.setItemCode("I1234");
obj6.setItemId("520555845767");
obj6.setInventoryType("ZP");
obj6.setPlanQty("11");
obj6.setBatchCode("1");
obj6.setProductDate("2019-05-18");
obj6.setExpireDate("1");
obj6.setProduceCode("00001");
obj1.setOrderLines(list5);
obj1.setKey("1");
req.setReturnOrderCreateRequest(obj1);
AlibabaGscOpenapiEelDeliveryReturnResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaGscOpenapiEelDeliveryReturnRequest req = new AlibabaGscOpenapiEelDeliveryReturnRequest();
AlibabaGscOpenapiEelDeliveryReturnRequest.ReturnOrderCreateRequestDomain obj1 = new AlibabaGscOpenapiEelDeliveryReturnRequest.ReturnOrderCreateRequestDomain();
AlibabaGscOpenapiEelDeliveryReturnRequest.ReturnOrderDomain obj2 = new AlibabaGscOpenapiEelDeliveryReturnRequest.ReturnOrderDomain();
obj2.ReturnOrderCode = "R1234";
obj2.WarehouseCode = "W1234";
obj2.OrderType = "THRK";
obj2.OrderFlag = "1";
obj2.PreDeliveryOrderCode = "test002";
obj2.PreDeliveryOrderId = "LBX002737152947417";
obj2.LogisticsCode = "SF";
obj2.LogisticsName = "顺丰";
obj2.ExpressCode = "310000";
obj2.ReturnReason = "产品失灵";
obj2.BuyerNick = "nic";
obj2.Remark = "1";
AlibabaGscOpenapiEelDeliveryReturnRequest.SenderInfoDomain obj3 = new AlibabaGscOpenapiEelDeliveryReturnRequest.SenderInfoDomain();
obj3.Company = "阿里巴巴";
obj3.Name = "梁耀中";
obj3.ZipCode = "519100";
obj3.Tel = "13191000101";
obj3.Mobile = "13191000101";
obj3.Email = "1";
obj3.CountryCode = "1";
obj3.Province = "浙江省";
obj3.City = "杭州";
obj3.Area = "余杭区";
obj3.Town = "xxx村";
obj3.DetailAddress = "杭州市余杭区989号";
obj2.SenderInfo= obj3;
obj1.ReturnOrder= obj2;
List<AlibabaGscOpenapiEelDeliveryReturnRequest.OrderLineDomain> list5 = new List<AlibabaGscOpenapiEelDeliveryReturnRequest.OrderLineDomain>();
AlibabaGscOpenapiEelDeliveryReturnRequest.OrderLineDomain obj6 = new AlibabaGscOpenapiEelDeliveryReturnRequest.OrderLineDomain();
list5.Add(obj6);
obj6.OrderLineNo = "426";
obj6.SourceOrderCode = "SW-20190816-00003";
obj6.SubSourceOrderCode = "1";
obj6.OwnerCode = "H1234";
obj6.ItemCode = "I1234";
obj6.ItemId = "520555845767";
obj6.InventoryType = "ZP";
obj6.PlanQty = "11";
obj6.BatchCode = "1";
obj6.ProductDate = "2019-05-18";
obj6.ExpireDate = "1";
obj6.ProduceCode = "00001";
obj1.OrderLines= list5;
obj1.Key = "1";
req.ReturnOrderCreateRequest_ = obj1;
AlibabaGscOpenapiEelDeliveryReturnResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaGscOpenapiEelDeliveryReturnRequest;
$return_order_create_request = new ReturnOrderCreateRequest;
$return_order = new ReturnOrder;
$return_order->return_order_code="R1234";
$return_order->warehouse_code="W1234";
$return_order->order_type="THRK";
$return_order->order_flag="1";
$return_order->pre_delivery_order_code="test002";
$return_order->pre_delivery_order_id="LBX002737152947417";
$return_order->logistics_code="SF";
$return_order->logistics_name="顺丰";
$return_order->express_code="310000";
$return_order->return_reason="产品失灵";
$return_order->buyer_nick="nic";
$return_order->remark="1";
$sender_info = new SenderInfo;
$sender_info->company="阿里巴巴";
$sender_info->name="梁耀中";
$sender_info->zip_code="519100";
$sender_info->tel="13191000101";
$sender_info->mobile="13191000101";
$sender_info->email="1";
$sender_info->country_code="1";
$sender_info->province="浙江省";
$sender_info->city="杭州";
$sender_info->area="余杭区";
$sender_info->town="xxx村";
$sender_info->detail_address="杭州市余杭区989号";
$return_order->sender_info = $sender_info;
$return_order_create_request->return_order = $return_order;
$order_lines = new OrderLine;
$order_lines->order_line_no="426";
$order_lines->source_order_code="SW-20190816-00003";
$order_lines->sub_source_order_code="1";
$order_lines->owner_code="H1234";
$order_lines->item_code="I1234";
$order_lines->item_id="520555845767";
$order_lines->inventory_type="ZP";
$order_lines->plan_qty="11";
$order_lines->batch_code="1";
$order_lines->product_date="2019-05-18";
$order_lines->expire_date="1";
$order_lines->produce_code="00001";
$return_order_create_request->order_lines = $order_lines;
$return_order_create_request->key="1";
$req->setReturnOrderCreateRequest(json_encode($return_order_create_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.gsc.openapi.eel.delivery.return' \
-d 'partner_id=apidoc' \
-d 'sign=A15C5919BB41CAE08F04F7AEC1E67749' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-27+23%3A15%3A03' \
-d 'v=2.0' \
-d 'return_order_create_request=COMPLEX'

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

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

req.return_order_create_request="COMPLEX"
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.gsc.openapi.eel.delivery.return");
add_param(pRequest,"return_order_create_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.gsc.openapi.eel.delivery.return', {
	'return_order_create_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_gsc_openapi_eel_delivery_return_response>
    <return_order_create_response>
        <return_order_id>RID1234</return_order_id>
        <flag>success</flag>
        <code>0</code>
        <message>invalid appkey</message>
    </return_order_create_response>
</alibaba_gsc_openapi_eel_delivery_return_response>

{
    "alibaba_gsc_openapi_eel_delivery_return_response":{
        "return_order_create_response":{
            "return_order_id":"RID1234",
            "flag":"success",
            "code":"0",
            "message":"invalid appkey"
        }
    }
}

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

alibaba.gsc.openapi.eel.delivery.return (配拦截（销售退货）)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ