文档中心 > API类目 > 零售终端API

tmall.nrt.coupontemplate.query (券模板查询)

新零售场景,商家拉取在新零售工作台设置的券数据

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
coupon_type_list Number [] 必须 1,2
  • 最大列表长度:20
  • 券列表
    current_page Number 可选 1
  • 默认值:1
  • 当前页
    page_size Number 可选 10
  • 默认值:10
  • 每页数据数量
    biz_code String 必须 YXXX 业务code阿里指定

    响应参数

    名称 类型 示例值 描述
    message String 非法参数 错误message
    model PageData null model
    • └ current_page
    • Number
    • 1
    • 当前页
    • data_list
    • CouponTemplateDto []
    • 1
    • 数据列表
    • └ channel
    • String
    • app
    • 渠道
    • └ coupon_name
    • String
    • 测试券
    • 券名称
    • └ coupon_type
    • Number
    • 1
    • 券type
    • └ creator
    • String
    • 1we
    • 创建钉钉ID
    • └ discount
    • Number
    • 1
    • 面额
    • └ id
    • Number
    • 23ewwe
    • 券模板ID
    • └ item_ids
    • Number []
    • 1
    • 圈选商品列表
    • └ mall_ids
    • Number []
    • 1
    • 圈选卖场列表
    • └ modified_by
    • String
    • 111
    • 修改钉钉ID
    • └ send_end_time
    • Date
    • null
    • 发放结束时间yyyy-MM-dd HH:mm:ss
    • └ send_start_time
    • Date
    • null
    • 发放开始时间yyyy-MM-dd HH:mm:ss
    • └ start_fee
    • Number
    • 1
    • 门槛
    • └ status
    • Number
    • 1
    • 状态
    • └ store_ids
    • Number []
    • [1]
    • 圈选门店列表
    • └ use_end_time
    • Date
    • null
    • 使用结束时间:yyyy-MM-dd HH:mm:ss
    • └ use_start_time
    • Date
    • null
    • 使用开始时间:yyyy-MM-dd HH:mm:ss
    • └ use_time
    • Number
    • 1
    • 领取后可以使用的相对时间,秒或天为单位
    • └ use_time_type
    • Number
    • 1
    • 使用时间类型
    • └ uuid
    • String
    • asdadd
    • 发券code
    • └ version
    • Number
    • 1
    • 版本号
    • └ seller_id
    • Number
    • 1212
    • 卖家ID
    • └ coupon_template_id
    • Number
    • 1212
    • 券模板ID
    • └ page_size
    • Number
    • 1
    • 1

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    TmallNrtCoupontemplateQueryRequest req = new TmallNrtCoupontemplateQueryRequest();
    req.setCouponTypeList("1,2");
    req.setCurrentPage(1L);
    req.setPageSize(10L);
    req.setBizCode("YXXX");
    TmallNrtCoupontemplateQueryResponse rsp = client.execute(req, sessionKey);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <tmall_nrt_coupontemplate_query_response>
        <message>非法参数</message>
        <model>
            <current_page>1</current_page>
            <data_list>
                <coupon_template_dto>
                    <channel>app</channel>
                    <coupon_name>测试券</coupon_name>
                    <coupon_type>1</coupon_type>
                    <creator>1we</creator>
                    <discount>1</discount>
                    <id>23ewwe</id>
                    <item_ids>
                        <number>1</number>
                    </item_ids>
                    <mall_ids>
                        <number>1</number>
                    </mall_ids>
                    <modified_by>111</modified_by>
                    <send_end_time>null</send_end_time>
                    <send_start_time>null</send_start_time>
                    <start_fee>1</start_fee>
                    <status>1</status>
                    <store_ids>
                        <number>[1]</number>
                    </store_ids>
                    <use_end_time>null</use_end_time>
                    <use_start_time>null</use_start_time>
                    <use_time>1</use_time>
                    <use_time_type>1</use_time_type>
                    <uuid>asdadd</uuid>
                    <version>1</version>
                    <seller_id>1212</seller_id>
                    <coupon_template_id>1212</coupon_template_id>
                </coupon_template_dto>
            </data_list>
            <page_size>1</page_size>
        </model>
    </tmall_nrt_coupontemplate_query_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

    返回
    顶部