获取支付有礼活动列表API

最新更新时间:2020.06.09 版本说明


商户根据一定过滤条件,查询已创建的支付有礼活动。

接口说明

适用对象:微信支付商户 服务商 渠道商

请求URL:https://api.mch.weixin.qq.com/v3/marketing/paygiftactivity/activities

请求方式:GET

接口规则:https://wechatpay-api.gitbook.io/wechatpay-api-v3


path指该参数为路径参数

query指该参数需在请求URL传参

body指该参数需在请求JSON传参


请求参数

参数名 变量 类型[长度限制] 必填 描述
分页页码 offset int query 分页页码,页面从0开始
示例值:1
分页大小 limit int query 分页大小
特殊规则:最大取值为100,最小为1
示例值:20
活动名称 activity_name string[1,10] query 活动名称,支持模糊搜索
示例值:良品铺子回馈活动
活动状态 activity_status string[1,30] query 活动状态,枚举值:
ACT_STATUS_UNKNOWN:状态未知
CREATE_ACT_STATUS:已创建
ONGOING_ACT_STATUS:运行中
TERMINATE_ACT_STATUS:已终止
STOP_ACT_STATUS:已暂停
OVER_TIME_ACT_STATUS:已过期
CREATE_ACT_FAILED:创建活动失败
示例值:CREATE_ACT_STATUS
奖品类型 award_type string[1,30] query 奖品类型,暂时只支持商家券
BUSIFAVOR:商家券
示例值:BUSIFAVOR

请求示例


https://api.mch.weixin.qq.com/v3/marketing/paygiftactivity/activities?offset=0&limit=10&activity_status=ONGOING_ACT_STATUS
    
{
JAVA示例代码
}
    

返回参数

参数名 变量 类型[长度限制] 必填 描述
+ 结果集 data array 支付有礼活动列表
参数名 变量 类型[长度限制] 必填 描述
活动id activity_id string[1,20] 活动id
示例值:126002309
活动类型 activity_type string[1,24] 活动类型
FULL_SEND_ACT_TYPE:满额送
示例值:FULL_SEND_ACT_TYPE
+ 活动基本信息 activity_base_info object 创建活动时录入的基本信息
参数名 变量 类型[长度限制] 必填 描述
活动名称 activity_name string[1,10] 活动名称
示例值:良品铺子回馈活动
活动副标题 activity_second_title string[1,9] 活动副标题
示例值:海飞丝的券
商户logo merchant_logo_url string[10,128] 可通过《图片上传API》获得图片cdn地址。
示例值:https://tool.oschina.net/regex.jpg
背景颜色 background_color string[1,8] 代金券的背景颜色,可设置10种颜色,颜色取值请参见色卡图,默认为微信支付绿色, 颜色取值为颜色图中的颜色名称。
示例值:Color010
活动开始时间 begin_time string[8,32] 活动开始时间,最长可以配置1年内的活动,活动有效期最长90天,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日13点29分35秒。
示例值:2015-05-20T13:29:35+08:00
活动结束时间 end_time string[1,32] 活动结束时间,最长可以配置1年内的活动,活动有效期最长90天,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日13点29分35秒。
示例值:2015-05-20T13:29:35+08:00
+ 可用时间段 available_periods object 可自定义活动有效时间内可用的多个时间段以及天内时间点
参数名 变量 类型[长度限制] 必填 描述
+ 可用时间 available_time array 可用时间
条目个数限制: [0, 6]
参数名 变量 类型[长度限制] 必填 描述
可用开始时间 begin_time string[1,32] 可用时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日13点29分35秒。
示例值:2015-05-20T13:29:35+08:00
可用结束时间 end_time string[1,32] 可用结束时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日13点29分35秒。
示例值:2015-05-20T13:29:35+08:00
+ 每日可用时间 available_day_time array 每日可用时间
条目个数限制: [0, 6]
参数名 变量 类型[长度限制] 必填 描述
每日可用开始时间 begin_day_time string[1,6] 每日可用开始时间(格式:110000,表示11:00:00)
示例值:110000
每日可用结束时间 end_day_time string[1,6] 每日可用结束时间 (格式:135959,表示13:59:59)
示例值:135959
商户请求单号 out_request_no string[1,128] 商户创建批次凭据号(格式:商户id+日期+流水号),商户侧需保持唯一性,可包含英文字母,数字,|,_,*,-等内容,不允许出现其他不合法符号。
示例值:100002322019090134234sfdf
投放目的 delivery_purpose string[1,14] 投放目的,枚举值:
OFF_LINE_PAY:拉用户回店消费
JUMP_MINI_APP:引导用户前往小程序消费
示例值:OFF_LINE_PAY
商家小程序appid mini_programs_appid string[1,32] 投放目的为跳转小程序时必填
示例值:wx23232232323
商家小程序path mini_programs_path string[1,128] 投放目的为跳转小程序必填
示例值: /path/index/index
+ 活动奖品发放规则 award_send_rule object 奖品派送规则,分别对应满送、阶梯送、满A送B中的一种
参数名 变量 类型[长度限制] 必填 描述
+ 满送活动奖品发放规则 full_send_rule object 满送活动奖品发放规则
参数名 变量 类型[长度限制] 必填 描述
消费金额门槛 transaction_amount_minimum int 消费金额门槛 单位分
特殊规则:最大取值为1000000000
示例值:100
发放内容 send_content string[1,13] 发放内容,可选单张券或礼包,选礼包时奖品限定3-5个
SINGLE_COUPON:单张券
GIFT_PACKAGE:礼包
示例值:SINGLE_COUPON
奖品类型 award_type string[1,10] 奖品类型,暂时只支持商家券
BUSIFAVOR:商家券
示例值:BUSIFAVOR
+ 奖品基本信息列表 award_list array 奖品基本信息列表
条目个数限制:[1, 5]
参数名 变量 类型[长度限制] 必填 描述
代金券批次Id stock_id string[1,20] 代金券批次Id
示例值:98065001
奖品原始图(大图) original_image_url string[10,128] 奖品大图,图片建议尺寸:678像素*232像素,支持JPG、PNG格式; 仅支持通过《图片上传API》接口获取的图片URL地址。
示例值:https://tool.oschina.net/regex.jpg
奖品缩略图(小图) thumbnail_url string[10,128] 奖品小图,图片建议尺寸:120像素*120像素,支持JPG、PNG格式;当选多张券时必填, 仅支持通过《图片上传API》接口获取的图片URL地址。
示例值:https://tool.oschina.net/regex.jpg
发券商户号选项 merchant_option string[1,30] 发券商户号选取规则,支持选择在用券商户或手动输入商户号两种,选择手动时,发券商户号必填(商家券只支持手动输入)
IN_SEVICE_COUPON_MERCHANT:在用券商户号
MANUAL_INPUT_MERCHANT:手动输入发券商户号
示例值:MANUAL_INPUT_MERCHANT
发券商户号 merchant_id_list array 发券商户号,列表
特殊规则:最小字符长度为8,最大为15。
条目个数限制:[0, 500]
示例值:10000022, 10000023
+ 活动高级设置 advanced_setting object 活动参与商户校验失败的原因
示例值:商户与活动创建方不具备父子关系
参数名 变量 类型[长度限制] 必填 描述
投放用户类别 delivery_user_category string[1,30] 投放用户类别,枚举值:
DELIVERY_ALL_PERSON:所有用户;
DELIVERY_MEMBER_PERSON:会员用户
示例值:DELIVERY_MEMBER_PERSON
商家会员appid merchant_member_appid string[1,32] 当投放用户类别为会员用户时必填
示例值:34567890
订单优惠标记 goods_tags array 商户下单时需要传入相同的标记(goods_tag),用户同时符合其他规则才能享受优惠
特殊规则:单个标记最大长度限制15个字符
条目个数限制:[0, 50]
示例值:xxx, yyy
活动状态 activity_status string[1,22] 活动当前状态,枚举值:
ACT_STATUS_UNKNOWN:状态未知
CREATE_ACT_STATUS:已创建
ONGOING_ACT_STATUS:运行中
TERMINATE_ACT_STATUS:已终止
STOP_ACT_STATUS:已暂停
OVER_TIME_ACT_STATUS:已过期
CREATE_ACT_FAILED:创建活动失败
示例值:CREATE_ACT_STATUS
创建商户号 creator_merchant_id string[8,15] 支付有礼活动创建商户的商户号
示例值:1001234567
所属商户号 belong_merchant_id string[8,15] 支付有礼活动所属商户的商户号
示例值:1001234567
活动创建时间 create_time string[1,32] 活动创建时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日13点29分35秒。
示例值:2015-05-20T13:29:35+08:00
活动更新时间 update_time string[1,32] 活动更新时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日13点29分35秒。
示例值:2015-05-20T13:29:35+08:00
总数 total_count int 总数
示例值:245
分页页码 offset int 分页页码
示例值:1
分页大小 limit int 分页大小
特殊规则:最大取值为100,最小为1
示例值:20

返回示例


{
    "data": [
        {
            "activity_base_info": {
                "activity_name": "满减活动",
                "activity_second_title": "满减活动副",
                "background_color": "Color090",
                "begin_time": "2020-06-02T10:00:00+08:00",
                "delivery_purpose": "JUMP_MINI_APP",
                "end_time": "2020-06-02T23:29:35+08:00",
                "merchant_logo_url": "https://wxpaylogo.qpic.cn/wxpaylogo/PiajxSqBRaEI1qUibGfkJ4N3JCS5EmAH5xVmo9iam8msMM0XopTYGDGOQ/0",
                "mini_programs_appid": "wxab8acb865bb1637e",
                "mini_programs_path": "/path/index/index",
                "out_request_no": "100002322020-0602-1047-99"
            },
            "activity_id": "20406354",
            "activity_status": "OVER_TIME_ACT_STATUS",
            "activity_type": "FULL_SEND_ACT_TYPE",
            "advanced_setting": {
                "delivery_user_category": "DELIVERY_ALL_PERSON",
                "goods_tags": [
                    "0602-1047-99"
                ]
            },
            "award_send_rule": {
                "full_send_rule": {
                    "award_list": [
                        {
                            "original_image_url": "https://wxpaylogo.qpic.cn/wxpaylogo/PiajxSqBRaEI1qUibGfkJ4N3JCS5EmAH5xVmo9iam8msMM0XopTYGDGOQ/0",
                            "stock_id": "1263540000000013",
                            "thumbnail_url": "https://wxpaylogo.qpic.cn/wxpaylogo/PiajxSqBRaEI1qUibGfkJ4N3JCS5EmAH5xVmo9iam8msMM0XopTYGDGOQ/0"
                        }
                    ],
                    "award_type": "BUSIFAVOR",
                    "merchant_id_list": [],
                    "merchant_option": "MANUAL_INPUT_MERCHANT",
                    "send_content": "SINGLE_COUPON",
                    "transaction_amount_minimum": 1
                }
            },
            "belong_merchant_id": "1900009251",
            "create_time": "2020-06-02T10:47:26+08:00",
            "creator_merchant_id": "1900009251",
            "update_time": "2020-06-05T10:26:08+08:00"
        },
        {
            "activity_base_info": {
                "activity_name": "满减活动",
                "activity_second_title": "满减活动副",
                "background_color": "Color090",
                "begin_time": "2020-06-01T10:00:00+08:00",
                "delivery_purpose": "JUMP_MINI_APP",
                "end_time": "2020-06-01T23:29:35+08:00",
                "merchant_logo_url": "https://wxpaylogo.qpic.cn/wxpaylogo/PiajxSqBRaEI1qUibGfkJ4N3JCS5EmAH5xVmo9iam8msMM0XopTYGDGOQ/0",
                "mini_programs_appid": "wxab8acb865bb1637e",
                "mini_programs_path": "/path/index/index",
                "out_request_no": "100002322020-0601-1147-99"
            },
            "activity_id": "10406354",
            "activity_status": "OVER_TIME_ACT_STATUS",
            "activity_type": "FULL_SEND_ACT_TYPE",
            "advanced_setting": {
                "delivery_user_category": "DELIVERY_ALL_PERSON",
                "goods_tags": [
                    "0601-1147-99"
                ]
            },
            "award_send_rule": {
                "full_send_rule": {
                    "award_list": [
                        {
                            "original_image_url": "https://wxpaylogo.qpic.cn/wxpaylogo/PiajxSqBRaEI1qUibGfkJ4N3JCS5EmAH5xVmo9iam8msMM0XopTYGDGOQ/0",
                            "stock_id": "1263540000000012",
                            "thumbnail_url": "https://wxpaylogo.qpic.cn/wxpaylogo/PiajxSqBRaEI1qUibGfkJ4N3JCS5EmAH5xVmo9iam8msMM0XopTYGDGOQ/0"
                        }
                    ],
                    "award_type": "BUSIFAVOR",
                    "merchant_id_list": [],
                    "merchant_option": "MANUAL_INPUT_MERCHANT",
                    "send_content": "SINGLE_COUPON",
                    "transaction_amount_minimum": 1
                }
            },
            "belong_merchant_id": "1900009251",
            "create_time": "2020-06-01T11:49:06+08:00",
            "creator_merchant_id": "1900009251",
            "update_time": "2020-06-05T10:26:08+08:00"
        }
    ],
    "total_count": 2
}

    http://2323weixin.qq.com
                                

错误码公共错误码

状态码 错误码 描述 解决方案
500 SYSTEM_ERROR 系统错误 请使用相同参数稍后重新调用
400 PARAM_ERROR 参数错误 根据错误提示,传入正确参数
403 NO_AUTH 商户未被授权 登录商户平台核对,传入正确信息
429 FREQUENCY_LIMITED 频率超限 请求量不要超过接口调用频率限制
400 INVALID_REQUEST 请求参数符合参数格式,但不符合业务规则 根据错误提示,传入符合业务规则的参数
400 MCH_NOT_EXISTS 商户号不存在 请确认发券商户号信息是否有误
404 RESOURCE_NOT_EXISTS 资源不存在或无可用 请确认资源均存在且可用
400 APPID_MCHID_NOT_MATCH appid与mchid不匹配 请确认appid是否正确填写
401 SIGN_ERROR 签名错误或签名信息不完整 登录商户平台核对,传入正确信息

版本说明

关闭
V1.0
2020年06月09日
1. 获取支付有礼活动列表API接口上线

技术咨询

反馈有奖