接口说明
适用对象：服务商
请求URL：https://api.mch.weixin.qq.com/v3/marketing/paygiftactivity/activities
请求方式：GET
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,32] | 否 | 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,10] | 否 | query 奖品类型，暂时只支持商家券 BUSIFAVOR：商家券 示例值：BUSIFAVOR |
请求示例
https://api.mch.weixin.qq.com/v3/marketing/paygiftactivity/activities?offset=0&limit=10&activity_status=ONGOING_ACT_STATUS
返回参数
| 参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
|---|---|---|---|---|
| + 结果集 | data | array | 否 | 支付有礼活动列表 |
| 总数 | total_count | int | 否 | 总数 示例值：245 |
| 分页页码 | offset | int | 是 | 分页页码 示例值：1 |
| 分页大小 | limit | int | 是 | 分页大小 特殊规则：最大取值为100，最小为1 示例值：20 |
卡券背景颜色图
返回示例
{
"data": [
{
"activity_base_info": {
"activity_name": "满减活动",
"activity_second_title": "满减活动副",
"background_color": "COLOR010",
"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": "COLOR010",
"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,
"offset": 1,
"limit": 20
}错误码公共错误码
| 状态码 | 错误码 | 描述 | 解决方案 |
|---|---|---|---|
| 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 | 签名错误或签名信息不完整 | 登录商户平台核对，传入正确信息 |