文档中心 > API类目 > 商家营销中心API

taobao.singletreasure.activity.query (查询活动列表接口)

查询活动列表接口

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
query PageQueryDto 必须 查询对象
  • query
  • ActivityInfoListQueryDto
  • 可选
  • 查询条件请求体
  • └ activity_id
  • Number
  • 可选
  • 98816822
  • 活动 id
  • └ name
  • String
  • 可选
  • 年货价
  • 活动名称
  • └ activity_status
  • Number
  • 可选
  • 1
  • 活动状态 删除:-1;暂停:0;未开始:1;进行中:2;已结束:3
  • └ page_size
  • Number
  • 必须
  • 10
  • 页码,最大为50
  • └ page_number
  • Number
  • 必须
  • 1
  • 页数,从1开始

响应参数

名称 类型 示例值 描述
result ResultDto 返回结果
  • └ message
  • String
  • 成功
  • 错误信息
  • data_list
  • ActivityInfo []
  • 查询结果
  • └ free_post
  • Boolean
  • true
  • 是否包邮
  • └ created_time
  • String
  • 2017-08-08 12:12:12
  • 创建时间
  • └ end_time
  • String
  • 2017-08-08 12:12:12
  • 活动结束时间
  • └ exclude_areas
  • String
  • 91100
  • 不包邮地区
  • └ start_time
  • String
  • 2017-08-08 12:12:12
  • 活动开始时间
  • └ activity_id
  • Number
  • 96560333
  • 套餐 id
  • └ discount_type
  • Number
  • 1
  • 折扣类型,1 为促销价,2 为打折,4 为减钱
  • └ description
  • String
  • 套餐描述
  • 套餐描述
  • └ seller_id
  • Number
  • 120412312312
  • 卖家 id
  • └ name
  • String
  • 年货价
  • 套餐名称
  • └ crowd_id
  • String
  • -1
  • 活动对应生效的人群 id
  • └ promotion_level
  • Number
  • 1
  • 优惠类型,3 为 SKU 级优惠类型,1 为商品级优惠类型
  • └ activity_status
  • Number
  • 1
  • 活动状态
  • └ code
  • Number
  • null
  • 错误编码
  • └ success
  • Boolean
  • false
  • 系统执行是否成功
  • └ page_number
  • Number
  • 1
  • 页码
  • └ total_count
  • Number
  • 100
  • 总数
  • └ size
  • Number
  • 10
  • 返回结果个数

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
SingletreasureActivityQueryRequest req = new SingletreasureActivityQueryRequest();
SingletreasureActivityQueryRequest.PageQueryDto obj1 = new SingletreasureActivityQueryRequest.PageQueryDto();
SingletreasureActivityQueryRequest.ActivityInfoListQueryDto obj2 = new SingletreasureActivityQueryRequest.ActivityInfoListQueryDto();
obj2.setActivityId(98816822L);
obj2.setName("年货价");
obj2.setActivityStatus(1L);
obj1.setQuery(obj2);
obj1.setPageSize(10L);
obj1.setPageNumber(1L);
req.setQuery(obj1);
SingletreasureActivityQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<singletreasure_activity_query_response>
    <result>
        <message>成功</message>
        <data_list>
            <activity_info>
                <free_post>true</free_post>
                <created_time>2017-08-08 12:12:12</created_time>
                <end_time>2017-08-08 12:12:12</end_time>
                <exclude_areas>91100</exclude_areas>
                <start_time>2017-08-08 12:12:12</start_time>
                <activity_id>96560333</activity_id>
                <discount_type>1</discount_type>
                <description>套餐描述</description>
                <seller_id>120412312312</seller_id>
                <name>年货价</name>
                <crowd_id>-1</crowd_id>
                <promotion_level>1</promotion_level>
                <activity_status>1</activity_status>
            </activity_info>
        </data_list>
        <code>null</code>
        <success>false</success>
        <page_number>1</page_number>
        <total_count>100</total_count>
        <size>10</size>
    </result>
</singletreasure_activity_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

返回
顶部