飞猪 - 开放平台

请求地址：

环境	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_call_back_param	RefundCallBackParam	必须			商旅退票回调信息
refund_train_details RefundTrainDetail [] 必须 refundTrainDetail 退票信息 └ to_station_name String 必须上海到达站名 └ arrive_time String 必须 2022-10-19 14:00:00 到达时间，yyyy-MM-dd hh:mm:ss └ train_date String 必须 2022-10-19 乘车日期 yyyy-MM-dd └ from_station_name String 必须北京出发站名 refund_ticket_details RefundTicketDetail [] 必须 refundTicketDetail 退票信息 └ seat_type String 必须 1 坐席类型，枚举值 └ coach_no String 必须 01 车厢号 └ ticket_price String 必须 1000 车票单价，单位分 └ ticket_status String 必须 31 票状态，枚举值提供 └ seat_name String 必须硬座坐席名称，枚举值提供 passenger_info PassengerInfo 必须乘客信息 └ passenger_name String 必须 123123 乘客姓名，SM4加密 └ passenger_mobile String 必须 1667xx77xxx 乘客手机号，SM4加密 └ passenger_id_no String 必须 432524100011191212 证件号，SM4加密 └ passenger_id_type String 必须 0 证件类型，SM4加密，枚举值提供 └ country_code String 可选 CN 国籍码，SM4加密，证件为非身份证类型必传 └ sex String 可选 0 性别，SM4加密,0:男，1：女 └ passenger_id String 必须 1231232 乘客id，SM4加密，商旅提供 └ valid_date_start String 可选 2000-10-19 签发日期，SM4加密 └ birth_date String 可选 1000-10-19 出生日期，SM4加密， yyyy-MM-dd格式，证件为非身份证类型必传 └ valid_date_end String 可选 2030-10-19 证件有效期，SM4加密，yyyy-MM-dd格式，证件为非身份证类型必传 └ ticket_type String 必须 1 票类型，0：儿童票，1：成人票，2：学生票 └ refund_rate String 可选 0 退票费率，单位分 └ seat_no String 必须 001 坐席号 └ refund_price String 必须 1000 退款，单位分 └ passenger_ticket_no String 必须 EW123121 乘客取票号 └ refund_cost String 必须 0 退票手续费，单位分 └ fail_reason String 可选退票失败退票失败原因 └ fail_code String 可选 3001 退票失败code └ to_station_code String 必须 SHH 到达站三字码 └ train_no String 必须 T123 短车次号 └ from_station_code String 必须 BJP 出发站三字码 └ start_time String 必须 2022-10-19 12:00:00 出发时间，yyyy-MM-dd hh:mm:ss └ order_id String 必须 123456789 商旅订单号 └ refund_total String 必须 1000 退票总款项 └ order_status String 必须 31 订单状态 └ refund_rate String 可选 0 退票费率 └ refund_id String 必须 1231123 商旅退票申请ID └ refund_cost String 必须 0 退票总手续费 └ supplier_order_id String 必须 12345678 供应商订单号 └ ticket_no String 必须 EW123412 12306取票号

名称	类型	示例值	描述
data	OrderInfo		订单基础数据
└ order_id String 123456789 商旅订单号 └ supplier_order_id String 987654321 供应商订单号
result_code	String	200	返回结果码
status	String	true	是否成功
result_msg	String	成功	返回结果描述

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlitripBtripSupplychainTrainCallbackRefundRequest req = new AlitripBtripSupplychainTrainCallbackRefundRequest();
AlitripBtripSupplychainTrainCallbackRefundRequest.RefundCallBackParam obj1 = new AlitripBtripSupplychainTrainCallbackRefundRequest.RefundCallBackParam();
List<AlitripBtripSupplychainTrainCallbackRefundRequest.RefundTrainDetail> list3 = new ArrayList<AlitripBtripSupplychainTrainCallbackRefundRequest.RefundTrainDetail>();
AlitripBtripSupplychainTrainCallbackRefundRequest.RefundTrainDetail obj4 = new AlitripBtripSupplychainTrainCallbackRefundRequest.RefundTrainDetail();
list3.add(obj4);
obj4.setToStationName("上海");
obj4.setArriveTime("2022-10-19 14:00:00");
obj4.setTrainDate("2022-10-19");
obj4.setFromStationName("北京");
List<AlitripBtripSupplychainTrainCallbackRefundRequest.RefundTicketDetail> list7 = new ArrayList<AlitripBtripSupplychainTrainCallbackRefundRequest.RefundTicketDetail>();
AlitripBtripSupplychainTrainCallbackRefundRequest.RefundTicketDetail obj8 = new AlitripBtripSupplychainTrainCallbackRefundRequest.RefundTicketDetail();
list7.add(obj8);
obj8.setSeatType("1");
obj8.setCoachNo("01");
obj8.setTicketPrice("1000");
obj8.setTicketStatus("31");
obj8.setSeatName("硬座");
AlitripBtripSupplychainTrainCallbackRefundRequest.PassengerInfo obj10 = new AlitripBtripSupplychainTrainCallbackRefundRequest.PassengerInfo();
obj10.setPassengerName("123123");
obj10.setPassengerMobile("1667xx77xxx");
obj10.setPassengerIdNo("432524100011191212");
obj10.setPassengerIdType("0");
obj10.setCountryCode("CN");
obj10.setSex("0");
obj10.setPassengerId("1231232");
obj10.setValidDateStart("2000-10-19");
obj10.setBirthDate("1000-10-19");
obj10.setValidDateEnd("2030-10-19");
list9.setPassengerInfo(obj10);
obj8.setTicketType("1");
obj8.setRefundRate("0");
obj8.setSeatNo("001");
obj8.setRefundPrice("1000");
obj8.setPassengerTicketNo("EW123121");
obj8.setRefundCost("0");
obj8.setFailReason("退票失败");
obj8.setFailCode("3001");
list5.setRefundTicketDetails(list7);
obj4.setToStationCode("SHH");
obj4.setTrainNo("T123");
obj4.setFromStationCode("BJP");
obj4.setStartTime("2022-10-19 12:00:00");
obj1.setRefundTrainDetails(list3);
obj1.setOrderId("123456789");
obj1.setRefundTotal("1000");
obj1.setOrderStatus("31");
obj1.setRefundRate("0");
obj1.setRefundId("1231123");
obj1.setRefundCost("0");
obj1.setSupplierOrderId("12345678");
obj1.setTicketNo("EW123412");
req.setRefundCallBackParam(obj1);
AlitripBtripSupplychainTrainCallbackRefundResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlitripBtripSupplychainTrainCallbackRefundRequest req = new AlitripBtripSupplychainTrainCallbackRefundRequest();
AlitripBtripSupplychainTrainCallbackRefundRequest.RefundCallBackParamDomain obj1 = new AlitripBtripSupplychainTrainCallbackRefundRequest.RefundCallBackParamDomain();
List<AlitripBtripSupplychainTrainCallbackRefundRequest.RefundTrainDetailDomain> list3 = new List<AlitripBtripSupplychainTrainCallbackRefundRequest.RefundTrainDetailDomain>();
AlitripBtripSupplychainTrainCallbackRefundRequest.RefundTrainDetailDomain obj4 = new AlitripBtripSupplychainTrainCallbackRefundRequest.RefundTrainDetailDomain();
list3.Add(obj4);
obj4.ToStationName = "上海";
obj4.ArriveTime = "2022-10-19 14:00:00";
obj4.TrainDate = "2022-10-19";
obj4.FromStationName = "北京";
List<AlitripBtripSupplychainTrainCallbackRefundRequest.RefundTicketDetailDomain> list6 = new List<AlitripBtripSupplychainTrainCallbackRefundRequest.RefundTicketDetailDomain>();
AlitripBtripSupplychainTrainCallbackRefundRequest.RefundTicketDetailDomain obj7 = new AlitripBtripSupplychainTrainCallbackRefundRequest.RefundTicketDetailDomain();
list6.Add(obj7);
obj7.SeatType = "1";
obj7.CoachNo = "01";
obj7.TicketPrice = "1000";
obj7.TicketStatus = "31";
obj7.SeatName = "硬座";
AlitripBtripSupplychainTrainCallbackRefundRequest.PassengerInfoDomain obj8 = new AlitripBtripSupplychainTrainCallbackRefundRequest.PassengerInfoDomain();
obj8.PassengerName = "123123";
obj8.PassengerMobile = "1667xx77xxx";
obj8.PassengerIdNo = "432524100011191212";
obj8.PassengerIdType = "0";
obj8.CountryCode = "CN";
obj8.Sex = "0";
obj8.PassengerId = "1231232";
obj8.ValidDateStart = "2000-10-19";
obj8.BirthDate = "1000-10-19";
obj8.ValidDateEnd = "2030-10-19";
obj7.PassengerInfo= obj8;
obj7.TicketType = "1";
obj7.RefundRate = "0";
obj7.SeatNo = "001";
obj7.RefundPrice = "1000";
obj7.PassengerTicketNo = "EW123121";
obj7.RefundCost = "0";
obj7.FailReason = "退票失败";
obj7.FailCode = "3001";
obj4.RefundTicketDetails= list6;
obj4.ToStationCode = "SHH";
obj4.TrainNo = "T123";
obj4.FromStationCode = "BJP";
obj4.StartTime = "2022-10-19 12:00:00";
obj1.RefundTrainDetails= list3;
obj1.OrderId = "123456789";
obj1.RefundTotal = "1000";
obj1.OrderStatus = "31";
obj1.RefundRate = "0";
obj1.RefundId = "1231123";
obj1.RefundCost = "0";
obj1.SupplierOrderId = "12345678";
obj1.TicketNo = "EW123412";
req.RefundCallBackParam_ = obj1;
AlitripBtripSupplychainTrainCallbackRefundResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlitripBtripSupplychainTrainCallbackRefundRequest;
$refund_call_back_param = new RefundCallBackParam;
$refund_train_details = new RefundTrainDetail;
$refund_train_details->to_station_name="上海";
$refund_train_details->arrive_time="2022-10-19 14:00:00";
$refund_train_details->train_date="2022-10-19";
$refund_train_details->from_station_name="北京";
$refund_ticket_details = new RefundTicketDetail;
$refund_ticket_details->seat_type="1";
$refund_ticket_details->coach_no="01";
$refund_ticket_details->ticket_price="1000";
$refund_ticket_details->ticket_status="31";
$refund_ticket_details->seat_name="硬座";
$passenger_info = new PassengerInfo;
$passenger_info->passenger_name="123123";
$passenger_info->passenger_mobile="1667xx77xxx";
$passenger_info->passenger_id_no="432524100011191212";
$passenger_info->passenger_id_type="0";
$passenger_info->country_code="CN";
$passenger_info->sex="0";
$passenger_info->passenger_id="1231232";
$passenger_info->valid_date_start="2000-10-19";
$passenger_info->birth_date="1000-10-19";
$passenger_info->valid_date_end="2030-10-19";
$refund_ticket_details->passenger_info = $passenger_info;
$refund_ticket_details->ticket_type="1";
$refund_ticket_details->refund_rate="0";
$refund_ticket_details->seat_no="001";
$refund_ticket_details->refund_price="1000";
$refund_ticket_details->passenger_ticket_no="EW123121";
$refund_ticket_details->refund_cost="0";
$refund_ticket_details->fail_reason="退票失败";
$refund_ticket_details->fail_code="3001";
$refund_train_details->refund_ticket_details = $refund_ticket_details;
$refund_train_details->to_station_code="SHH";
$refund_train_details->train_no="T123";
$refund_train_details->from_station_code="BJP";
$refund_train_details->start_time="2022-10-19 12:00:00";
$refund_call_back_param->refund_train_details = $refund_train_details;
$refund_call_back_param->order_id="123456789";
$refund_call_back_param->refund_total="1000";
$refund_call_back_param->order_status="31";
$refund_call_back_param->refund_rate="0";
$refund_call_back_param->refund_id="1231123";
$refund_call_back_param->refund_cost="0";
$refund_call_back_param->supplier_order_id="12345678";
$refund_call_back_param->ticket_no="EW123412";
$req->setRefundCallBackParam(json_encode($refund_call_back_param));
$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.btrip.supplychain.train.callback.refund' \
-d 'partner_id=apidoc' \
-d 'session=7df54b72-ce8c-4280-9175-52a9f35c7813' \
-d 'sign=4DD3CBDCFE2D2F23E7628D177A370383' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-11-23+15%3A59%3A42' \
-d 'v=2.0' \
-d 'refund_call_back_param=null'

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

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

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

XML示例
JSON示例

<alitrip_btrip_supplychain_train_callback_refund_response>
    <data>
        <order_id>123456789</order_id>
        <supplier_order_id>987654321</supplier_order_id>
    </data>
    <result_code>200</result_code>
    <status>true</status>
    <result_msg>成功</result_msg>
</alitrip_btrip_supplychain_train_callback_refund_response>

{
    "alitrip_btrip_supplychain_train_callback_refund_response":{
        "data":{
            "order_id":"123456789",
            "supplier_order_id":"987654321"
        },
        "result_code":"200",
        "status":"true",
        "result_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.btrip.supplychain.train.callback.refund (商旅火车票退票回调)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ