阿里安全开放平台-阿里聚安全

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
external_refund_order_render_request	ExternalRefundOrderRenderRequest	必须			退款创单前渲染参数查询
└ sub_sale_order_no String 必须 111117667898 正向分销子单号 └ sale_order_no String 必须 111117667898 正向分销主单号 └ buyer_goods_status Number 可选 1 买家货物状态 1. 未发货 * 2. 未收到货 3. 已收到货 └ outer_refund_type Number 可选 1 退款类型 1.仅退款 2.退货退款(货物已到消费者手里了,需要把货物邮寄给商家)

名称	类型	示例值	描述
trace_id	String	2133ecbf17538602446853578e26d5	traceId
retriable	Boolean	false	retriable
biz_success	Boolean	true	success
module	ExternalRefundOrderRenderResponse		module
render_detail ExternalRefundOrderRenderCombineWrapperDTO [] 退款渲染结果列表 refund_type_render_detail ExternalRefundOrderRenderCombineItemWrapperDTO [] 退款渲染结果按照退款类型聚合列表 reason_detail ExternalRefundApplyReasonItemDTO [] 支持的退款原因列表 └ outer_reason_id Number 16 退款申请原因id └ outer_reason_name String 商品变质/发霉/有异物退款申请原因名称 └ need_offer_pic Boolean false 是否需要提供举证图片 └ buyer_goods_status Number 2 退款类型 1.仅退款 2.退货退款(货物已到消费者手里了,需要把货物邮寄给商家) └ max_refund_fee Number 100 最大可申请的退款金额，单位为分 └ min_refund_fee Number 1 最小可申请的退款金额，单位为分 └ outer_refund_type Number 2 买家货物状态 1. 未发货 * 2. 未收到货 3. 已收到货
biz_error_message	String	系统异常	执行失败的错误原因
biz_error_code	String	system_exception	执行失败的错误码

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAscpChannelSubRefundRenderQueryRequest req = new AlibabaAscpChannelSubRefundRenderQueryRequest();
AlibabaAscpChannelSubRefundRenderQueryRequest.ExternalRefundOrderRenderRequest obj1 = new AlibabaAscpChannelSubRefundRenderQueryRequest.ExternalRefundOrderRenderRequest();
obj1.setSubSaleOrderNo("111117667898");
obj1.setSaleOrderNo("111117667898");
obj1.setBuyerGoodsStatus(1L);
obj1.setOuterRefundType(1L);
req.setExternalRefundOrderRenderRequest(obj1);
AlibabaAscpChannelSubRefundRenderQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAscpChannelSubRefundRenderQueryRequest req = new AlibabaAscpChannelSubRefundRenderQueryRequest();
AlibabaAscpChannelSubRefundRenderQueryRequest.ExternalRefundOrderRenderRequestDomain obj1 = new AlibabaAscpChannelSubRefundRenderQueryRequest.ExternalRefundOrderRenderRequestDomain();
obj1.SubSaleOrderNo = "111117667898";
obj1.SaleOrderNo = "111117667898";
obj1.BuyerGoodsStatus = 1L;
obj1.OuterRefundType = 1L;
req.ExternalRefundOrderRenderRequest_ = obj1;
AlibabaAscpChannelSubRefundRenderQueryResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAscpChannelSubRefundRenderQueryRequest;
$external_refund_order_render_request = new ExternalRefundOrderRenderRequest;
$external_refund_order_render_request->sub_sale_order_no="111117667898";
$external_refund_order_render_request->sale_order_no="111117667898";
$external_refund_order_render_request->buyer_goods_status="1";
$external_refund_order_render_request->outer_refund_type="1";
$req->setExternalRefundOrderRenderRequest(json_encode($external_refund_order_render_request));
$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.ascp.channel.sub.refund.render.query' \
-d 'partner_id=apidoc' \
-d 'session=f8aee6e7-b49b-4c6c-934c-4c7dc706f88f' \
-d 'sign=29742022FC8F9CB825E1276A5CCB87EA' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-08-23+23%3A05%3A19' \
-d 'v=2.0' \
-d 'external_refund_order_render_request=null'

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

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

req.external_refund_order_render_request="数据结构示例JSON格式"
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.ascp.channel.sub.refund.render.query");
add_param(pRequest,"external_refund_order_render_request","数据结构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.ascp.channel.sub.refund.render.query', {
	'external_refund_order_render_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_ascp_channel_sub_refund_render_query_response>
    <trace_id>2133ecbf17538602446853578e26d5</trace_id>
    <retriable>false</retriable>
    <biz_success>true</biz_success>
    <module>
        <render_detail>
            <external_refund_order_render_combine_wrapper_d_t_o>
                <refund_type_render_detail>
                    <external_refund_order_render_combine_item_wrapper_d_t_o>
                        <reason_detail>
                            <external_refund_apply_reason_item_d_t_o>
                                <outer_reason_id>16</outer_reason_id>
                                <outer_reason_name>商品变质/发霉/有异物</outer_reason_name>
                                <need_offer_pic>false</need_offer_pic>
                            </external_refund_apply_reason_item_d_t_o>
                        </reason_detail>
                        <buyer_goods_status>2</buyer_goods_status>
                        <max_refund_fee>100</max_refund_fee>
                        <min_refund_fee>1</min_refund_fee>
                    </external_refund_order_render_combine_item_wrapper_d_t_o>
                </refund_type_render_detail>
                <outer_refund_type>2</outer_refund_type>
            </external_refund_order_render_combine_wrapper_d_t_o>
        </render_detail>
    </module>
    <biz_error_message>系统异常</biz_error_message>
    <biz_error_code>system_exception</biz_error_code>
</alibaba_ascp_channel_sub_refund_render_query_response>

{
    "alibaba_ascp_channel_sub_refund_render_query_response":{
        "trace_id":"2133ecbf17538602446853578e26d5",
        "retriable":false,
        "biz_success":true,
        "module":{
            "render_detail":{
                "external_refund_order_render_combine_wrapper_d_t_o":[
                    {
                        "refund_type_render_detail":{
                            "external_refund_order_render_combine_item_wrapper_d_t_o":[
                                {
                                    "reason_detail":{
                                        "external_refund_apply_reason_item_d_t_o":[
                                            {
                                                "outer_reason_id":16,
                                                "outer_reason_name":"商品变质\/发霉\/有异物",
                                                "need_offer_pic":false
                                            }
                                        ]
                                    },
                                    "buyer_goods_status":2,
                                    "max_refund_fee":100,
                                    "min_refund_fee":1
                                }
                            ]
                        },
                        "outer_refund_type":2
                    }
                ]
            }
        },
        "biz_error_message":"系统异常",
        "biz_error_code":"system_exception"
    }
}

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.ascp.channel.sub.refund.render.query (逆向订单创单前的渲染)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈