淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
order_id_list	String	必须	[1]		订单Id列表

名称	类型	示例值	描述
result	QueryCertificateResp []		凭证查询结果
└ refund_num Number 1 凭证退款数 └ biz_type Number 3001 业务类型 └ unverified_num Number 1 凭证未使用数 └ lock_num Number 1 凭证锁定数 └ last_consume_time Date 1710172719000 最新核销时间 └ total_num Number 1 凭证总数 └ last_send_time Date 1710172719000 最新发码时间 └ outer_id String 1 业务单号 └ query_fail_reason String null 查询错误的原因 └ used_num Number 1 凭证使用个数 certificate_list CertificateResp [] 对外的凭证传输对象 └ locked_num Number 1 凭证锁定数 └ biz_type Number 3001 业务类型 └ code_type String 1 凭证类型 └ last_send_time Date 1710172719000 最新发码时间 └ initial_num Number 1 初始可用数 └ available_num Number 1 可用数 └ cancel_num Number 1 普通作废数量 └ code_status Number 1 码状态 └ last_consume_time Date 1710172719000 最新核销时间 └ outer_id String 1 业务单号 └ start_time Date 1710172719000 有效期开始时间 └ id Number 1 码的ID └ end_time Date 1710172719000 有效期结束时间 └ used_num Number 1 凭证使用个数 └ over_due_num Number 1 凭证过期数

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlitripHotelMiOrderCertificateQueryRequest req = new AlitripHotelMiOrderCertificateQueryRequest();
req.setOrderIdList("[1]");
AlitripHotelMiOrderCertificateQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlitripHotelMiOrderCertificateQueryRequest req = new AlitripHotelMiOrderCertificateQueryRequest();
req.OrderIdList = "[1]";
AlitripHotelMiOrderCertificateQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlitripHotelMiOrderCertificateQueryRequest;
$req->setOrderIdList("[1]");
$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=alitrip.hotel.mi.order.certificate.query' \
-d 'partner_id=apidoc' \
-d 'sign=791ADB93CDD202E69E8125EE8BDAD5AB' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-12+10%3A22%3A05' \
-d 'v=2.0' \
-d 'order_id_list=1'

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

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

req.order_id_list="[1]"
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,"alitrip.hotel.mi.order.certificate.query");
add_param(pRequest,"order_id_list","1");
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('alitrip.hotel.mi.order.certificate.query', {
	'order_id_list':'1'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alitrip_hotel_mi_order_certificate_query_response>
    <result>
        <query_certificate_resp>
            <refund_num>1</refund_num>
            <biz_type>3001</biz_type>
            <unverified_num>1</unverified_num>
            <lock_num>1</lock_num>
            <last_consume_time>1710172719000</last_consume_time>
            <total_num>1</total_num>
            <last_send_time>1710172719000</last_send_time>
            <outer_id>1</outer_id>
            <query_fail_reason>null</query_fail_reason>
            <used_num>1</used_num>
            <certificate_list>
                <certificate_resp>
                    <locked_num>1</locked_num>
                    <biz_type>3001</biz_type>
                    <code_type>1</code_type>
                    <last_send_time>1710172719000</last_send_time>
                    <initial_num>1</initial_num>
                    <available_num>1</available_num>
                    <cancel_num>1</cancel_num>
                    <code_status>1</code_status>
                    <last_consume_time>1710172719000</last_consume_time>
                    <outer_id>1</outer_id>
                    <start_time>1710172719000</start_time>
                    <id>1</id>
                    <end_time>1710172719000</end_time>
                    <used_num>1</used_num>
                </certificate_resp>
            </certificate_list>
            <over_due_num>1</over_due_num>
        </query_certificate_resp>
    </result>
</alitrip_hotel_mi_order_certificate_query_response>

{
    "alitrip_hotel_mi_order_certificate_query_response":{
        "result":{
            "query_certificate_resp":[
                {
                    "refund_num":1,
                    "biz_type":3001,
                    "unverified_num":1,
                    "lock_num":1,
                    "last_consume_time":"1710172719000",
                    "total_num":1,
                    "last_send_time":"1710172719000",
                    "outer_id":"1",
                    "query_fail_reason":"null",
                    "used_num":1,
                    "certificate_list":{
                        "certificate_resp":[
                            {
                                "locked_num":1,
                                "biz_type":3001,
                                "code_type":"1",
                                "last_send_time":"1710172719000",
                                "initial_num":1,
                                "available_num":1,
                                "cancel_num":1,
                                "code_status":1,
                                "last_consume_time":"1710172719000",
                                "outer_id":"1",
                                "start_time":"1710172719000",
                                "id":1,
                                "end_time":"1710172719000",
                                "used_num":1
                            }
                        ]
                    },
                    "over_due_num":1
                }
            ]
        }
    }
}

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.hotel.mi.order.certificate.query (查询电子凭证订单核销信息)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ