淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
request_param	GetRefundDetailRequest	可选			请求入参
└ hm_sub_order_id String 可选 1234 盒马子单号 └ need_refund_history Boolean 可选 true 是否需要返回退款历史列表 └ reverse_id Number 可选 12345 逆向单id └ channel_source String 可选 JLGO 渠道来源 └ out_user_id String 可选 123 外部用户id └ hm_main_order_id String 可选 1233 盒马主单号 └ third_union_id String 可选 123 微信unionId

名称	类型	示例值	描述
result	Result		接口返回model
└ code String 123 code data GetRefundDetailReverseResponse 1234 返回data └ apply_date Date 2017-12-12 12:12:12 申请时间 └ end_date Date 2017-12-12 12:12:12 结束时间 └ status Number 300 退款状态 └ status_str String 不想要退款状态描述 └ refund_amount Number 1830 退款金额 └ reason_id String 120965 退款原因编号 └ reason_text String 商品漏发退款原因文案 └ memo String 没有发某某商品备注 └ reverse_id Number 123 逆向单号 └ request_id String 123 请求id └ reverse_type Number 1 逆向类型，1:售中逆向 2:售后逆向 3:赔付 └ end_reason String 123 导致退款至终态原因 └ can_refund Boolean true 是否还能发起退款 └ refund_error_remark String 123 不能发起退款时的提示 └ can_cancel Boolean true 能否撤销 refund_history_list RefundHistoryVo [] 退款历史 └ apply_refund_amount Number 123 申请金额 └ actual_refund_amount Number 123 实际退款金额 └ status_str String 123 状态值 └ status Number 123 状态编号 └ refund_type_str String 123 退款类型文案 └ refund_type Number 123 退款类型 └ end_date Date 2021 结束时间 └ reverse_id Number 123 逆向单id attributes Attributes 123 扩展业务属性 └ refund_type String 1 服务类型，1:仅退款，2:仅退货，3:退货退款 └ fetch_appoint_time String 123 团长收货时间 └ reverse_timeout String 123 用户退货至自提点截止时间 ext_view_attributes BaseExtViewVo [] 退款详情表达字段,UI展示所用 └ value String 退货退款键 └ key String 服务类型值 refund_progress_vo RefundProgressVo 退款进度信息 └ description String 123 退款进度描述 └ detailed_description String 123 退款进度详细描述 nodes RefundProgressNodeVo [] 退款进度节点 └ description String 123 节点描述 └ queue_num String 123 节点在退款流程中的排队顺序 └ end_time String 123 节点结束时间 └ apply_return_quantity Number 123 申请退款件数 └ apply_fetch_quantity Number 123 应取退款件数 └ actual_return_quantity Number 123 实际取货件数 └ pay_fee Number 123 支付金额 └ hm_biz_order_id Number 123 业务单号 └ store_id String 123 经营店id └ status_tip String 客服人员会在24小时内处理你的申请退款状态提示 └ success Boolean false 是否成功 └ message String 123 message

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaWdkVerticalNbReverseQueryRequest req = new AlibabaWdkVerticalNbReverseQueryRequest();
AlibabaWdkVerticalNbReverseQueryRequest.GetRefundDetailRequest obj1 = new AlibabaWdkVerticalNbReverseQueryRequest.GetRefundDetailRequest();
obj1.setHmSubOrderId("1234");
obj1.setNeedRefundHistory(true);
obj1.setReverseId(12345L);
obj1.setChannelSource("JLGO");
obj1.setOutUserId("123");
obj1.setHmMainOrderId("1233");
obj1.setThirdUnionId("123");
req.setRequestParam(obj1);
AlibabaWdkVerticalNbReverseQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaWdkVerticalNbReverseQueryRequest req = new AlibabaWdkVerticalNbReverseQueryRequest();
AlibabaWdkVerticalNbReverseQueryRequest.GetRefundDetailRequestDomain obj1 = new AlibabaWdkVerticalNbReverseQueryRequest.GetRefundDetailRequestDomain();
obj1.HmSubOrderId = "1234";
obj1.NeedRefundHistory = true;
obj1.ReverseId = 12345L;
obj1.ChannelSource = "JLGO";
obj1.OutUserId = "123";
obj1.HmMainOrderId = "1233";
obj1.ThirdUnionId = "123";
req.RequestParam_ = obj1;
AlibabaWdkVerticalNbReverseQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaWdkVerticalNbReverseQueryRequest;
$request_param = new GetRefundDetailRequest;
$request_param->hm_sub_order_id="1234";
$request_param->need_refund_history="true";
$request_param->reverse_id="12345";
$request_param->channel_source="JLGO";
$request_param->out_user_id="123";
$request_param->hm_main_order_id="1233";
$request_param->third_union_id="123";
$req->setRequestParam(json_encode($request_param));
$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.wdk.vertical.nb.reverse.query' \
-d 'partner_id=apidoc' \
-d 'sign=C17533129376A569F9034375519ED1A2' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-12-15+03%3A28%3A08' \
-d 'v=2.0' \
-d 'request_param=null'

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

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

req.request_param=""
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.wdk.vertical.nb.reverse.query");
add_param(pRequest,"request_param","数据结构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.wdk.vertical.nb.reverse.query', {
	'request_param':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_wdk_vertical_nb_reverse_query_response>
    <result>
        <code>123</code>
        <data>
            <apply_date>2017-12-12 12:12:12</apply_date>
            <end_date>2017-12-12 12:12:12</end_date>
            <status>300</status>
            <status_str>不想要</status_str>
            <refund_amount>1830</refund_amount>
            <reason_id>120965</reason_id>
            <reason_text>商品漏发</reason_text>
            <memo>没有发某某商品</memo>
            <reverse_id>123</reverse_id>
            <request_id>123</request_id>
            <reverse_type>1</reverse_type>
            <end_reason>123</end_reason>
            <can_refund>true</can_refund>
            <refund_error_remark>123</refund_error_remark>
            <can_cancel>true</can_cancel>
            <refund_history_list>
                <refund_history_vo>
                    <apply_refund_amount>123</apply_refund_amount>
                    <actual_refund_amount>123</actual_refund_amount>
                    <status_str>123</status_str>
                    <status>123</status>
                    <refund_type_str>123</refund_type_str>
                    <refund_type>123</refund_type>
                    <end_date>2021</end_date>
                    <reverse_id>123</reverse_id>
                </refund_history_vo>
            </refund_history_list>
            <attributes>
                <refund_type>1</refund_type>
                <fetch_appoint_time>123</fetch_appoint_time>
                <reverse_timeout>123</reverse_timeout>
            </attributes>
            <ext_view_attributes>
                <base_ext_view_vo>
                    <value>退货退款</value>
                    <key>服务类型</key>
                </base_ext_view_vo>
            </ext_view_attributes>
            <refund_progress_vo>
                <description>123</description>
                <detailed_description>123</detailed_description>
                <nodes>
                    <refund_progress_node_vo>
                        <description>123</description>
                        <queue_num>123</queue_num>
                        <end_time>123</end_time>
                    </refund_progress_node_vo>
                </nodes>
            </refund_progress_vo>
            <apply_return_quantity>123</apply_return_quantity>
            <apply_fetch_quantity>123</apply_fetch_quantity>
            <actual_return_quantity>123</actual_return_quantity>
            <pay_fee>123</pay_fee>
            <hm_biz_order_id>123</hm_biz_order_id>
            <store_id>123</store_id>
            <status_tip>客服人员会在24小时内处理你的申请</status_tip>
        </data>
        <success>false</success>
        <message>123</message>
    </result>
</alibaba_wdk_vertical_nb_reverse_query_response>

{
    "alibaba_wdk_vertical_nb_reverse_query_response":{
        "result":{
            "code":"123",
            "data":{
                "apply_date":"2017-12-12 12:12:12",
                "end_date":"2017-12-12 12:12:12",
                "status":300,
                "status_str":"不想要",
                "refund_amount":1830,
                "reason_id":"120965",
                "reason_text":"商品漏发",
                "memo":"没有发某某商品",
                "reverse_id":123,
                "request_id":"123",
                "reverse_type":1,
                "end_reason":"123",
                "can_refund":true,
                "refund_error_remark":"123",
                "can_cancel":true,
                "refund_history_list":{
                    "refund_history_vo":[
                        {
                            "apply_refund_amount":123,
                            "actual_refund_amount":123,
                            "status_str":"123",
                            "status":123,
                            "refund_type_str":"123",
                            "refund_type":123,
                            "end_date":"2021",
                            "reverse_id":123
                        }
                    ]
                },
                "attributes":{
                    "refund_type":"1",
                    "fetch_appoint_time":"123",
                    "reverse_timeout":"123"
                },
                "ext_view_attributes":{
                    "base_ext_view_vo":[
                        {
                            "value":"退货退款",
                            "key":"服务类型"
                        }
                    ]
                },
                "refund_progress_vo":{
                    "description":"123",
                    "detailed_description":"123",
                    "nodes":{
                        "refund_progress_node_vo":[
                            {
                                "description":"123",
                                "queue_num":"123",
                                "end_time":"123"
                            }
                        ]
                    }
                },
                "apply_return_quantity":123,
                "apply_fetch_quantity":123,
                "actual_return_quantity":123,
                "pay_fee":123,
                "hm_biz_order_id":123,
                "store_id":"123",
                "status_tip":"客服人员会在24小时内处理你的申请"
            },
            "success":false,
            "message":"123"
        }
    }
}

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下载

开放平台

盒马接力go对接API

alibaba.wdk.vertical.nb.reverse.query (盒马查询退款详情)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ