淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
refund_render_req	RefundRenderReq	必须			请求参数
└ order_id Number 必须 3960040419329 订单ID

名称	类型	示例值	描述
is_success	Boolean	true	是否成功
error_code_info	String	SYSTEM_ERROR	错误码信息
refund_item_group_list	FlightRefundItemGroupRender []		可提退分组模型列表
passenger_refund_detail_list RefundPassengerDetail [] 乘机人费用明细模型列表 passenger RefundPassenger 乘机人模型 └ passenger_name String 森春乘机人姓名 └ credential_no String 41272519880823827X 乘机人证件号 calculate_fee RefundPreCalculateFee 费用模型 └ non_refundable_change_service_fee Number 0 不可退-改签手续费 └ calculate_success Boolean true 预计算是否成功 └ non_refundable_tax_fee Number 0 不可退-税的部分，国内默认为：0 └ non_support_pre_calculate_msg String 票状态不符合不支持预计算-描述 └ non_support_pre_calculate_code Number TICKET_STATUS 不支持预计算-归因码 └ already_used_total_fee Number 0 不可退-机票已使用金额(拼接场景会有) └ non_refundable_ticket_fee Number 0 不可退-票的手续费 └ non_refundable_change_upgrade_fee Number 0 不可退-改签的升舱费 └ non_all_refund_fee Number 0 不可退-总手续费 └ refund_to_buyer_money Number 100 原票可退用户金额 └ modify_refund_to_buyer_money Number 50 改签部分可退用户的总金额 └ all_refund_to_buyer_money Number 150 退款给用户总金额：原票可退部分+改签可退部分 └ refund_apply_type Number 2 推荐提退类型：2:自愿；5:航变；6:病退；100:非自愿疫情，可能为空 └ can_refund Boolean true 是否可退 └ no_refund_reason String 票已使用不可退原因描述 flight_item RefundFlightItem 退票的商品模型 flight_journey_list FlightJourney [] 行程模型列表 flight_segment_list FlightSegment [] 航段模型列表 └ dep_airport_code String PEK 出发机场三字码 └ operating_flight_no String MU6767 承运航司航班号 └ arr_city_code String SHA 到达城市三字码 └ arr_date String 2022-01-01 00:00:00 到达时间 └ arr_city_name String 上海到达城市名称 └ marketing_flight_no String MU6767 市场航班号 └ dep_city_name String 北京出发城市名称 └ arr_airport_code String SHA 到达机场三字码 └ dep_date String 2022-01-01 00:00:00 出发日期 └ dep_city_code String PEK 出发城市名称 └ biz_line_type Number 2 业务类型 1:国内机票；2:国际机票
error_msg	String	系统错误	错误原因

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlitripFlightRefundRenderRequest req = new AlitripFlightRefundRenderRequest();
AlitripFlightRefundRenderRequest.RefundRenderReq obj1 = new AlitripFlightRefundRenderRequest.RefundRenderReq();
obj1.setOrderId(3960040419329L);
req.setRefundRenderReq(obj1);
AlitripFlightRefundRenderResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlitripFlightRefundRenderRequest req = new AlitripFlightRefundRenderRequest();
AlitripFlightRefundRenderRequest.RefundRenderReqDomain obj1 = new AlitripFlightRefundRenderRequest.RefundRenderReqDomain();
obj1.OrderId = 3960040419329L;
req.RefundRenderReq_ = obj1;
AlitripFlightRefundRenderResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlitripFlightRefundRenderRequest;
$refund_render_req = new RefundRenderReq;
$refund_render_req->order_id="3960040419329";
$req->setRefundRenderReq(json_encode($refund_render_req));
$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=alitrip.flight.refund.render' \
-d 'partner_id=apidoc' \
-d 'session=34dadbda-8e23-40aa-a955-3a18f6a6d4d1' \
-d 'sign=3EDC4BC019F4042EDBF7304D309D4DBE' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-01-30+13%3A05%3A22' \
-d 'v=2.0' \
-d 'refund_render_req=null'

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

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

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

XML示例
JSON示例

<alitrip_flight_refund_render_response>
    <is_success>true</is_success>
    <error_code_info>SYSTEM_ERROR</error_code_info>
    <refund_item_group_list>
        <flight_refund_item_group_render>
            <passenger_refund_detail_list>
                <refund_passenger_detail>
                    <passenger>
                        <passenger_name>森春</passenger_name>
                        <credential_no>41272519880823827X</credential_no>
                    </passenger>
                    <calculate_fee>
                        <non_refundable_change_service_fee>0</non_refundable_change_service_fee>
                        <calculate_success>true</calculate_success>
                        <non_refundable_tax_fee>0</non_refundable_tax_fee>
                        <non_support_pre_calculate_msg>票状态不符合</non_support_pre_calculate_msg>
                        <non_support_pre_calculate_code>TICKET_STATUS</non_support_pre_calculate_code>
                        <already_used_total_fee>0</already_used_total_fee>
                        <non_refundable_ticket_fee>0</non_refundable_ticket_fee>
                        <non_refundable_change_upgrade_fee>0</non_refundable_change_upgrade_fee>
                        <non_all_refund_fee>0</non_all_refund_fee>
                        <refund_to_buyer_money>100</refund_to_buyer_money>
                        <modify_refund_to_buyer_money>50</modify_refund_to_buyer_money>
                        <all_refund_to_buyer_money>150</all_refund_to_buyer_money>
                    </calculate_fee>
                    <refund_apply_type>2</refund_apply_type>
                    <can_refund>true</can_refund>
                    <no_refund_reason>票已使用</no_refund_reason>
                </refund_passenger_detail>
            </passenger_refund_detail_list>
            <flight_item>
                <flight_journey_list>
                    <flight_journey>
                        <flight_segment_list>
                            <flight_segment>
                                <dep_airport_code>PEK</dep_airport_code>
                                <operating_flight_no>MU6767</operating_flight_no>
                                <arr_city_code>SHA</arr_city_code>
                                <arr_date>2022-01-01 00:00:00</arr_date>
                                <arr_city_name>上海</arr_city_name>
                                <marketing_flight_no>MU6767</marketing_flight_no>
                                <dep_city_name>北京</dep_city_name>
                                <arr_airport_code>SHA</arr_airport_code>
                                <dep_date>2022-01-01 00:00:00</dep_date>
                                <dep_city_code>PEK</dep_city_code>
                            </flight_segment>
                        </flight_segment_list>
                    </flight_journey>
                </flight_journey_list>
            </flight_item>
            <biz_line_type>2</biz_line_type>
        </flight_refund_item_group_render>
    </refund_item_group_list>
    <error_msg>系统错误</error_msg>
</alitrip_flight_refund_render_response>

{
    "alitrip_flight_refund_render_response":{
        "is_success":true,
        "error_code_info":"SYSTEM_ERROR",
        "refund_item_group_list":{
            "flight_refund_item_group_render":[
                {
                    "passenger_refund_detail_list":{
                        "refund_passenger_detail":[
                            {
                                "passenger":{
                                    "passenger_name":"森春",
                                    "credential_no":"41272519880823827X"
                                },
                                "calculate_fee":{
                                    "non_refundable_change_service_fee":0,
                                    "calculate_success":true,
                                    "non_refundable_tax_fee":0,
                                    "non_support_pre_calculate_msg":"票状态不符合",
                                    "non_support_pre_calculate_code":TICKET_STATUS,
                                    "already_used_total_fee":0,
                                    "non_refundable_ticket_fee":0,
                                    "non_refundable_change_upgrade_fee":0,
                                    "non_all_refund_fee":0,
                                    "refund_to_buyer_money":100,
                                    "modify_refund_to_buyer_money":50,
                                    "all_refund_to_buyer_money":150
                                },
                                "refund_apply_type":2,
                                "can_refund":true,
                                "no_refund_reason":"票已使用"
                            }
                        ]
                    },
                    "flight_item":{
                        "flight_journey_list":{
                            "flight_journey":[
                                {
                                    "flight_segment_list":{
                                        "flight_segment":[
                                            {
                                                "dep_airport_code":"PEK",
                                                "operating_flight_no":"MU6767",
                                                "arr_city_code":"SHA",
                                                "arr_date":"2022-01-01 00:00:00",
                                                "arr_city_name":"上海",
                                                "marketing_flight_no":"MU6767",
                                                "dep_city_name":"北京",
                                                "arr_airport_code":"SHA",
                                                "dep_date":"2022-01-01 00:00:00",
                                                "dep_city_code":"PEK"
                                            }
                                        ]
                                    }
                                }
                            ]
                        }
                    },
                    "biz_line_type":2
                }
            ]
        },
        "error_msg":"系统错误"
    }
}

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

alitrip.flight.refund.render (新京杭退票单渲染)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ