淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
verify_request	VoucherVerifyRequest	必须			入参
└ voucher_code String 必须 C_1234 券码 └ verify_store_code String 必须 CSMD 核销门店 └ verify_token String 必须 1705658263367 核销幂等id └ voucher_certificates String [] 必须 ["123","111"] 券凭证列表 └ operator String 必须 test 操作人 └ channel_code Number 必须 4 来源

名称	类型	示例值	描述
result	ResultDTO		出参
└ success Boolean false 结果 └ err_code String SYSTEM_ERROR 错误码 └ err_msg String 系统错误错误信息 model VoucherDTO [] 券对象 └ merchant_code String CSSJ 商家编码 └ store_code String CSMD 经营店编码 └ voucher_code String C_1234 券码 └ voucher_certificate String 1234 券凭证 └ voucher_id Number 1234 券ID └ voucher_type Number 2 券类型，1. 自提券 2. 代金券 └ status Number 0 券状态，-1-已取消 0-未核销 10-已核销-可取消 20-核销确认-不可取消

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaTxdVoucherVerificateRequest req = new AlibabaTxdVoucherVerificateRequest();
AlibabaTxdVoucherVerificateRequest.VoucherVerifyRequest obj1 = new AlibabaTxdVoucherVerificateRequest.VoucherVerifyRequest();
obj1.setVoucherCode("C_1234");
obj1.setVerifyStoreCode("CSMD");
obj1.setVerifyToken("1705658263367");
obj1.setVoucherCertificates(""123","111"");
obj1.setOperator("test");
obj1.setChannelCode(4L);
req.setVerifyRequest(obj1);
AlibabaTxdVoucherVerificateResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaTxdVoucherVerificateRequest req = new AlibabaTxdVoucherVerificateRequest();
AlibabaTxdVoucherVerificateRequest.VoucherVerifyRequestDomain obj1 = new AlibabaTxdVoucherVerificateRequest.VoucherVerifyRequestDomain();
obj1.VoucherCode = "C_1234";
obj1.VerifyStoreCode = "CSMD";
obj1.VerifyToken = "1705658263367";
obj1.VoucherCertificates = ""123","111"";
obj1.Operator = "test";
obj1.ChannelCode = 4L;
req.VerifyRequest_ = obj1;
AlibabaTxdVoucherVerificateResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaTxdVoucherVerificateRequest;
$verify_request = new VoucherVerifyRequest;
$verify_request->voucher_code="C_1234";
$verify_request->verify_store_code="CSMD";
$verify_request->verify_token="1705658263367";
$verify_request->voucher_certificates="[\"123\",\"111\"]";
$verify_request->operator="test";
$verify_request->channel_code="4";
$req->setVerifyRequest(json_encode($verify_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.verificate' \
-d 'partner_id=apidoc' \
-d 'session=e2cb12e4-4e72-47bb-b042-705cdcf8f27f' \
-d 'sign=B4627CC1DE9D3AF2FF4416EA91E35186' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+15%3A06%3A06' \
-d 'v=2.0' \
-d 'verify_request=null'

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

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

req.verify_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.verificate");
add_param(pRequest,"verify_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.verificate', {
	'verify_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_txd_voucher_verificate_response>
    <result>
        <success>false</success>
        <err_code>SYSTEM_ERROR</err_code>
        <err_msg>系统错误</err_msg>
        <model>
            <voucher_d_t_o>
                <merchant_code>CSSJ</merchant_code>
                <store_code>CSMD</store_code>
                <voucher_code>C_1234</voucher_code>
                <voucher_certificate>1234</voucher_certificate>
                <voucher_id>1234</voucher_id>
                <voucher_type>2</voucher_type>
                <status>0</status>
            </voucher_d_t_o>
        </model>
    </result>
</alibaba_txd_voucher_verificate_response>

{
    "alibaba_txd_voucher_verificate_response":{
        "result":{
            "success":false,
            "err_code":"SYSTEM_ERROR",
            "err_msg":"系统错误",
            "model":{
                "voucher_d_t_o":[
                    {
                        "merchant_code":"CSSJ",
                        "store_code":"CSMD",
                        "voucher_code":"C_1234",
                        "voucher_certificate":"1234",
                        "voucher_id":1234,
                        "voucher_type":2,
                        "status":0
                    }
                ]
            }
        }
    }
}

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.verificate (根据券ID核销)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ