注意:以下文档只适用于TOP接口,请谨慎使用!

文档中心 > API类目 > 电子物流API

taobao.vmarket.eticket.consume (电子票券消费通知)

外部合作商家电子票券消费回调接口

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
order_id Number 必须 1231223333 进行验码的电子凭证订单的订单ID
verify_code String 必须 abc 核销的码,只支持单个码,多个码核销需要多次调用
consume_num Number 必须 1 核销份数
token String 必须 ca2bf41f1910a9c359370ebf87caeafd 安全验证token,需要和发码通知中的token一致
codemerchant_id Number 可选 2054573190 码商ID,是码商的话必须传递,如果是信任卖家不需要传
posid String 可选 20111958201 机具ID(此参数信任卖家可不传递,码商必须传递)
mobile String 可选 1234 手机后四位(没有特殊说明请不要传该参数)
new_code String 可选 abc 核销后需要重新生成的码,如果不需要重新生成码,不要传该参数
serial_num String 可选 abc 自定义核销流水号,如果核销调用失败,可以用该核销流水号进行冲正操作,需要小于等于100个字符(a-zA-Z0-9_);每次核销都是唯一的流水号
qr_images String 可选 111.png 不需要上传二维码图片或者核销后不需重新生成码码商请不要传,需要传入二维码的码商请先调用taobao.vmarket.eticket.qrcode.upload接口,将返回的img_filename文件名称作为参数(如果二维码不变的话,也可将将发码时传入二维码文件名作为参数传入),文件名与参数new_code必须相互对应。

响应参数

名称 类型 示例值 描述
ret_code Number 1 0:失败,1:成功
left_num Number 0 整个订单剩余的可核销数量
item_title String 诺基亚N73 宝贝标题
sms_tpl String 您在淘宝网购买的诺基亚N73的电子凭证号:$code,在当前的时间2012-03-27 11:58已经使用,如有疑问请联系:淘宝客服(0571-88158198)! 返回码消费后,需要发送的短信的模版
print_tpl String 商品名称:诺基亚N73 数量:3 合计:2199.9元 本次提取的数量:1. 服务内容,用在凭证验证成功后pos机打印小票给消费者
consume_secial_num String 13222222222 核销流水号,可以通过该流水号来撤销对应的核销操作
code_left_num Number 1 该核销码在核销后剩余的可核销份数,如果传了new_code来重新生成码,那么这些可核销份数会累积到新的码上

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
VmarketEticketConsumeRequest req = new VmarketEticketConsumeRequest();
req.setOrderId(1231223333L);
req.setVerifyCode("abc");
req.setConsumeNum(1L);
req.setToken("ca2bf41f1910a9c359370ebf87caeafd");
req.setCodemerchantId(2054573190L);
req.setPosid("20111958201");
req.setMobile("1234");
req.setNewCode("abc");
req.setSerialNum("abc");
req.setQrImages("111.png");
VmarketEticketConsumeResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<vmarket_eticket_consume_response>
    <ret_code>1</ret_code>
    <left_num>0</left_num>
    <item_title>诺基亚N73</item_title>
    <sms_tpl>您在淘宝网购买的诺基亚N73的电子凭证号:$code,在当前的时间2012-03-27 11:58已经使用,如有疑问请联系:淘宝客服(0571-88158198)!</sms_tpl>
    <print_tpl>商品名称:诺基亚N73  数量:3  合计:2199.9元  本次提取的数量:1.</print_tpl>
    <consume_secial_num>13222222222</consume_secial_num>
    <code_left_num>1</code_left_num>
</vmarket_eticket_consume_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>

错误码解释

错误码 错误描述 解决方案
isv.missing-parameter:code 缺少码参数 调用接口的时候必须传递码参数
isv.eticket-order-not-found:invalid-orderid 传递的订单ID参数找不到对应的电子凭证订单信息 传递正确的订单ID参数
isv.eticket-order-status-error:invalid-order-status 此状态的订单不允许进行核销码操作 检查订单状态,只有已发货或者交易成功的订单才能进行核销码的操作
isv.eticket-privilege-error:order-not-belongto-seller 订单不属于用户授权登录的卖家,卖家没有权限操作这个订单 检查用户授权是否生效,并且授权的用户是否和订单所属的店铺的用户一致
isv.eticket-code-not-found:invalid-code 电子凭证平台中找不到要核销的码 检查码的有效性,如果是有效的码,调用重发接口更新电子凭证平台存储的码,然后调用核销接口重新验码
isv.eticket-code-status-invalid:invalid-code-status 码状态验证失败,不允许进行核销操作 检查码是否已经使用过
isv.eticket-service-unavailable:op-failed 服务异常 重新调用
isv.eticket-code-error:code-not-in-valid-time 要验证的码不再有效期范围内 检查该码是否在有效的兑换期内
isv.eticket-order-consume-num:consume-num-invalid 核销次数错误 检查是否输入了错误的核销次数:如0,-1,-3等非正整数
isv.eticket-order-consume-num:consume-num-overflow 请求核销次数大于该码的实际剩余可核销次数 不允许进行验码
isv.missing-parameter:token 缺少token参数 传递token参数
isv.eticket-token-error:invalid-token 错误的token 使用正确的token
isv.eticket-invalid-code-merchant:invalid-code-merchant 码商身份校验不通过 传递正确的码商ID
isv.eticket-invalid-parameter:invalid-posid 码商没传递机具ID 或 传递了错误的posid(如posid=0) 传递正确的关联网点的机具ID
isv.eticket-invalid-posid:invalid-pos-for-codemerchant 机具ID校验不通过:机具不属于该码商 或 码商没关联该机具 传递正确的且已经关联了网点的机具ID
isv.eticket-seller-error:invalid-eticket-seller 信任卖家身份校验不通过 请确认已经成功签署或补签过电子交易凭证入驻协议
isv.eticket-error-for-validate:some-validation-is-not-pass 一些通用校验没通过 请传递相关正确的参数
isv.eticket-service-unavailable:order-is-processing 订单并发操作并发限制 等待一段时间后调用
isv.eticket-consume-error:code-not-available 该码不能进行核销 检查code参数
isv.eticket-invalid-parameter:invalid-consume-serial-num 自定义核销流水号格式错误 必须是a-zA-Z0-9_的字母组成,长度不能超过100,不能以tbeticketsn_开头
isv.eticket-invalid-parameter:duplicate-consume-serial-num 重复的自定义核销流水号 每次核销都必须使用唯一的核销流水号
isv.eticket-privilege-error:no-upload-qrimage-rights 码商没有上传二维码图片权限 请先开通二维码上传权限
isv.eticket-qrimage-error:num-error 码商二维码图片数量不对 请保持与码一一对应
isv.eticket-order-posID:posid-not-bind posid 机具ID 码商后台关联机具ID
isv.eticket-reverse-error:invalid-reverse-parameter 冲正参数校验异常 验证参数正确性
isv.eticket-vertical-error:vertical-error 订单数据获取异常 重试
isv.eticket-code-error:consume-multiple-times 多次核销,不允许操作 不允许对此码再进行核销

API工具

如何获得此API

FAQ

返回
顶部