文档中心 > API类目 > 天猫校园共享前端类目

tmall.xiaoyuan.share.isv.campus.activity.instance.list (活动实例列表)

活动实例列表

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
activity_instance_list_request ActivityInstanceListRequest 必须 入参
  • └ isv
  • String
  • 必须
  • LITTLE_CHAO
  • isv
  • └ business_type
  • String
  • 可选
  • 1
  • 业务类型
  • └ biz_order_id
  • Number
  • 可选
  • 1
  • 订单号
  • └ page_num
  • Number
  • 必须
  • 1
  • 分页参数 --当前页
  • └ page_size
  • Number
  • 必须
  • 10
  • 分页参数 --每页查询数
  • └ order_type_code
  • String
  • 必须
  • ACTIVITY_ORDER
  • 订单类型
  • └ campus_area_code
  • Number
  • 必须
  • 50020
  • 服务区code
  • └ pay_status
  • String
  • 可选
  • PAID
  • 订单状态
  • └ mix_buyer_id
  • String
  • 可选
  • 12
  • 用户加密id
  • └ activity_id
  • Number
  • 可选
  • 12
  • 卡模版id
  • └ pay_time_start
  • String
  • 必须
  • 1
  • 支付开始时间
  • └ pay_time_end
  • String
  • 必须
  • 1
  • 支付结束时间
  • └ phone
  • String
  • 可选
  • 123
  • 用户手机号
  • └ status
  • String
  • 可选
  • 123
  • 卡实例状态

响应参数

名称 类型 示例值 描述
result Result 出参
  • └ code
  • String
  • 1
  • code
  • └ success
  • Boolean
  • true
  • 是否成功
  • └ msg
  • String
  • 1
  • msg
  • data
  • IsvActivityInstanceListResponse []
  • 优惠实例集合
  • └ biz_order_id
  • Number
  • 12
  • 订单号
  • └ pay_time
  • String
  • 12
  • 支付时间
  • └ mix_buyer_id
  • String
  • 1
  • 用户id
  • └ campus_area_code
  • Number
  • 1
  • 服务区code
  • └ campus_area_name
  • String
  • 123
  • 服务区名称
  • └ activity_id
  • Number
  • 123
  • 活动id
  • └ activity_name
  • String
  • 123
  • 活动名称
  • └ payment_channel
  • String
  • 1233
  • 下单渠道
  • └ pay_status
  • String
  • 23
  • 订单状态
  • └ payment_amount
  • String
  • 12
  • 支付金额 单位元
  • └ rest_coupon_quota
  • Number
  • 1
  • 剩余次数
  • └ effective_end_time
  • String
  • 1234
  • 有效期时间
  • └ status
  • String
  • 123
  • 活动实例状态
  • └ single_discount_money
  • String
  • 123424
  • 单次抵扣最大金额
  • └ total_num
  • Number
  • 123
  • 查询总数
  • └ page_num
  • Number
  • 123
  • 当前页

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TmallXiaoyuanShareIsvCampusActivityInstanceListRequest req = new TmallXiaoyuanShareIsvCampusActivityInstanceListRequest();
TmallXiaoyuanShareIsvCampusActivityInstanceListRequest.ActivityInstanceListRequest obj1 = new TmallXiaoyuanShareIsvCampusActivityInstanceListRequest.ActivityInstanceListRequest();
obj1.setIsv("LITTLE_CHAO");
obj1.setBusinessType("1");
obj1.setBizOrderId(1L);
obj1.setPageNum(1L);
obj1.setPageSize(10L);
obj1.setOrderTypeCode("ACTIVITY_ORDER");
obj1.setCampusAreaCode(50020L);
obj1.setPayStatus("PAID");
obj1.setMixBuyerId("12");
obj1.setActivityId(12L);
obj1.setPayTimeStart("1");
obj1.setPayTimeEnd("1");
obj1.setPhone("123");
obj1.setStatus("123");
req.setActivityInstanceListRequest(obj1);
TmallXiaoyuanShareIsvCampusActivityInstanceListResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<tmall_xiaoyuan_share_isv_campus_activity_instance_list_response>
    <result>
        <code>1</code>
        <success>true</success>
        <msg>1</msg>
        <data>
            <isv_activity_instance_list_response>
                <biz_order_id>12</biz_order_id>
                <pay_time>12</pay_time>
                <mix_buyer_id>1</mix_buyer_id>
                <campus_area_code>1</campus_area_code>
                <campus_area_name>123</campus_area_name>
                <activity_id>123</activity_id>
                <activity_name>123</activity_name>
                <payment_channel>1233</payment_channel>
                <pay_status>23</pay_status>
                <payment_amount>12</payment_amount>
                <rest_coupon_quota>1</rest_coupon_quota>
                <effective_end_time>1234</effective_end_time>
                <status>123</status>
                <single_discount_money>123424</single_discount_money>
            </isv_activity_instance_list_response>
        </data>
        <total_num>123</total_num>
        <page_num>123</page_num>
    </result>
</tmall_xiaoyuan_share_isv_campus_activity_instance_list_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

返回
顶部