淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
query_request	VoucherQueryRequest	必须			入参
└ voucher_id Number 必须 1234 券ID └ channel_code Number 必须 4 来源

名称	类型	示例值	描述
result	ResultDTO		出参
└ success Boolean false 结果 └ err_code String SYSTEM_ERROR 错误码 └ err_msg String 系统错误错误信息 model VoucherDTO 券对象 └ biz_order_id String biz_123 淘鲜达业务主单号 └ start_time Number 1705654919445 生效开始时间 └ end_time Number 1705654919445 生效结束时间 └ association_skus String [] ["sku_123"] 关联实物商品编码 └ voucher_rule String {\"bookRule\":\"无需预约\",\"otherRule\":\"11\",\"refundRule\":\"随时可退、过期自动退，已核销的到店券不享受随时可退服务\",\"useTime\":\"到店核销，营业时间内可用\"} 券规则 └ voucher_id Number 123 券ID └ voucher_certificate String 123 券凭证 └ voucher_type Number 2 券类型，1. 自提券 2. 代金券 └ voucher_code String C_1234 券码 └ voucher_platform Number 0 核销码平台类型，0:默认内部电子凭证服务 1:三方码 └ status Number 0 券状态，-1-已取消 0-未核销 10-已核销-可取消 20-核销确认-不可取消 └ app_store_codes String CSMD,TEST_STORE 适用门店 └ confirm_period Number 3600 核销确认期限，单位秒 └ verify_store_code String CSMD 核销门店 └ verify_operator String system 核销人 └ verify_time Number 1706077696104 核销时间 └ verify_confirm_time Number 1706077696104 核销确认时间 └ cancel_time Number 1706077696104 核销撤销时间

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaTxdVoucherGetRequest req = new AlibabaTxdVoucherGetRequest();
AlibabaTxdVoucherGetRequest.VoucherQueryRequest obj1 = new AlibabaTxdVoucherGetRequest.VoucherQueryRequest();
obj1.setVoucherId(1234L);
obj1.setChannelCode(4L);
req.setQueryRequest(obj1);
AlibabaTxdVoucherGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaTxdVoucherGetRequest req = new AlibabaTxdVoucherGetRequest();
AlibabaTxdVoucherGetRequest.VoucherQueryRequestDomain obj1 = new AlibabaTxdVoucherGetRequest.VoucherQueryRequestDomain();
obj1.VoucherId = 1234L;
obj1.ChannelCode = 4L;
req.QueryRequest_ = obj1;
AlibabaTxdVoucherGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaTxdVoucherGetRequest;
$query_request = new VoucherQueryRequest;
$query_request->voucher_id="1234";
$query_request->channel_code="4";
$req->setQueryRequest(json_encode($query_request));
$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=alibaba.txd.voucher.get' \
-d 'partner_id=apidoc' \
-d 'session=7c370bc2-29fb-449e-8e53-a365c24cab77' \
-d 'sign=817DF6CE8516A46A8AA856ABD3A456B1' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+15%3A23%3A59' \
-d 'v=2.0' \
-d 'query_request=null'

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

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

req.query_request="数据结构示例JSON格式"
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,"alibaba.txd.voucher.get");
add_param(pRequest,"query_request","数据结构JSON示例");
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('alibaba.txd.voucher.get', {
	'query_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_txd_voucher_get_response>
    <result>
        <success>false</success>
        <err_code>SYSTEM_ERROR</err_code>
        <err_msg>系统错误</err_msg>
        <model>
            <biz_order_id>biz_123</biz_order_id>
            <start_time>1705654919445</start_time>
            <end_time>1705654919445</end_time>
            <association_skus>
                <string>[&quot;sku_123&quot;]</string>
            </association_skus>
            <voucher_rule>{\&quot;bookRule\&quot;:\&quot;无需预约\&quot;,\&quot;otherRule\&quot;:\&quot;11\&quot;,\&quot;refundRule\&quot;:\&quot;随时可退、过期自动退，已核销的到店券不享受随时可退服务\&quot;,\&quot;useTime\&quot;:\&quot;到店核销，营业时间内可用\&quot;}</voucher_rule>
            <voucher_id>123</voucher_id>
            <voucher_certificate>123</voucher_certificate>
            <voucher_type>2</voucher_type>
            <voucher_code>C_1234</voucher_code>
            <voucher_platform>0</voucher_platform>
            <status>0</status>
            <app_store_codes>CSMD,TEST_STORE</app_store_codes>
            <confirm_period>3600</confirm_period>
            <verify_store_code>CSMD</verify_store_code>
            <verify_operator>system</verify_operator>
            <verify_time>1706077696104</verify_time>
            <verify_confirm_time>1706077696104</verify_confirm_time>
            <cancel_time>1706077696104</cancel_time>
        </model>
    </result>
</alibaba_txd_voucher_get_response>

{
    "alibaba_txd_voucher_get_response":{
        "result":{
            "success":false,
            "err_code":"SYSTEM_ERROR",
            "err_msg":"系统错误",
            "model":{
                "biz_order_id":"biz_123",
                "start_time":1705654919445,
                "end_time":1705654919445,
                "association_skus":{
                    "string":[
                        "[\"sku_123\"]"
                    ]
                },
                "voucher_rule":"{\\\"bookRule\\\":\\\"无需预约\\\",\\\"otherRule\\\":\\\"11\\\",\\\"refundRule\\\":\\\"随时可退、过期自动退，已核销的到店券不享受随时可退服务\\\",\\\"useTime\\\":\\\"到店核销，营业时间内可用\\\"}",
                "voucher_id":123,
                "voucher_certificate":"123",
                "voucher_type":2,
                "voucher_code":"C_1234",
                "voucher_platform":0,
                "status":0,
                "app_store_codes":"CSMD,TEST_STORE",
                "confirm_period":3600,
                "verify_store_code":"CSMD",
                "verify_operator":"system",
                "verify_time":1706077696104,
                "verify_confirm_time":1706077696104,
                "cancel_time":1706077696104
            }
        }
    }
}

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.txd.voucher.get (券信息查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ