淘宝开放平台 - 文档中心

请求地址：

环境	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_order_detail_req	RefundOrderDetailReq	必须			请求RQ
└ apply_id Number 必须 485060695329 退票单Id

名称	类型	示例值	描述
is_success	Boolean	true	是否成功
error_code_info	String	SYSTEM_ERROR	错误码信息
refund_order_detail	FlightRefundOrderDetail		订单明细
└ pay_latest_time Date 2021-01-01 00:00:00 最晚退款时间 └ gmt_modified Date 2021-01-01 00:00:00 更新时间 └ order_id Number 343434343434 订单号 └ alipay_trade_no String 798347593745734579347597 支付宝交易号 item_fee_detail_list RefundItemFeeDetail [] 商品费用列表 refund_item RefundFlightItem 提退商品模型 flight_journey_list FlightJourney [] 行程列表 flight_segment_list FlightSegment [] 航段列表 └ dep_airport_code String PEK 出发机场三字码 └ operating_flight_no String MU5735 承运航班号 └ arr_city_code String SHA 到达城市码 └ arr_date String 2021-01-01 00:00:00 达到日期 └ arr_city_name String 上海到达城市 └ marketing_flight_no String MU5735 销售航班号 └ dep_city_name String 北京出发城市名称 └ arr_airport_code String SHA 到达机场三字码 └ dep_date String 2021-01-01 00:00:00 出发时间 └ dep_city_code String PEK 出发城市三字码 refund_fee_detail FlightRefundFeeDetail 明细模型 └ non_refundable_change_service_fee Number 10 不可退改签服务费用 passenger RefundPassenger 乘机人模型 └ passenger_name String 森春乘机人姓名 └ credential_no String 686887787 乘机人证件号 └ non_refundable_tax_fee Number 100 不可退-税的部分 └ refund_to_buyer_money Number 1000 原票退款给用户的金额(不含改签) └ modify_refund_to_buyer_money Number 200 改签退款给用户的部分 └ already_used_total_fee Number 0 不可退-已使用的部分 └ non_refundable_ticket_fee Number 100 不可退-票的部分 └ non_refundable_change_upgrade_fee Number 100 不可退-改签升舱的部分 └ all_refund_to_buyer_money Number 1200 总退款金额 └ gmt_create Date 2021-01-01 00:00:00 创建时间 └ apply_id Number 77687688989 申请单ID └ refund_apply_reason String 不想出行了提退原因 └ refund_attachment_urls String [] 附件URL地址列表 refund_item_list RefundFlightItem [] 提退商品 flight_journey_list FlightJourney [] 行程列表 flight_segment_list FlightSegment [] 航班列表 └ dep_airport_code String PEK 出发机场三字码 └ operating_flight_no String MU5735 销售航班号 └ arr_city_code String SHA 到达城市三字码 └ arr_date String 2021-01-01 00:00:00 到达时间 └ arr_city_name String 上海到达城市名称 └ marketing_flight_no String MU5735 市场航班号 └ dep_city_name String 北京出发城市三字码 └ arr_airport_code String SHA 到达机场三字码 └ dep_date String 2021-01-01 00:00:00 到达时间点 └ dep_city_code String PEK 出发城市三字码 └ refund_apply_type Number 提退原因类型申请类型：2:自愿；5:航变；6:病退；100:非自愿疫情 └ pay_success_time Date 退款成功时间退款成时间 └ status Number 退票单状态状态：1:待处理；2:已同意；3:已拒绝；6:已受理；7:已退款 └ refuse_reason String 资料不符合航司要求提退被拒绝原因描述 └ ext_attributes String 扩展属性扩展属性
error_msg	String	系统异常	错误原因

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlitripFlightRefundDetailRequest req = new AlitripFlightRefundDetailRequest();
AlitripFlightRefundDetailRequest.RefundOrderDetailReq obj1 = new AlitripFlightRefundDetailRequest.RefundOrderDetailReq();
obj1.setApplyId(485060695329L);
req.setRefundOrderDetailReq(obj1);
AlitripFlightRefundDetailResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlitripFlightRefundDetailRequest req = new AlitripFlightRefundDetailRequest();
AlitripFlightRefundDetailRequest.RefundOrderDetailReqDomain obj1 = new AlitripFlightRefundDetailRequest.RefundOrderDetailReqDomain();
obj1.ApplyId = 485060695329L;
req.RefundOrderDetailReq_ = obj1;
AlitripFlightRefundDetailResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlitripFlightRefundDetailRequest;
$refund_order_detail_req = new RefundOrderDetailReq;
$refund_order_detail_req->apply_id="485060695329";
$req->setRefundOrderDetailReq(json_encode($refund_order_detail_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.detail' \
-d 'partner_id=apidoc' \
-d 'session=b52ab3e0-1cae-45a7-9eaa-9df0fc7132ef' \
-d 'sign=F97187B56F97866C361D5B9203988538' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-01-30+12%3A56%3A54' \
-d 'v=2.0' \
-d 'refund_order_detail_req=null'

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

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

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

XML示例
JSON示例

<alitrip_flight_refund_detail_response>
    <is_success>true</is_success>
    <error_code_info>SYSTEM_ERROR</error_code_info>
    <refund_order_detail>
        <pay_latest_time>2021-01-01 00:00:00</pay_latest_time>
        <gmt_modified>2021-01-01 00:00:00</gmt_modified>
        <order_id>343434343434</order_id>
        <alipay_trade_no>798347593745734579347597</alipay_trade_no>
        <item_fee_detail_list>
            <refund_item_fee_detail>
                <refund_item>
                    <flight_journey_list>
                        <flight_journey>
                            <flight_segment_list>
                                <flight_segment>
                                    <dep_airport_code>PEK</dep_airport_code>
                                    <operating_flight_no>MU5735</operating_flight_no>
                                    <arr_city_code>SHA</arr_city_code>
                                    <arr_date>2021-01-01 00:00:00</arr_date>
                                    <arr_city_name>上海</arr_city_name>
                                    <marketing_flight_no>MU5735</marketing_flight_no>
                                    <dep_city_name>北京</dep_city_name>
                                    <arr_airport_code>SHA</arr_airport_code>
                                    <dep_date>2021-01-01 00:00:00</dep_date>
                                    <dep_city_code>PEK</dep_city_code>
                                </flight_segment>
                            </flight_segment_list>
                        </flight_journey>
                    </flight_journey_list>
                </refund_item>
                <refund_fee_detail>
                    <non_refundable_change_service_fee>10</non_refundable_change_service_fee>
                    <passenger>
                        <passenger_name>森春</passenger_name>
                        <credential_no>686887787</credential_no>
                    </passenger>
                    <non_refundable_tax_fee>100</non_refundable_tax_fee>
                    <refund_to_buyer_money>1000</refund_to_buyer_money>
                    <modify_refund_to_buyer_money>200</modify_refund_to_buyer_money>
                    <already_used_total_fee>0</already_used_total_fee>
                    <non_refundable_ticket_fee>100</non_refundable_ticket_fee>
                    <non_refundable_change_upgrade_fee>100</non_refundable_change_upgrade_fee>
                    <all_refund_to_buyer_money>1200</all_refund_to_buyer_money>
                </refund_fee_detail>
            </refund_item_fee_detail>
        </item_fee_detail_list>
        <gmt_create>2021-01-01 00:00:00</gmt_create>
        <apply_id>77687688989</apply_id>
        <refund_apply_reason>不想出行了</refund_apply_reason>
        <refund_item_list>
            <refund_flight_item>
                <flight_journey_list>
                    <flight_journey>
                        <flight_segment_list>
                            <flight_segment>
                                <dep_airport_code>PEK</dep_airport_code>
                                <operating_flight_no>MU5735</operating_flight_no>
                                <arr_city_code>SHA</arr_city_code>
                                <arr_date>2021-01-01 00:00:00</arr_date>
                                <arr_city_name>上海</arr_city_name>
                                <marketing_flight_no>MU5735</marketing_flight_no>
                                <dep_city_name>北京</dep_city_name>
                                <arr_airport_code>SHA</arr_airport_code>
                                <dep_date>2021-01-01 00:00:00</dep_date>
                                <dep_city_code>PEK</dep_city_code>
                            </flight_segment>
                        </flight_segment_list>
                    </flight_journey>
                </flight_journey_list>
            </refund_flight_item>
        </refund_item_list>
        <refund_apply_type>提退原因类型</refund_apply_type>
        <pay_success_time>退款成功时间</pay_success_time>
        <status>退票单状态</status>
        <refuse_reason>资料不符合航司要求</refuse_reason>
        <ext_attributes>扩展属性</ext_attributes>
    </refund_order_detail>
    <error_msg>系统异常</error_msg>
</alitrip_flight_refund_detail_response>

{
    "alitrip_flight_refund_detail_response":{
        "is_success":true,
        "error_code_info":"SYSTEM_ERROR",
        "refund_order_detail":{
            "pay_latest_time":"2021-01-01 00:00:00",
            "gmt_modified":"2021-01-01 00:00:00",
            "order_id":343434343434,
            "alipay_trade_no":"798347593745734579347597",
            "item_fee_detail_list":{
                "refund_item_fee_detail":[
                    {
                        "refund_item":{
                            "flight_journey_list":{
                                "flight_journey":[
                                    {
                                        "flight_segment_list":{
                                            "flight_segment":[
                                                {
                                                    "dep_airport_code":"PEK",
                                                    "operating_flight_no":"MU5735",
                                                    "arr_city_code":"SHA",
                                                    "arr_date":"2021-01-01 00:00:00",
                                                    "arr_city_name":"上海",
                                                    "marketing_flight_no":"MU5735",
                                                    "dep_city_name":"北京",
                                                    "arr_airport_code":"SHA",
                                                    "dep_date":"2021-01-01 00:00:00",
                                                    "dep_city_code":"PEK"
                                                }
                                            ]
                                        }
                                    }
                                ]
                            }
                        },
                        "refund_fee_detail":{
                            "non_refundable_change_service_fee":10,
                            "passenger":{
                                "passenger_name":"森春",
                                "credential_no":"686887787"
                            },
                            "non_refundable_tax_fee":100,
                            "refund_to_buyer_money":1000,
                            "modify_refund_to_buyer_money":200,
                            "already_used_total_fee":0,
                            "non_refundable_ticket_fee":100,
                            "non_refundable_change_upgrade_fee":100,
                            "all_refund_to_buyer_money":1200
                        }
                    }
                ]
            },
            "gmt_create":"2021-01-01 00:00:00",
            "apply_id":77687688989,
            "refund_apply_reason":"不想出行了",
            "refund_item_list":{
                "refund_flight_item":[
                    {
                        "flight_journey_list":{
                            "flight_journey":[
                                {
                                    "flight_segment_list":{
                                        "flight_segment":[
                                            {
                                                "dep_airport_code":"PEK",
                                                "operating_flight_no":"MU5735",
                                                "arr_city_code":"SHA",
                                                "arr_date":"2021-01-01 00:00:00",
                                                "arr_city_name":"上海",
                                                "marketing_flight_no":"MU5735",
                                                "dep_city_name":"北京",
                                                "arr_airport_code":"SHA",
                                                "dep_date":"2021-01-01 00:00:00",
                                                "dep_city_code":"PEK"
                                            }
                                        ]
                                    }
                                }
                            ]
                        }
                    }
                ]
            },
            "refund_apply_type":提退原因类型,
            "pay_success_time":"退款成功时间",
            "status":退票单状态,
            "refuse_reason":"资料不符合航司要求",
            "ext_attributes":"扩展属性"
        },
        "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.detail (新京杭退票单详情)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ