创建活动
更新时间:2023.11.28创建会员活动,通过接口创建不同类型的会员活动,可以创建支付后开卡有礼、支付后老会员有礼,以及小程序开卡有礼、小程序老会员有礼,共4种类型的活动。
# 接口说明
支持商户: 【普通服务商】
请求方式: 【POST】 请求URL: /v3/marketing/membercard-activity/activities
# 请求参数
- card_id 必填【会员卡ID】 商户创建微信会员卡模板成功后系统返回的会员卡ID
- activity_name 必填【活动名称】 活动名称,用于内部管理,不对外展示。不超过10个字符
- activity_type 必填活动类型 活动类型:NON_MEMBER_AFTERPAY:支付后开卡有礼活动(说明:非会员用户在商户侧消费完成后,可曝光在微信支付成功页面的开卡有礼活动)MEMBER_AFTERPAY:支付后老会员有礼活动 (会员用户在商户侧消费完成后,可曝光在微信支付成功页面的老会员有礼活动)NON_MEMBER_MINIPROGRAM:支付前场景开卡有礼活动(说明:覆盖扫码/小程序场景,对于非会员用户,访问开卡组件时可看到开卡有礼活动信息,开卡后获得对应优惠券)MEMBER_MINIPROGRAM:支付前场景老会员有礼活动(说明:覆盖扫码/小程序场景,对于会员用户,访问开卡组件时可直接获得活动设置的优惠券)
- begin_time 必填【活动开始时间】 活动开始时间,最长可以配置1年内的活动,活动有效期最长90天遵循rfc3339
标准格式,格式为yyyy-MM-DDTHH:mm:ss.sss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss.sss表示时分秒毫秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35.120+08:00表示北京时间2015年05月20日13点29分35秒。 - end_time 必填【会员卡背景图】 活动结束时间,最长可以配置1年内的活动,活动有效期最长90天遵循rfc3339
标准格式,格式为yyyy-MM-DDTHH:mm:ss.sss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss.sss表示时分秒毫秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35.120+08:00表示北京时间2015年05月20日13点29分35秒。 - award_send_period 选填【发放时间段】 活动时段,可选择活动有效期内部分日期或部分时间段
- 属性
- stock_list 必填【array】 发放的优惠券,一个活动最多支持发放3个批次
- 数组
- out_request_no 必填【商户请求单号】 商户凭据号。商户自定义,注意保持唯一性,仅供参考的格式:商户ID+日期+流水号。可包含英文字母,数字,|,_,*,-等内容,不允许出现其他不合法符号。
- pay_activity_setting 选填【支付后活动设置】 支付后活动的相关配置。当活动类型是NON_MEMBER_AFTERPAY或者MEMBER_AFTERPAY时,必填
- 属性
- miniprogram_activity_setting 选填【支付前会员活动设置】 支付前会员活动设置,当活动类型为:NON_MEMBER_MINIPROGRAM或MEMBER_MINIPROGRAM时,可选填
- 属性
Body 包体参数
# 返回参数
- activity_id 必填【活动ID】 活动的当前状态
- activity_status 必填【活动的当前状态】 活动的当前状态:CREATED:已创建,调用创建活动API成功后该活动状态ONGOING:运行中,当活动正式开始的时候活动状态TERMINATED:已终止,调用终止活动API接口活动状态变化OVER_TIME:已过期,当前活动时间超过结束时间
- create_time 选填【创建时间】 创建时间,遵循rfc3339
标准格式,格式为yyyy-MM-DDTHH:mm:ss.sss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss.sss表示时分秒毫秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35.120+08:00表示北京时间2015年05月20日13点29分35秒。 - update_time 选填【更新时间】 更新时间,遵循rfc3339
标准格式,格式为yyyy-MM-DDTHH:mm:ss.sss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss.sss表示时分秒毫秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35.120+08:00表示北京时间2015年05月20日13点29分35秒。 - card_id 选填【会员卡ID】 商户创建微信会员卡模板成功后系统返回的会员卡ID
- activity_name 选填【活动名称】 活动名称,用于内部管理,不对外展示
- activity_type 选填【活动类型】 活动类型:NON_MEMBER_AFTERPAY:支付后开卡有礼活动(说明:非会员用户在商户侧消费完成后,可曝光在微信支付成功页面的开卡有礼活动)MEMBER_AFTERPAY:支付后老会员有礼活动 (会员用户在商户侧消费完成后,可曝光在微信支付成功页面的老会员有礼活动)NON_MEMBER_MINIPROGRAM:支付前场景开卡有礼活动(说明:覆盖扫码/小程序场景,对于非会员用户,访问开卡组件时可看到开卡有礼活动信息,开卡后获得对应优惠券)MEMBER_MINIPROGRAM:支付前场景老会员有礼活动(说明:覆盖扫码/小程序场景,对于会员用户,访问开卡组件时可直接获得活动设置的优惠券)
- begin_time 选填【活动开始时间】 活动开始时间,最长可以配置1年内的活动,活动有效期最长90天遵循rfc3339
标准格式,格式为yyyy-MM-DDTHH:mm:ss.sss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss.sss表示时分秒毫秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35.120+08:00表示北京时间2015年05月20日13点29分35秒。 - end_time 选填【活动结束时间】 活动结束时间,最长可以配置1年内的活动,活动有效期最长90天遵循rfc3339
标准格式,格式为yyyy-MM-DDTHH:mm:ss.sss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss.sss表示时分秒毫秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35.120+08:00表示北京时间2015年05月20日13点29分35秒。 - award_send_period 选填【发放时间段】 活动时段,可选择活动有效期内部分日期或部分时间段
- 属性
- stock_list 选填【优惠券列表】 发放的优惠券,一个活动最多支持发放3个批次
- 数组
- out_request_no 选填【商户请求单号】 商户凭据号。商户自定义,注意保持唯一性,仅供参考的格式:商户ID+日期+流水号。可包含英文字母,数字,|,_,*,-等内容,不允许出现其他不合法符号。
- pay_activity_setting 选填【支付后活动设置】
- 属性
- miniprogram_activity_setting 选填【支付前会员活动设置】 支付前会员活动设置,当活动类型为:NON_MEMBER_MINIPROGRAM或MEMBER_MINIPROGRAM时,可选填
- 属性
请求示例
1{2 "card_id": "pbLatjvWOibDc5-TBnbUk1pD12o0",3 "activity_name": "良品铺子回馈活动",4 "activity_type": "NON_MEMBER_AFTERPAY",5 "begin_time": "2020-01-20T13:29:35.120+08:00",6 "end_time": "2020-01-29T13:29:35.120+08:00",7 "award_send_period": {8 "award_send_time": [9 {10 "begin_time": "2020-01-21T00:00:00.000+08:00",11 "end_time": "2020-01-27T00:00:00.000+08:00"12 }13 ],14 "award_send_day_time":[15 {16 "begin_day_time": {17 "hours": 9,18 "minutes": 34,19 "seconds": 620 },21 "end_day_time": {22 "hours": 9,23 "minutes": 34,24 "seconds": 625 }26 }27 ]28 },29 "stock_list": [30 {31 "stock_creator_mchid": "10000022",32 "stock_id": "98065001"33 }34 ],35 "out_request_no": "100002322019090134234sfdf",36 "pay_activity_setting": {37 "logo_url": "https://wxpaylogo.qpic.cn/wxpaylogo/PiajxSqBRaEIPAeia7Imvtsn7sYGNcEj33YzVvJF88ECQ19LXId8ZL2Q/0",38 "activity_second_title": "湖南麻辣美食券",39 "mchid_list": [40 "10000022",41 "10000023"42 ],43 "activate_setting": {44 "activate_type": "AUTO_ACTIVATE",45 "activate_url": "https://w.url.cn/s/Ahz3p2C",46 "activate_miniprogram": {47 "activate_appid": "wxea9c30a90fs8d3fe",48 "activate_path": "pages/activate/activate"49 }50 },51 "payment_setting": {52 "payment_mode": {53 "payment_scene_list": [54 "APP"55 ]},56 "limit_bank": "CFT",57 "goods_tags": [58 "xxx",59 "yyy"60 ]61 }62 },63 "miniprogram_activity_setting": {64 "outer_str": [65 "领取渠道1",66 "领取渠道2"67 ],68 "award_jump_deploy": {69 "mini_program_appid": "wxc0b84a53ed8e8d29",70 "mini_program_path": "mall/pages/List",71 "button_text": "点击"72 }73 }74 }
返回示例
1{2 "activity_id": "371067",3 "activity_status": "ONGOING",4 "create_time": "2015-05-20T13:29:35.120+08:00",5 "update_time": "2015-05-20T13:29:35.120+08:00",6 "card_id": "pbLatjvWOibDc5-TBnbUk1pD12o0",7 "activity_name": "良品铺子回馈活动",8 "activity_type": "NON_MEMBER_AFTERPAY",9 "begin_time": "2020-01-20T13:29:35.120+08:00",10 "end_time": "2020-01-29T13:29:35.120+08:00",11 "award_send_period": {12 "award_send_time": [{13 "begin_time": "2020-01-21T00:00:00.000+08:00",14 "end_time": "2020-01-27T00:00:00.000+08:00"15 }],16 "award_send_day_time": [{17 "begin_day_time": {18 "hours": 9,19 "minutes": 34,20 "seconds": 621 },22 "end_day_time": {23 "hours": 9,24 "minutes": 34,25 "seconds": 626 }27 }]28 },29 "stock_list": [{30 "stock_creator_mchid": "10000022",31 "stock_id": "98065001"32 }],33 "out_request_no": "100002322019090134234sfdf",34 "pay_activity_setting": {35 "logo_url": "https://wxpaylogo.qpic.cn/wxpaylogo/PiajxSqBRaEIPAeia7Imvtsn7sYGNcEj33YzVvJF88ECQ19LXId8ZL2Q/0",36 "activity_second_title": "湖南麻辣美食券",37 "mchid_list": ["10000022", "10000023"],38 "activate_setting": {39 "activate_type": "AUTO_ACTIVATE",40 "activate_url": "https://w.url.cn/s/Ahz3p2C",41 "activate_miniprogram": {42 "activate_appid": "wxea9c30a90fs8d3fe",43 "activate_path": "pages/activate/activate"44 }45 },46 "payment_setting": {47 "payment_mode": {48 "payment_scene_list": ["APP"]49 },50 "limit_bank": "CFT",51 "goods_tags": ["xxx", "yyy"]52 }53 },54 "miniprogram_activity_setting": {55 "outer_str": ["领取渠道1", "领取渠道2"],56 "award_jump_deploy": {57 "mini_program_appid": "wxc0b84a53ed8e8d29",58 "mini_program_path": "mall/pages/List",59 "button_text": "点击"60 }61 }62}
# 错误码
# 公共错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
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模式的会员卡再重试 |
400 | INVALID_REQUEST | 需要上架至少一个积分权益、优惠权益、服务才可以投放 | 请先给会员卡上架至少一个积分权益、优惠权益、服务 |
文档是否有帮助