文档中心 > API类目 > 猫超卡活动API

tmall.supermarket.card.benefits.get (天猫超市-超市卡权益查询)

天猫超市-超市卡权益查询

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
card_benefit_query_request CardBenefitQueryRequest 必须 权益查询请求
  • └ channel_code
  • String
  • 必须
  • channel_code
  • 投放渠道编码

响应参数

名称 类型 示例值 描述
result Result 权益查询结果
  • data
  • CardBenefitResponse
  • 权益信息对象
  • └ channel_code
  • String
  • channel_code
  • 投放渠道编码
  • └ strategy_mode
  • String
  • DRAW
  • 权益获取策略 DRAW=领取模式 LOTTERY=抽奖模式
  • └ benefits
  • String []
  • ["123456789"]
  • 权益编码集合,用于领取模式
  • extra_data_list
  • ExtraData []
  • 拓展属性集合
  • └ key
  • String
  • main_page
  • 拓展属性key
  • └ value
  • String
  • https://xxx.com/xxx.jpg
  • 拓展属性内容
  • └ benefit_name
  • String
  • 礼包
  • 权益名称
  • └ isv_name
  • String
  • isv名称
  • isv名称
  • └ channel_name
  • String
  • 合作渠道名称
  • 合作渠道名称
  • └ callback_url
  • String
  • https://xxx.com/xxx
  • 权益回流承接页地址
  • └ success
  • Boolean
  • true
  • 接口调用是否成功
  • └ error_code
  • String
  • PARAMETER_ERROR
  • 错误编码
  • └ error_msg
  • String
  • channel_code is blank
  • 错误描述

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TmallSupermarketCardBenefitsGetRequest req = new TmallSupermarketCardBenefitsGetRequest();
TmallSupermarketCardBenefitsGetRequest.CardBenefitQueryRequest obj1 = new TmallSupermarketCardBenefitsGetRequest.CardBenefitQueryRequest();
obj1.setChannelCode("channel_code");
req.setCardBenefitQueryRequest(obj1);
TmallSupermarketCardBenefitsGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<tmall_supermarket_card_benefits_get_response>
    <result>
        <data>
            <channel_code>channel_code</channel_code>
            <strategy_mode>DRAW</strategy_mode>
            <benefits>
                <string>[&quot;123456789&quot;]</string>
            </benefits>
            <extra_data_list>
                <extra_data>
                    <key>main_page</key>
                    <value>https://xxx.com/xxx.jpg</value>
                </extra_data>
            </extra_data_list>
            <benefit_name>礼包</benefit_name>
            <isv_name>isv名称</isv_name>
            <channel_name>合作渠道名称</channel_name>
            <callback_url>https://xxx.com/xxx</callback_url>
        </data>
        <success>true</success>
        <error_code>PARAMETER_ERROR</error_code>
        <error_msg>channel_code is blank</error_msg>
    </result>
</tmall_supermarket_card_benefits_get_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

返回
顶部