淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
mix_id	String	必须	code_8ebc4e741689bbc1	码商品混淆ID
partner_code	String	必须	xuexiqiangguo	渠道编码
operate_type	String	必须	ALL	操作类型(ALL-全量拉取，CONSUME-核销拉取)
params	Json	可选		扩展参数

名称	类型	示例值	描述
result	ResultGeneralModel		系统自动生成
└ return_code String 0 返回码 └ return_message String 返回码文案说明 return_value FCodeExportResp FCodeExportResp FCodeExportResp basic FCodeExportBasic FCodeExportBasic FCodeExportBasic └ bind_begin_time Date 2019-12-01 00:00:00 绑定兑换开始时间 └ coupon_expire_time Date 2019-12-02 23:59:59 券码过期时间(不允许绑定) └ denomination Number 400 面值(单位：分) └ max_bind_count Number 4 用户可绑定最大数量限制(空不限制) └ mix_id String code_8ebc4e741689bbc1 混淆ID └ name String 淘票票示例活动名称 └ total_count Number 100 券码总数量 └ valid_days Number 1 有效天数 └ valid_duration_type String DAY 券码有效期类型(GENERAL-固定日期、DAY-有效天数） └ description String 券码描述券码描述 coupon_list FCodeInfo [] FCodeInfo FCodeInfo └ code String 2X2QFKTZD2K 优惠券明码 └ code_status Number 2 券码状态(-2:已失效,-1:过期,0:正常,2:核销) └ gmt_modified Date 2019-12-02 23:59:59 券变更时间 └ bind_status Number -1 绑定状态(-1:未绑定,0:已绑定) └ has_next Boolean true 是否存在下一页 └ last_sequence Number 1 分页游标参数 └ current_rows Number 100 当前返回数量

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
FilmFcodeExportQueryRequest req = new FilmFcodeExportQueryRequest();
req.setMixId("code_8ebc4e741689bbc1");
req.setPartnerCode("xuexiqiangguo");
req.setOperateType("ALL");
req.setParamsString("");
FilmFcodeExportQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
FilmFcodeExportQueryRequest req = new FilmFcodeExportQueryRequest();
req.MixId = "code_8ebc4e741689bbc1";
req.PartnerCode = "xuexiqiangguo";
req.OperateType = "ALL";
req.Params = "";
FilmFcodeExportQueryResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new FilmFcodeExportQueryRequest;
$req->setMixId("code_8ebc4e741689bbc1");
$req->setPartnerCode("xuexiqiangguo");
$req->setOperateType("ALL");
$req->setParams("");
$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=taobao.film.fcode.export.query' \
-d 'partner_id=apidoc' \
-d 'session=839a8547-be33-45c2-a225-6451a72b91ee' \
-d 'sign=7E5C6115A8D89DEB9C16B21C65D88971' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-08+06%3A06%3A28' \
-d 'v=2.0' \
-d 'mix_id=code_8ebc4e741689bbc1' \
-d 'operate_type=ALL' \
-d 'params=null' \
-d 'partner_code=xuexiqiangguo'

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

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

req.mix_id="code_8ebc4e741689bbc1"
req.partner_code="xuexiqiangguo"
req.operate_type="ALL"
req.params=""
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,"taobao.film.fcode.export.query");
add_param(pRequest,"mix_id","code_8ebc4e741689bbc1");
add_param(pRequest,"partner_code","xuexiqiangguo");
add_param(pRequest,"operate_type","ALL");
add_param(pRequest,"params","");
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('taobao.film.fcode.export.query', {
	'mix_id':'code_8ebc4e741689bbc1',
	'partner_code':'xuexiqiangguo',
	'operate_type':'ALL',
	'params':''
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<film_fcode_export_query_response>
    <result>
        <return_code>0</return_code>
        <return_message></return_message>
        <return_value>
            <basic>
                <bind_begin_time>2019-12-01 00:00:00</bind_begin_time>
                <coupon_expire_time>2019-12-02 23:59:59</coupon_expire_time>
                <denomination>400</denomination>
                <max_bind_count>4</max_bind_count>
                <mix_id>code_8ebc4e741689bbc1</mix_id>
                <name>淘票票示例活动</name>
                <total_count>100</total_count>
                <valid_days>1</valid_days>
                <valid_duration_type>DAY</valid_duration_type>
                <description>券码描述</description>
            </basic>
            <coupon_list>
                <f_code_info>
                    <code>2X2QFKTZD2K</code>
                    <code_status>2</code_status>
                    <gmt_modified>2019-12-02 23:59:59</gmt_modified>
                    <bind_status>-1</bind_status>
                </f_code_info>
            </coupon_list>
            <has_next>true</has_next>
            <last_sequence>1</last_sequence>
            <current_rows>100</current_rows>
        </return_value>
    </result>
</film_fcode_export_query_response>

{
    "film_fcode_export_query_response":{
        "result":{
            "return_code":"0",
            "return_message":"",
            "return_value":{
                "basic":{
                    "bind_begin_time":"2019-12-01 00:00:00",
                    "coupon_expire_time":"2019-12-02 23:59:59",
                    "denomination":400,
                    "max_bind_count":4,
                    "mix_id":"code_8ebc4e741689bbc1",
                    "name":"淘票票示例活动",
                    "total_count":100,
                    "valid_days":1,
                    "valid_duration_type":"DAY",
                    "description":"券码描述"
                },
                "coupon_list":{
                    "f_code_info":[
                        {
                            "code":"2X2QFKTZD2K",
                            "code_status":2,
                            "gmt_modified":"2019-12-02 23:59:59",
                            "bind_status":-1
                        }
                    ]
                },
                "has_next":true,
                "last_sequence":1,
                "current_rows":100
            }
        }
    }
}

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.fcode.export.query (券码数据导出查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ