文档中心 > API类目 > 本地生活商户基础API

alibaba.alsc.daodian.ticket.consult (券码预览)

券码预览

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
consult_request TicketConsultTopRequest 必须 券码咨询请求
  • └ request_id
  • String
  • 必须
  • f82d968ccc884077b180cff21d7fef17
  • 请求id
  • └ shop_id
  • String
  • 必须
  • 2017112100077000000046517463
  • 本地门店id,长度32位
  • └ ticket_code
  • String
  • 必须
  • 523162942005
  • 券码code

响应参数

名称 类型 示例值 描述
result Result 返回结构体
  • └ success
  • Boolean
  • true
  • 处理结果是否成功,true为成功,false为失败
  • └ error_code
  • String
  • TICKET_CODE_INVALID
  • 错误码,success=false时有效
  • value
  • TicketConsultResponse
  • 结构体
  • └ user_phone
  • String
  • 175****4139
  • 脱敏手机号,例:*******4139。如果商品类目未开放电话组件,不返回数据
  • └ available_quantity
  • Number
  • 2
  • 剩余可核销数量。团购举例:购买2份团购券,已核销了1份,该属性返回1;次卡举例:购买了3次卡,已核销1次,该属性返回2
  • ticket_info_list
  • TicketInfo []
  • 券码所属订单下,可使用的凭证(同商品)列表
  • └ ticket_id
  • String
  • 2208211121312608720
  • 凭证ID。核销接口入参
  • └ ticket_name
  • String
  • 洗剪吹xxx
  • 下单时的商品名称
  • └ total_amount
  • Number
  • 100
  • 凭证金额,单位分。如果是团购,为单份凭证的金额(对应商品售价,不是商品原价,不能作为代金券抵扣金额);如果是N次次卡,则为N次卡的总金额,N 对应quantity值
  • └ real_amount
  • Number
  • 100
  • 商户实收金额(抽佣前),单位分。团购和次卡场景,解释同total_amount。公式:凭证金额-实收金额=商户优惠金额
  • └ quantity
  • Number
  • 1
  • 团购场景,固定为1,购买多份与此值无关;次卡场景,例如3次卡,该属性返回3
  • └ ticket_code
  • String
  • 508839727941
  • 凭证券码。仅入参券码对应的凭证会返回该值,其余凭证此属性无返回值
  • └ original_price
  • Number
  • 9900
  • 购买时商品的原价(次卡是多次的总原价),单位分
  • └ buyer_id
  • String
  • AAH05d-EAAeGwJWdwSLqJ3qJ
  • 混淆后的用户uid。查询订单接口用
  • └ alsc_order_no
  • String
  • 2208281071920082803
  • 本地订单-主单号。长度:19位
  • └ alsc_sub_order_no
  • String
  • 2208288968219782803
  • 本地订单-子单号。长度:19位
  • └ item_id
  • String
  • 687787036030
  • 口碑商品id
  • └ out_item_id
  • String
  • 56789
  • 外部商品id
  • └ error_msg
  • String
  • 券码不存在
  • 错误文案,success=false时有效

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlscDaodianTicketConsultRequest req = new AlibabaAlscDaodianTicketConsultRequest();
AlibabaAlscDaodianTicketConsultRequest.TicketConsultTopRequest obj1 = new AlibabaAlscDaodianTicketConsultRequest.TicketConsultTopRequest();
obj1.setRequestId("f82d968ccc884077b180cff21d7fef17");
obj1.setShopId("2017112100077000000046517463");
obj1.setTicketCode("523162942005");
req.setConsultRequest(obj1);
AlibabaAlscDaodianTicketConsultResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_alsc_daodian_ticket_consult_response>
    <result>
        <success>true</success>
        <error_code>TICKET_CODE_INVALID</error_code>
        <value>
            <user_phone>175****4139</user_phone>
            <available_quantity>2</available_quantity>
            <ticket_info_list>
                <ticket_info>
                    <ticket_id>2208211121312608720</ticket_id>
                    <ticket_name>洗剪吹xxx</ticket_name>
                    <total_amount>100</total_amount>
                    <real_amount>100</real_amount>
                    <quantity>1</quantity>
                    <ticket_code>508839727941</ticket_code>
                    <original_price>9900</original_price>
                </ticket_info>
            </ticket_info_list>
            <buyer_id>AAH05d-EAAeGwJWdwSLqJ3qJ</buyer_id>
            <alsc_order_no>2208281071920082803</alsc_order_no>
            <alsc_sub_order_no>2208288968219782803</alsc_sub_order_no>
            <item_id>687787036030</item_id>
            <out_item_id>56789</out_item_id>
        </value>
        <error_msg>券码不存在</error_msg>
    </result>
</alibaba_alsc_daodian_ticket_consult_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

FAQ

返回
顶部