文档中心 > API类目 > 五道口API

alibaba.txd.voucher.verification.cancel (券撤销核销)

券撤销核销

公共参数

请求地址：

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
cancel_request	VoucherVerifyCancelRequest	必须			入参
└ voucher_certificate String 必须 123 券凭证列表 └ voucher_code String 必须 C_1234 券码 └ cancel_token String 必须 1705658263367 取消唯一幂等键 └ operator String 必须 test 操作人 └ channel_code Number 必须 4 来源

响应参数

名称	类型	示例值	描述
result	ResultDTO		出参
└ success String false 结果 └ err_code String SYSTEM_ERROR 错误码 └ err_msg String 系统错误错误信息

请求示例

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaTxdVoucherVerificationCancelRequest req = new AlibabaTxdVoucherVerificationCancelRequest();
AlibabaTxdVoucherVerificationCancelRequest.VoucherVerifyCancelRequest obj1 = new AlibabaTxdVoucherVerificationCancelRequest.VoucherVerifyCancelRequest();
obj1.setVoucherCertificate("123");
obj1.setVoucherCode("C_1234");
obj1.setCancelToken("1705658263367");
obj1.setOperator("test");
obj1.setChannelCode(4L);
req.setCancelRequest(obj1);
AlibabaTxdVoucherVerificationCancelResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

XML示例
JSON示例

<alibaba_txd_voucher_verification_cancel_response>
    <result>
        <success>false</success>
        <err_code>SYSTEM_ERROR</err_code>
        <err_msg>系统错误</err_msg>
    </result>
</alibaba_txd_voucher_verification_cancel_response>

异常示例

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>

错误码解释

错误码	错误描述	解决方案

API工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

淘宝开放平台

五道口API

alibaba.txd.voucher.verification.cancel (券撤销核销)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ