查询活动列表

更新时间:2024.09.29

查询符合条件的多个活动

# 接口说明

支持商户: 【普通商户】

请求方式: 【GET】

请求URL: /v3/marketing/membercard-activity/activities

# 请求参数

    Query 查询参数
  • limit 选填 int
    【最大资源条数】 该次请求可返回的最大资源条数
  • offset 选填 int
    【请求资源起始位置】 该次请求资源的起始位置
  • activity_type 必填 string(32)
    【活动类型】 活动类型:
    NON_MEMBER_AFTERPAY:支付后开卡有礼活动(说明:非会员用户在商户侧消费完成后,可曝光在微信支付成功页面的开卡有礼活动)
    MEMBER_AFTERPAY:支付后老会员有礼活动 (会员用户在商户侧消费完成后,可曝光在微信支付成功页面的老会员有礼活动)
    NON_MEMBER_MINIPROGRAM:支付前场景开卡有礼活动(说明:覆盖扫码/小程序场景,对于非会员用户,访问开卡组件时可看到开卡有礼活动信息,开卡后获得对应优惠券)
    MEMBER_MINIPROGRAM:支付前场景老会员有礼活动(说明:覆盖扫码/小程序场景,对于会员用户,访问开卡组件时可直接获得活动设置的优惠券)
  • card_id 选填 string(32)
    【会员卡ID】 商户创建微信会员卡模板成功后系统返回的会员卡ID
  • activity_status 选填 string(16)
    【活动的当前状态】 动的当前状态:
    CREATED:已创建,调用创建活动API成功后该活动状态
    ONGOING:运行中,当活动正式开始的时候活动状态
    TERMINATED:已终止,调用终止活动API接口活动状态变
    OVER_TIME:已过期,当前活动时间超过结束时间

# 返回参数

  • data 选填 array
    【请求资源起始位置】 活动的详情,包括此资源的所有定义
    • 数组
  • offset 选填 int
    【请求资源起始位置】 该次请求资源的起始位置,同请求的
  • limit 选填 int
    【最大资源条数】 该次请求可返回的最大资源条数
  • total_count 选填 int
    【资源总条数】 可选返回,资源总条数。当offset=0或者当前查询为空时应该返回总条数。如果系统性能允许时,建议返回。

请求示例

1https://api.mch.weixin.qq.com/v3/marketing/membercard-activity/activities?limit=5&offset=10&activity_type=NON_MEMBER_AFTERPAY&card_id=pbLatjvWOibDc5-TBnbUk1pD12o0&activity_status=ONGOIN

返回示例

1{
2 "data": [{
3 "activity_id": "371067",
4 "activity_status": "ONGOING",
5 "create_time": "2015-05-20T13:29:35.120+08:00",
6 "update_time": "2015-05-20T13:29:35.120+08:00",
7 "card_id": "pbLatjvWOibDc5-TBnbUk1pD12o0",
8 "activity_name": "良品铺子回馈活动",
9 "activity_type": "NON_MEMBER_AFTERPAY",
10 "begin_time": "2020-01-20T13:29:35.120+08:00",
11 "end_time": "2020-01-29T13:29:35.120+08:00",
12 "award_send_period": {
13 "award_send_time": [{
14 "begin_time": "2020-01-21T00:00:00.000+08:00",
15 "end_time": "2020-01-27T00:00:00.000+08:00"
16 }],
17 "award_send_day_time": [{
18 "begin_day_time": {
19 "hours": 9,
20 "minutes": 34,
21 "seconds": 6
22 },
23 "end_day_time": {
24 "hours": 9,
25 "minutes": 34,
26 "seconds": 6
27 }
28 }]
29 },
30 "stock_list": [{
31 "stock_creator_mchid": "10000022",
32 "stock_id": "98065001"
33 }],
34 "out_request_no": "100002322019090134234sfdf",
35 "pay_activity_setting": {
36 "logo_url": "https://wxpaylogo.qpic.cn/wxpaylogo/PiajxSqBRaEIPAeia7Imvtsn7sYGNcEj33YzVvJF88ECQ19LXId8ZL2Q/0",
37 "activity_second_title": "湖南麻辣美食券",
38 "mchid_list": [
39 "10000022",
40 "10000023"
41 ],
42 "activate_setting": {
43 "activate_type": "AUTO_ACTIVATE",
44 "activate_url": "https://w.url.cn/s/Ahz3p2C",
45 "activate_miniprogram": {
46 "activate_appid": "wxea9c30a90fs8d3fe",
47 "activate_path": "pages/activate/activate"
48 }
49 },
50 "payment_setting": {
51 "payment_mode": {
52 "payment_scene_list": [
53 "APP"
54 ]
55 },
56 "limit_bank": "CFT",
57 "goods_tags": [
58 "xxx",
59 "yyy"
60 ]
61 },
62 "miniprogram_activity_setting": {
63 "outer_str": [
64 "领取渠道1",
65 "领取渠道2"
66 ],
67 "award_jump_deploy": {
68 "mini_program_appid": "wxc0b84a53ed8e8d29",
69 "mini_program_path": "mall/pages/List",
70 "button_text": "点击"
71 }
72 }
73 }
74 }],
75 "offset": 10,
76 "limit": 5,
77 "total_count": 1234
78}

# 错误码

# 公共错误码

状态码 错误码 描述 解决方案
400 PARAM_ERROR 参数错误 请根据错误提示正确传入参数
400 INVALID_REQUEST HTTP 请求不符合微信支付 APIv3 接口规则 请参阅 接口规则
401 SIGN_ERROR 验证不通过 请参阅 签名常见问题
500 SYSTEM_ERROR 系统异常,请稍后重试 请稍后重试

# 业务错误码

状态码 错误码 描述 解决方案
403 NO_AUTH 商户暂无权限使用此功能 请开通商户号权限。请联系产品或商务申请
400 INVALID_REQUEST 活动创建方未被授权发放此商家券批次 请先调用API授权活动创建方发放当前商家券批次
400 INVALID_REQUEST 活动曝光商户号需要绑定到会员卡品牌 请先将活动商户号绑定到品牌
400 INVALID_REQUEST 活动创建方需要和会员卡归属品牌号绑定 请先将活动创建方商户号绑定到品牌
400 INVALID_REQUEST 请先升级会员卡才能使用此功能 请先调用《升级会员卡API》升级会员卡
400 INVALID_REQUEST 当前会员卡是实时传入code模式,不支持 请更换非实时code模式的会员卡再重试
反馈
咨询
目录