淘宝开放平台

请求地址：

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

名称	类型	是否必须	描述
rma_criteria	RmaCriteria	可选	退换货查询条件
└ order_number String 可选 2018062809746929 订单号 └ rma_numbers String [] 可选 VENDOR201806261503089503","VENDOR201806261503089504 退换货单据号 └ end_date Date 可选 2018-06-25 19:00:00 单据创建时间范围：结束时间 └ start_date Date 可选 2018-06-25 14:00:00 单据创建时间范围：开始时间 └ type String 可选 GOODRETURN 单据类型，可选值：退货("GOODRETURN"),换货("GOODEXCHANGE"),仅退款（"RETURN"） └ status String [] 可选 COMPLETED 单据状态，可选值：已创建("CREATED"),已收货同意退款("INBOUND"),已收货不同意退款("NOTINBOUND"),已退款("REFUNDED"),已完成("COMPLETED),已作废("Obsolete") └ out_counter_id String 可选 23422 供应商专柜Id └ counter_id String 可选 234754 银泰专柜Id
paginator	Paginator	可选	分页信息
└ page Number 可选 1 当前页，从1开始 └ page_size Number 可选 20 每页取多少条，每次最多20

名称	类型	示例值	描述
result	ResultDto		结果
data PagedList 结果集 list RmaDTO [] 列表 └ express_no String 20349029303 快递单号 └ express_name String 顺丰速运快递公司名称 └ type String GOODRETURN 单据类型，可选值：GOODRETURN（退货）, GOODEXCHANGE（换货）,仅退款（"RETURN"）; └ status String REFUNDED 单据状态，可选值：CREATED("已创建"), INBOUND("已收货同意退款"), NOTINBOUND("已收货不同意退款"),REFUNDED("已退款"),COMPLETED("已完成"),Obsolete("已作废"); └ last_updated Date 2018-06-30 23:20:12 最后更新时间 └ refund_date Date 2018-06-30 23:20:12 退款时间 └ date_created Date 2018-06-30 09:20:12 创建时间 └ desc String 衣服破洞退/换货原因详情 └ reason String 商品质量问题退/换货原因 └ return_the_way String RETURNTOSTORE 商品寄回方式，可选值：RETURNTOSTORE（到店退）, EXPRESSDELIVERY(邮寄退) rma_items RmaItemDto [] 商品明细 └ product_type String CLONDPRODUCT 商品类型,可选值：普通商品(NORMAL),赠品(GIFT) └ desc String 衣服破洞退/换货原因详情 └ reason String 商品质量问题退/换货原因 └ discount String 0.0000 折扣金额，单位:元 └ price String 239.0770 售价，单位:元 └ quantity String 1.00 数量 └ properties String 颜色:15#/规格:3.5g 商品属性 └ title String 2018女士连衣裙商品标题 └ out_id String 100343223 外部商品Id └ sku_id String 1000033404 商品Id └ actual_amount String 2.0098 实付金额，单位:元 └ disc_code String 唯一码（仅限西有使用） └ settlement_code String 商品编码 └ freight String 0.0000 运费，单位:元 └ amount String 239.0000 金额，单位:元 └ order_number String 2018062809746929 订单号 └ rma_number String VENDOR201806261503089503 单据号 └ refunds String [{"refundNumber":"910b747a-3552-4765-aea0-cfdfedd6af82","paymentSerialNumber":"5485890-67897887","refundCode":"C022","refundDescription":"信用卡","refundAmount":435.00,"currency":null,"reservationNvarchar1":null},{"refundNumber":"e87c0b1d-6224-4b16-aadc-181a96c0bd99","paymentSerialNumber":"6633485021158337","refundCode":"E05","refundDescription":"赠券","refundAmount":5.00,"currency":null,"reservationNvarchar1":null}] 退款资金信息 └ out_counter_id String 供应商专柜Id └ counter_id String 银泰专柜Id └ current_page Number 1 当前页 └ page_size Number 20 取多少条 └ total_count Number 1 总记录数 └ total_page Number 1 总页数 └ sub_code String 状态码 └ sub_msg String 信息 └ success String false 成功标志

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaMosOrderRefundListGetRequest req = new AlibabaMosOrderRefundListGetRequest();
AlibabaMosOrderRefundListGetRequest.RmaCriteria obj1 = new AlibabaMosOrderRefundListGetRequest.RmaCriteria();
obj1.setOrderNumber("2018062809746929");
obj1.setRmaNumbers("VENDOR201806261503089503\",\"VENDOR201806261503089504");
obj1.setEndDate(StringUtils.parseDateTime("2018-06-25 19:00:00"));
obj1.setStartDate(StringUtils.parseDateTime("2018-06-25 14:00:00"));
obj1.setType("GOODRETURN");
obj1.setStatus("COMPLETED");
obj1.setOutCounterId("23422");
obj1.setCounterId("234754");
req.setRmaCriteria(obj1);
AlibabaMosOrderRefundListGetRequest.Paginator obj2 = new AlibabaMosOrderRefundListGetRequest.Paginator();
obj2.setPage(1L);
obj2.setPageSize(20L);
req.setPaginator(obj2);
AlibabaMosOrderRefundListGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaMosOrderRefundListGetRequest req = new AlibabaMosOrderRefundListGetRequest();
AlibabaMosOrderRefundListGetRequest.RmaCriteriaDomain obj1 = new AlibabaMosOrderRefundListGetRequest.RmaCriteriaDomain();
obj1.OrderNumber = "2018062809746929";
obj1.RmaNumbers = "VENDOR201806261503089503\",\"VENDOR201806261503089504";
obj1.EndDate = DateTime.Parse(2018-06-25 19:00:00");
obj1.StartDate = DateTime.Parse(2018-06-25 14:00:00");
obj1.Type = "GOODRETURN";
obj1.Status = "COMPLETED";
obj1.OutCounterId = "23422";
obj1.CounterId = "234754";
req.RmaCriteria_ = obj1;
AlibabaMosOrderRefundListGetRequest.PaginatorDomain obj2 = new AlibabaMosOrderRefundListGetRequest.PaginatorDomain();
obj2.Page = 1L;
obj2.PageSize = 20L;
req.Paginator_ = obj2;
AlibabaMosOrderRefundListGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaMosOrderRefundListGetRequest;
$rma_criteria = new RmaCriteria;
$rma_criteria->order_number="2018062809746929";
$rma_criteria->rma_numbers="VENDOR201806261503089503\",\"VENDOR201806261503089504";
$rma_criteria->end_date="2018-06-25 19:00:00";
$rma_criteria->start_date="2018-06-25 14:00:00";
$rma_criteria->type="GOODRETURN";
$rma_criteria->status="COMPLETED";
$rma_criteria->out_counter_id="23422";
$rma_criteria->counter_id="234754";
$req->setRmaCriteria(json_encode($rma_criteria));
$paginator = new Paginator;
$paginator->page="1";
$paginator->page_size="20";
$req->setPaginator(json_encode($paginator));
$resp = $c->execute($req, $sessionKey);

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.mos.order.refund.list.get' \
-d 'partner_id=apidoc' \
-d 'session=61fd37ce-eb93-438c-b6a8-38d428d353ac' \
-d 'sign=C0AA89BE8F5E04CD4CB8E3F151FC3CF7' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-23+01%3A51%3A10' \
-d 'v=2.0' \
-d 'paginator=null' \
-d 'rma_criteria=null'

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

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

req.rma_criteria=""
req.paginator=""
try:
	resp= req.getResponse(sessionkey)
	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.mos.order.refund.list.get");
add_param(pRequest,"rma_criteria","数据结构JSON示例");
add_param(pRequest,"paginator","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,sessionKey);
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.mos.order.refund.list.get', {
	'rma_criteria':'数据结构JSON示例',
	'paginator':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_mos_order_refund_list_get_response>
    <result>
        <data>
            <list>
                <rma_d_t_o>
                    <express_no>20349029303</express_no>
                    <express_name>顺丰速运</express_name>
                    <type>GOODRETURN</type>
                    <status>REFUNDED</status>
                    <last_updated>2018-06-30 23:20:12</last_updated>
                    <refund_date>2018-06-30 23:20:12</refund_date>
                    <date_created>2018-06-30 09:20:12</date_created>
                    <desc>衣服破洞</desc>
                    <reason>商品质量问题</reason>
                    <return_the_way>RETURNTOSTORE</return_the_way>
                    <rma_items>
                        <rma_item_dto>
                            <product_type>CLONDPRODUCT</product_type>
                            <desc>衣服破洞</desc>
                            <reason>商品质量问题</reason>
                            <discount>0.0000</discount>
                            <price>239.0770</price>
                            <quantity>1.00</quantity>
                            <properties>颜色:15#/规格:3.5g</properties>
                            <title>2018女士连衣裙</title>
                            <out_id>100343223</out_id>
                            <sku_id>1000033404</sku_id>
                            <actual_amount>2.0098</actual_amount>
                            <disc_code></disc_code>
                            <settlement_code></settlement_code>
                        </rma_item_dto>
                    </rma_items>
                    <freight>0.0000</freight>
                    <amount>239.0000</amount>
                    <order_number>2018062809746929</order_number>
                    <rma_number>VENDOR201806261503089503</rma_number>
                    <refunds>[{&quot;refundNumber&quot;:&quot;910b747a-3552-4765-aea0-cfdfedd6af82&quot;,&quot;paymentSerialNumber&quot;:&quot;5485890-67897887&quot;,&quot;refundCode&quot;:&quot;C022&quot;,&quot;refundDescription&quot;:&quot;信用卡&quot;,&quot;refundAmount&quot;:435.00,&quot;currency&quot;:null,&quot;reservationNvarchar1&quot;:null},{&quot;refundNumber&quot;:&quot;e87c0b1d-6224-4b16-aadc-181a96c0bd99&quot;,&quot;paymentSerialNumber&quot;:&quot;6633485021158337&quot;,&quot;refundCode&quot;:&quot;E05&quot;,&quot;refundDescription&quot;:&quot;赠券&quot;,&quot;refundAmount&quot;:5.00,&quot;currency&quot;:null,&quot;reservationNvarchar1&quot;:null}]</refunds>
                    <out_counter_id></out_counter_id>
                    <counter_id></counter_id>
                </rma_d_t_o>
            </list>
            <current_page>1</current_page>
            <page_size>20</page_size>
            <total_count>1</total_count>
            <total_page>1</total_page>
        </data>
        <sub_code></sub_code>
        <sub_msg></sub_msg>
        <success>false</success>
    </result>
</alibaba_mos_order_refund_list_get_response>

{
    "alibaba_mos_order_refund_list_get_response":{
        "result":{
            "data":{
                "list":{
                    "rma_d_t_o":[
                        {
                            "express_no":"20349029303",
                            "express_name":"顺丰速运",
                            "type":"GOODRETURN",
                            "status":"REFUNDED",
                            "last_updated":"2018-06-30 23:20:12",
                            "refund_date":"2018-06-30 23:20:12",
                            "date_created":"2018-06-30 09:20:12",
                            "desc":"衣服破洞",
                            "reason":"商品质量问题",
                            "return_the_way":"RETURNTOSTORE",
                            "rma_items":{
                                "rma_item_dto":[
                                    {
                                        "product_type":"CLONDPRODUCT",
                                        "desc":"衣服破洞",
                                        "reason":"商品质量问题",
                                        "discount":"0.0000",
                                        "price":"239.0770",
                                        "quantity":"1.00",
                                        "properties":"颜色:15#\/规格:3.5g",
                                        "title":"2018女士连衣裙",
                                        "out_id":"100343223",
                                        "sku_id":"1000033404",
                                        "actual_amount":"2.0098",
                                        "disc_code":"",
                                        "settlement_code":""
                                    }
                                ]
                            },
                            "freight":"0.0000",
                            "amount":"239.0000",
                            "order_number":"2018062809746929",
                            "rma_number":"VENDOR201806261503089503",
                            "refunds":"[{\"refundNumber\":\"910b747a-3552-4765-aea0-cfdfedd6af82\",\"paymentSerialNumber\":\"5485890-67897887\",\"refundCode\":\"C022\",\"refundDescription\":\"信用卡\",\"refundAmount\":435.00,\"currency\":null,\"reservationNvarchar1\":null},{\"refundNumber\":\"e87c0b1d-6224-4b16-aadc-181a96c0bd99\",\"paymentSerialNumber\":\"6633485021158337\",\"refundCode\":\"E05\",\"refundDescription\":\"赠券\",\"refundAmount\":5.00,\"currency\":null,\"reservationNvarchar1\":null}]",
                            "out_counter_id":"",
                            "counter_id":""
                        }
                    ]
                },
                "current_page":1,
                "page_size":20,
                "total_count":1,
                "total_page":1
            },
            "sub_code":"",
            "sub_msg":"",
            "success":"false"
        }
    }
}

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"
	}
}

错误码	错误描述	解决方案
500	没有找到符合条件的数据	调整入参

API测试工具错误码查询工具 SDK下载

银泰scm-openapi

alibaba.mos.order.refund.list.get (批量查询交易退货信息)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ