淘宝开放平台 - 文档中心

请求地址：

环境	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	TopQueryBCouponParam	必须			请求体
└ user_id Number 必须 2214644900787 用户id └ order_id String 必须 3995836057073908707 券包订单号 └ ext_order_id String 必须 18276842559063 外部订单号

名称	类型	示例值	描述
result	ResultGeneralModel		result
return_value TopQueryBCouponResult returnValue └ order_id String 3995836057073908707 券包订单号 └ status String TRADE_SUCCESS 券订单状态 └ code String 2M62DRGMFGH 券码 └ code_status Number 0 未使用 └ ext_order_id String 123456789 文鱼外部订单号 └ item_expire_time Date 1723691754000 券过期时间 └ return_code String 0 0代表接口调用成功，其他值表示调用失败，错误信息可详见message和接口文档 └ return_message String 非法参数调用失败描述信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
FilmDataThirdPartyQueryBcouponitemorderRequest req = new FilmDataThirdPartyQueryBcouponitemorderRequest();
FilmDataThirdPartyQueryBcouponitemorderRequest.TopQueryBCouponParam obj1 = new FilmDataThirdPartyQueryBcouponitemorderRequest.TopQueryBCouponParam();
obj1.setUserId(2214644900787L);
obj1.setOrderId("3995836057073908707");
obj1.setExtOrderId("18276842559063");
req.setParam(obj1);
FilmDataThirdPartyQueryBcouponitemorderResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
FilmDataThirdPartyQueryBcouponitemorderRequest req = new FilmDataThirdPartyQueryBcouponitemorderRequest();
FilmDataThirdPartyQueryBcouponitemorderRequest.TopQueryBCouponParamDomain obj1 = new FilmDataThirdPartyQueryBcouponitemorderRequest.TopQueryBCouponParamDomain();
obj1.UserId = 2214644900787L;
obj1.OrderId = "3995836057073908707";
obj1.ExtOrderId = "18276842559063";
req.Param_ = obj1;
FilmDataThirdPartyQueryBcouponitemorderResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new FilmDataThirdPartyQueryBcouponitemorderRequest;
$param = new TopQueryBCouponParam;
$param->user_id="2214644900787";
$param->order_id="3995836057073908707";
$param->ext_order_id="18276842559063";
$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.query.bcouponitemorder' \
-d 'partner_id=apidoc' \
-d 'sign=5CCCD2BE08ED278204478E80BA05C406' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-08+07%3A21%3A07' \
-d 'v=2.0' \
-d 'param=null'

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

req=top.api.FilmDataThirdPartyQueryBcouponitemorderRequest(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.query.bcouponitemorder");
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.query.bcouponitemorder', {
	'param':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<film_data_third_party_query_bcouponitemorder_response>
    <result>
        <return_value>
            <order_id>3995836057073908707</order_id>
            <status>TRADE_SUCCESS</status>
            <code>2M62DRGMFGH</code>
            <code_status>0</code_status>
            <ext_order_id>123456789</ext_order_id>
            <item_expire_time>1723691754000</item_expire_time>
        </return_value>
        <return_code>0</return_code>
        <return_message>非法参数</return_message>
    </result>
</film_data_third_party_query_bcouponitemorder_response>

{
    "film_data_third_party_query_bcouponitemorder_response":{
        "result":{
            "return_value":{
                "order_id":"3995836057073908707",
                "status":"TRADE_SUCCESS",
                "code":"2M62DRGMFGH",
                "code_status":0,
                "ext_order_id":"123456789",
                "item_expire_time":"1723691754000"
            },
            "return_code":"0",
            "return_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.query.bcouponitemorder (淘票票对外查询能力-查询分销券包接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ