淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
assis_cancel_result_notify_dto	AssisCancelResultNotifyDTO	可选			请求实体
guest_info_list GuestInfoDTO [] 可选 [] 入住人信息列表（部分取消必传） └ person_name String 可选张三入住人姓名 └ staff_no String 可选 091103 入住人员工编号 └ room_person_type Number 可选 1 入住类型（1：实际入住人；2：拼房人），拼房场景下必填 └ room_index Number 可选 1 房间编号（编号相同代表同一房间） └ check_out_date String 可选 2023-02-02 取消结束时间，部分取消必传：yyyy-MM-dd └ order_id String 可选 111222333 接口订单号 └ cancel_room_count Number 可选 1 取消间数（部分取消必传） └ cancel_type Number 可选 1 退订类型： 1：整单取消 2：部分取消 └ refund_room_fee BigDecimal 可选 100.00 退款房费总金额（取消成功必传，退订罚金、退款房费总金额必传其一） └ top_app_key String 可选 111222 appkey └ cancel_reason String 可选太远了取消原因 └ check_in_date String 可选 2023-02-01 取消开始时间，部分取消必传：yyyy-MM-dd └ plat_order_id String 可选 111222 平台订单号 └ cancel_fine BigDecimal 可选 100.00 退订罚金（取消成功必传，退订罚金、退款房费总金额必传其一）

名称	类型	示例值	描述
err_no	String	111111	错误码
stack_trace	String	null	错误栈
content	CalculateOrderRefundAmountResultDTO		返回实体
└ result Number 1 0：计算失败 1：计算成功 └ fail_msg String error 错误信息 └ order_id String 111222 接口订单号 └ plat_reverse_order_id String 112233 平台订单号 └ company_refund_fee BigDecimal 10.00 企业退款金额 └ person_refund_room_fee BigDecimal 10.00 个人退款金额 └ original_company_adv_fee BigDecimal 10.00 企业支付原始付款金额 └ original_person_adv_fee BigDecimal 10.00 个人支付原始付款金额 └ user_confirm_status Number 10 0:未确认，5:无需确认，10:已确认，15:不确认
is_success	Boolean	true	是否成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaHappytripHotelOrderRefundCalculateRequest req = new AlibabaHappytripHotelOrderRefundCalculateRequest();
AlibabaHappytripHotelOrderRefundCalculateRequest.AssisCancelResultNotifyDTO obj1 = new AlibabaHappytripHotelOrderRefundCalculateRequest.AssisCancelResultNotifyDTO();
List<AlibabaHappytripHotelOrderRefundCalculateRequest.GuestInfoDTO> list3 = new ArrayList<AlibabaHappytripHotelOrderRefundCalculateRequest.GuestInfoDTO>();
AlibabaHappytripHotelOrderRefundCalculateRequest.GuestInfoDTO obj4 = new AlibabaHappytripHotelOrderRefundCalculateRequest.GuestInfoDTO();
list3.add(obj4);
obj4.setPersonName("张三");
obj4.setStaffNo("091103");
obj4.setRoomPersonType(1L);
obj4.setRoomIndex(1L);
obj1.setGuestInfoList(list3);
obj1.setCheckOutDate("2023-02-02");
obj1.setOrderId("111222333");
obj1.setCancelRoomCount(1L);
obj1.setCancelType(1L);
obj1.setRefundRoomFee("100.00");
obj1.setTopAppKey("111222");
obj1.setCancelReason("太远了");
obj1.setCheckInDate("2023-02-01");
obj1.setPlatOrderId("111222");
obj1.setCancelFine("100.00");
req.setAssisCancelResultNotifyDto(obj1);
AlibabaHappytripHotelOrderRefundCalculateResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaHappytripHotelOrderRefundCalculateRequest req = new AlibabaHappytripHotelOrderRefundCalculateRequest();
AlibabaHappytripHotelOrderRefundCalculateRequest.AssisCancelResultNotifyDTODomain obj1 = new AlibabaHappytripHotelOrderRefundCalculateRequest.AssisCancelResultNotifyDTODomain();
List<AlibabaHappytripHotelOrderRefundCalculateRequest.GuestInfoDTODomain> list3 = new List<AlibabaHappytripHotelOrderRefundCalculateRequest.GuestInfoDTODomain>();
AlibabaHappytripHotelOrderRefundCalculateRequest.GuestInfoDTODomain obj4 = new AlibabaHappytripHotelOrderRefundCalculateRequest.GuestInfoDTODomain();
list3.Add(obj4);
obj4.PersonName = "张三";
obj4.StaffNo = "091103";
obj4.RoomPersonType = 1L;
obj4.RoomIndex = 1L;
obj1.GuestInfoList= list3;
obj1.CheckOutDate = "2023-02-02";
obj1.OrderId = "111222333";
obj1.CancelRoomCount = 1L;
obj1.CancelType = 1L;
obj1.RefundRoomFee = "100.00";
obj1.TopAppKey = "111222";
obj1.CancelReason = "太远了";
obj1.CheckInDate = "2023-02-01";
obj1.PlatOrderId = "111222";
obj1.CancelFine = "100.00";
req.AssisCancelResultNotifyDto_ = obj1;
AlibabaHappytripHotelOrderRefundCalculateResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaHappytripHotelOrderRefundCalculateRequest;
$assis_cancel_result_notify_dto = new AssisCancelResultNotifyDTO;
$guest_info_list = new GuestInfoDTO;
$guest_info_list->person_name="张三";
$guest_info_list->staff_no="091103";
$guest_info_list->room_person_type="1";
$guest_info_list->room_index="1";
$assis_cancel_result_notify_dto->guest_info_list = $guest_info_list;
$assis_cancel_result_notify_dto->check_out_date="2023-02-02";
$assis_cancel_result_notify_dto->order_id="111222333";
$assis_cancel_result_notify_dto->cancel_room_count="1";
$assis_cancel_result_notify_dto->cancel_type="1";
$assis_cancel_result_notify_dto->refund_room_fee="100.00";
$assis_cancel_result_notify_dto->top_app_key="111222";
$assis_cancel_result_notify_dto->cancel_reason="太远了";
$assis_cancel_result_notify_dto->check_in_date="2023-02-01";
$assis_cancel_result_notify_dto->plat_order_id="111222";
$assis_cancel_result_notify_dto->cancel_fine="100.00";
$req->setAssisCancelResultNotifyDto(json_encode($assis_cancel_result_notify_dto));
$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.happytrip.hotel.order.refund.calculate' \
-d 'partner_id=apidoc' \
-d 'sign=9CB2A5B4D65177C06BED4520A00D2F53' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-02+22%3A35%3A41' \
-d 'v=2.0' \
-d 'assis_cancel_result_notify_dto=null'

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

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

req.assis_cancel_result_notify_dto="数据结构示例JSON格式"
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.happytrip.hotel.order.refund.calculate");
add_param(pRequest,"assis_cancel_result_notify_dto","数据结构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.happytrip.hotel.order.refund.calculate', {
	'assis_cancel_result_notify_dto':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_happytrip_hotel_order_refund_calculate_response>
    <err_no>111111</err_no>
    <stack_trace>null</stack_trace>
    <content>
        <result>1</result>
        <fail_msg>error</fail_msg>
        <order_id>111222</order_id>
        <plat_reverse_order_id>112233</plat_reverse_order_id>
        <company_refund_fee>10.00</company_refund_fee>
        <person_refund_room_fee>10.00</person_refund_room_fee>
        <original_company_adv_fee>10.00</original_company_adv_fee>
        <original_person_adv_fee>10.00</original_person_adv_fee>
        <user_confirm_status>10</user_confirm_status>
    </content>
    <is_success>true</is_success>
</alibaba_happytrip_hotel_order_refund_calculate_response>

{
    "alibaba_happytrip_hotel_order_refund_calculate_response":{
        "err_no":"111111",
        "stack_trace":"null",
        "content":{
            "result":1,
            "fail_msg":"error",
            "order_id":"111222",
            "plat_reverse_order_id":"112233",
            "company_refund_fee":"10.00",
            "person_refund_room_fee":"10.00",
            "original_company_adv_fee":"10.00",
            "original_person_adv_fee":"10.00",
            "user_confirm_status":10
        },
        "is_success":true
    }
}

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.happytrip.hotel.order.refund.calculate (计算酒店订单退款)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ