淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
param0	ErpReturnOrderDto	可选			1
└ warehouse_code String 可选 SJ701 1 └ original_bill_code String 可选 o22 1 └ remark String 可选 11 1 └ source_system Number 可选 0 1 item_list ErpReturnOrderDetailDto [] 可选 1 └ remark String 可选 1 1 └ reason String 可选不要 1 └ unit String 可选件 1 └ inventory_unit String 可选盒 1 └ spec String 可选 15 1 └ dept_code String 可选 SANJ 1 └ price String 可选 11 1 └ count String 可选 15 1 └ produce_date Date 可选 2017-02-01 01:01:01 1 └ item_code String 可选 010100203768 1 └ supplier_code String 可选 SANJ 1 └ return_date Date 可选 2017-04-01 01:01:01 1 └ return_type Number 可选 1 1 └ biz_order_code String 可选 b22 1

名称	类型	示例值	描述
result	UtmsResult	1	result
└ model String 1 model └ success Boolean 1 success └ msg String 1 msg └ code String 1 code

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
WdkWmsgatewayOrderReturnaddRequest req = new WdkWmsgatewayOrderReturnaddRequest();
WdkWmsgatewayOrderReturnaddRequest.ErpReturnOrderDto obj1 = new WdkWmsgatewayOrderReturnaddRequest.ErpReturnOrderDto();
obj1.setWarehouseCode("SJ701");
obj1.setOriginalBillCode("o22");
obj1.setRemark("11");
obj1.setSourceSystem(0L);
List<WdkWmsgatewayOrderReturnaddRequest.ErpReturnOrderDetailDto> list3 = new ArrayList<WdkWmsgatewayOrderReturnaddRequest.ErpReturnOrderDetailDto>();
WdkWmsgatewayOrderReturnaddRequest.ErpReturnOrderDetailDto obj4 = new WdkWmsgatewayOrderReturnaddRequest.ErpReturnOrderDetailDto();
list3.add(obj4);
obj4.setRemark("1");
obj4.setReason("不要");
obj4.setUnit("件");
obj4.setInventoryUnit("盒");
obj4.setSpec("15");
obj4.setDeptCode("SANJ");
obj4.setPrice("11");
obj4.setCount("15");
obj4.setProduceDate(StringUtils.parseDateTime("2017-02-01 01:01:01"));
obj4.setItemCode("010100203768");
obj1.setItemList(list3);
obj1.setSupplierCode("SANJ");
obj1.setReturnDate(StringUtils.parseDateTime("2017-04-01 01:01:01"));
obj1.setReturnType(1L);
obj1.setBizOrderCode("b22");
req.setParam0(obj1);
WdkWmsgatewayOrderReturnaddResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
WdkWmsgatewayOrderReturnaddRequest req = new WdkWmsgatewayOrderReturnaddRequest();
WdkWmsgatewayOrderReturnaddRequest.ErpReturnOrderDtoDomain obj1 = new WdkWmsgatewayOrderReturnaddRequest.ErpReturnOrderDtoDomain();
obj1.WarehouseCode = "SJ701";
obj1.OriginalBillCode = "o22";
obj1.Remark = "11";
obj1.SourceSystem = 0L;
List<WdkWmsgatewayOrderReturnaddRequest.ErpReturnOrderDetailDtoDomain> list3 = new List<WdkWmsgatewayOrderReturnaddRequest.ErpReturnOrderDetailDtoDomain>();
WdkWmsgatewayOrderReturnaddRequest.ErpReturnOrderDetailDtoDomain obj4 = new WdkWmsgatewayOrderReturnaddRequest.ErpReturnOrderDetailDtoDomain();
list3.Add(obj4);
obj4.Remark = "1";
obj4.Reason = "不要";
obj4.Unit = "件";
obj4.InventoryUnit = "盒";
obj4.Spec = "15";
obj4.DeptCode = "SANJ";
obj4.Price = "11";
obj4.Count = "15";
obj4.ProduceDate = DateTime.Parse(2017-02-01 01:01:01");
obj4.ItemCode = "010100203768";
obj1.ItemList= list3;
obj1.SupplierCode = "SANJ";
obj1.ReturnDate = DateTime.Parse(2017-04-01 01:01:01");
obj1.ReturnType = 1L;
obj1.BizOrderCode = "b22";
req.Param0_ = obj1;
WdkWmsgatewayOrderReturnaddResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new WdkWmsgatewayOrderReturnaddRequest;
$param0 = new ErpReturnOrderDto;
$param0->warehouse_code="SJ701";
$param0->original_bill_code="o22";
$param0->remark="11";
$param0->source_system="0";
$item_list = new ErpReturnOrderDetailDto;
$item_list->remark="1";
$item_list->reason="不要";
$item_list->unit="件";
$item_list->inventory_unit="盒";
$item_list->spec="15";
$item_list->dept_code="SANJ";
$item_list->price="11";
$item_list->count="15";
$item_list->produce_date="2017-02-01 01:01:01";
$item_list->item_code="010100203768";
$param0->item_list = $item_list;
$param0->supplier_code="SANJ";
$param0->return_date="2017-04-01 01:01:01";
$param0->return_type="1";
$param0->biz_order_code="b22";
$req->setParam0(json_encode($param0));
$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=taobao.wdk.wmsgateway.order.returnadd' \
-d 'partner_id=apidoc' \
-d 'sign=E5E24F86CDD5F8EAD7D90D461005AA4D' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-21+18%3A09%3A28' \
-d 'v=2.0' \
-d 'param0=null'

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

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

req.param0=""
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,"taobao.wdk.wmsgateway.order.returnadd");
add_param(pRequest,"param0","数据结构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('taobao.wdk.wmsgateway.order.returnadd', {
	'param0':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<wdk_wmsgateway_order_returnadd_response>
    <result>
        <model>1</model>
        <success>1</success>
        <msg>1</msg>
        <code>1</code>
    </result>
</wdk_wmsgateway_order_returnadd_response>

{
    "wdk_wmsgateway_order_returnadd_response":{
        "result":{
            "model":"1",
            "success":1,
            "msg":"1",
            "code":"1"
        }
    }
}

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

taobao.wdk.wmsgateway.order.returnadd (三江退货单)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ