淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
param	TopApplyRefundOrderParam	必须			请求体。综合描述： 1、当渠道用户发起退款申请时，此时订单需符合相关退票规则，退款金额和退款服务费相关字段为强校验属性，若通过验证，则自动退票退款，按退款规则收取相应服务费，若不通过，拦截返回退款申请失败； 2、当渠道客服发起退款申请时，此时若订单符合相关退票规则，服务费相关字段不缺失，则正常自动退票退款。若不符合规则，则会进入票票审核系统，返回退款申请中状态，由相关同学做审核处理，审核结果异步MQ消息通知； 3、上述两种角色发起退款申请过程中，均有可能出现系统级别的拦截或异常，此时返回退款申请失败，若间隔重试几次后仍然无法成功，请联系票票客服同学沟通后走邮件申请退款。
└ platform Number 必须 100 淘票票分配的渠道码 └ user_id Number 必须 123123123 商户账号ID，此ID是一串数字。可自行百度查看如何获取或者咨询淘票票技术人员提供 └ tb_order_id Number 必须 12345671232112 淘票票订单号 └ ext_user_id String 必须 1234567 商户内部自建用户ID。外部渠道需保证该参数的唯一性和准确性 └ ext_order_id String 必须 123456743221 商户内部自建订单号。外部渠道需保证该参数的唯一性和准确性 └ ext_op_role Number 必须 1 申请退票用户身份。1 表示渠道用户，2 表示渠道客服 └ refund_amount Number 必须 100 退款金额。以分为单位，为指定的退款订单应退金额 └ refund_service_fee Number 必须 1 退款服务费。以分为单位 └ refund_desc String 必须和影院协商一致退款退款说明。本次退款的相关情况、原因表述 └ platform_email String 可选 tpp@alibaba-inc.com 商户邮箱 └ params String 可选 null 扩展字段

名称	类型	示例值	描述
result	ResultGeneralModel		接口返回model
└ return_message String 非法参数调用失败描述信息 └ return_code String 0 业务码。0表示成功，其他均表示失败，需要根据具体值做相应处理 return_value TopApplyRefundOrderResult 业务返回结果 └ status String APPLY_REFUND_SUCCESS 申请退款状态。示例：APPLY_REFUND_SUCCESS（申请退款成功）、APPLY_REFUND_FAILED（申请退款失败）、APPLY_REFUNDING(申请退款中) └ message String 申请退款成功申请退款状态描述。示例：申请退款成功、申请退款失败 + 原因描述、申请退款中 + 描述

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
FilmDataThirdPartyTicketOrderRefundRequest req = new FilmDataThirdPartyTicketOrderRefundRequest();
FilmDataThirdPartyTicketOrderRefundRequest.TopApplyRefundOrderParam obj1 = new FilmDataThirdPartyTicketOrderRefundRequest.TopApplyRefundOrderParam();
obj1.setPlatform(100L);
obj1.setUserId(123123123L);
obj1.setTbOrderId(12345671232112L);
obj1.setExtUserId("1234567");
obj1.setExtOrderId("123456743221");
obj1.setExtOpRole(1L);
obj1.setRefundAmount(100L);
obj1.setRefundServiceFee(1L);
obj1.setRefundDesc("和影院协商一致退款");
obj1.setPlatformEmail("tpp@alibaba-inc.com");
obj1.setParams("null");
req.setParam(obj1);
FilmDataThirdPartyTicketOrderRefundResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
FilmDataThirdPartyTicketOrderRefundRequest req = new FilmDataThirdPartyTicketOrderRefundRequest();
FilmDataThirdPartyTicketOrderRefundRequest.TopApplyRefundOrderParamDomain obj1 = new FilmDataThirdPartyTicketOrderRefundRequest.TopApplyRefundOrderParamDomain();
obj1.Platform = 100L;
obj1.UserId = 123123123L;
obj1.TbOrderId = 12345671232112L;
obj1.ExtUserId = "1234567";
obj1.ExtOrderId = "123456743221";
obj1.ExtOpRole = 1L;
obj1.RefundAmount = 100L;
obj1.RefundServiceFee = 1L;
obj1.RefundDesc = "和影院协商一致退款";
obj1.PlatformEmail = "tpp@alibaba-inc.com";
obj1.Params = "null";
req.Param_ = obj1;
FilmDataThirdPartyTicketOrderRefundResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new FilmDataThirdPartyTicketOrderRefundRequest;
$param = new TopApplyRefundOrderParam;
$param->platform="100";
$param->user_id="123123123";
$param->tb_order_id="12345671232112";
$param->ext_user_id="1234567";
$param->ext_order_id="123456743221";
$param->ext_op_role="1";
$param->refund_amount="100";
$param->refund_service_fee="1";
$param->refund_desc="和影院协商一致退款";
$param->platform_email="tpp@alibaba-inc.com";
$param->params="null";
$req->setParam(json_encode($param));
$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=taobao.film.data.third.party.ticket.order.refund' \
-d 'partner_id=apidoc' \
-d 'sign=67A8401D2BDB21A5E8B36C66107C5CDD' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-08+05%3A49%3A48' \
-d 'v=2.0' \
-d 'param=null'

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

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

req.param="数据结构示例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,"taobao.film.data.third.party.ticket.order.refund");
add_param(pRequest,"param","数据结构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('taobao.film.data.third.party.ticket.order.refund', {
	'param':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<film_data_third_party_ticket_order_refund_response>
    <result>
        <return_message>非法参数</return_message>
        <return_code>0</return_code>
        <return_value>
            <status>APPLY_REFUND_SUCCESS</status>
            <message>申请退款成功</message>
        </return_value>
    </result>
</film_data_third_party_ticket_order_refund_response>

{
    "film_data_third_party_ticket_order_refund_response":{
        "result":{
            "return_message":"非法参数",
            "return_code":"0",
            "return_value":{
                "status":"APPLY_REFUND_SUCCESS",
                "message":"申请退款成功"
            }
        }
    }
}

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

taobao.film.data.third.party.ticket.order.refund (淘票票对外退票能力接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ