淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
param_rtn_top_d_t_o	RtnTopDto	可选			退货单
└ creator String 可选 181768 创建人 └ do_number String 可选 DO1000001431 发货单号(按照) └ no_approval_required Boolean 可选 true 是否免审 └ rcv_number String 可选按照接收单退货时必填接收单号 └ remark String 必须退货原因xxx 退货原因 rtn_item_dto_list RtnItemTopDto [] 可选退货明细 └ biz_code String 可选按照订单退货时必填业务单号 └ biz_type String 可选 ORDER 业务类型 └ delivery_item_id Number 可选 100000375 发货明细行id └ item_id String 可选按照订单退货时必填订单明细id └ quantity String 可选 0.01 退货数量/金额 └ source_type String 可选 ELE 来源类型 └ tenant_id Number 可选 10000 租户id

名称	类型	示例值	描述

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaPurRtnCreateRequest req = new AlibabaPurRtnCreateRequest();
AlibabaPurRtnCreateRequest.RtnTopDto obj1 = new AlibabaPurRtnCreateRequest.RtnTopDto();
obj1.setCreator("181768");
obj1.setDoNumber("DO1000001431");
obj1.setNoApprovalRequired(true);
obj1.setRcvNumber("按照接收单退货时必填");
obj1.setRemark("退货原因xxx");
List<AlibabaPurRtnCreateRequest.RtnItemTopDto> list3 = new ArrayList<AlibabaPurRtnCreateRequest.RtnItemTopDto>();
AlibabaPurRtnCreateRequest.RtnItemTopDto obj4 = new AlibabaPurRtnCreateRequest.RtnItemTopDto();
list3.add(obj4);
obj4.setBizCode("按照订单退货时必填");
obj4.setBizType("ORDER");
obj4.setDeliveryItemId(100000375L);
obj4.setItemId("按照订单退货时必填");
obj4.setQuantity("0.01");
obj1.setRtnItemDtoList(list3);
obj1.setSourceType("ELE");
obj1.setTenantId(10000L);
req.setParamRtnTopDTO(obj1);
AlibabaPurRtnCreateResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaPurRtnCreateRequest req = new AlibabaPurRtnCreateRequest();
AlibabaPurRtnCreateRequest.RtnTopDtoDomain obj1 = new AlibabaPurRtnCreateRequest.RtnTopDtoDomain();
obj1.Creator = "181768";
obj1.DoNumber = "DO1000001431";
obj1.NoApprovalRequired = true;
obj1.RcvNumber = "按照接收单退货时必填";
obj1.Remark = "退货原因xxx";
List<AlibabaPurRtnCreateRequest.RtnItemTopDtoDomain> list3 = new List<AlibabaPurRtnCreateRequest.RtnItemTopDtoDomain>();
AlibabaPurRtnCreateRequest.RtnItemTopDtoDomain obj4 = new AlibabaPurRtnCreateRequest.RtnItemTopDtoDomain();
list3.Add(obj4);
obj4.BizCode = "按照订单退货时必填";
obj4.BizType = "ORDER";
obj4.DeliveryItemId = 100000375L;
obj4.ItemId = "按照订单退货时必填";
obj4.Quantity = "0.01";
obj1.RtnItemDtoList= list3;
obj1.SourceType = "ELE";
obj1.TenantId = 10000L;
req.ParamRtnTopDTO_ = obj1;
AlibabaPurRtnCreateResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaPurRtnCreateRequest;
$param_rtn_top_d_t_o = new RtnTopDto;
$param_rtn_top_d_t_o->creator="181768";
$param_rtn_top_d_t_o->do_number="DO1000001431";
$param_rtn_top_d_t_o->no_approval_required="true";
$param_rtn_top_d_t_o->rcv_number="按照接收单退货时必填";
$param_rtn_top_d_t_o->remark="退货原因xxx";
$rtn_item_dto_list = new RtnItemTopDto;
$rtn_item_dto_list->biz_code="按照订单退货时必填";
$rtn_item_dto_list->biz_type="ORDER";
$rtn_item_dto_list->delivery_item_id="100000375";
$rtn_item_dto_list->item_id="按照订单退货时必填";
$rtn_item_dto_list->quantity="0.01";
$param_rtn_top_d_t_o->rtn_item_dto_list = $rtn_item_dto_list;
$param_rtn_top_d_t_o->source_type="ELE";
$param_rtn_top_d_t_o->tenant_id="10000";
$req->setParamRtnTopDTO(json_encode($param_rtn_top_d_t_o));
$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.pur.rtn.create' \
-d 'partner_id=apidoc' \
-d 'sign=5E03A87AB697F89A9DEEEC181A064C54' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-16+17%3A43%3A36' \
-d 'v=2.0' \
-d 'param_rtn_top_d_t_o=null'

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

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

req.param_rtn_top_d_t_o=""
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.pur.rtn.create");
add_param(pRequest,"param_rtn_top_d_t_o","数据结构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.pur.rtn.create', {
	'param_rtn_top_d_t_o':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_pur_rtn_create_response>
</alibaba_pur_rtn_create_response>

{
    "alibaba_pur_rtn_create_response":{
    }
}

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.pur.rtn.create (创建退货单)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ