獲取支付有禮活動(dòng)列表API
最新更新時(shí)間：2020.06.09 版本說(shuō)明
商戶根據(jù)一定過(guò)濾條件，查詢(xún)已創(chuàng)建的支付有禮活動(dòng)。
接口說(shuō)明
適用對(duì)象：直連商戶
請(qǐng)求URL：https://api.mch.weixin.qq.com/v3/marketing/paygiftactivity/activities
請(qǐng)求方式：GET
path指該參數(shù)為路徑參數(shù)
query指該參數(shù)需在請(qǐng)求URL傳參
body指該參數(shù)需在請(qǐng)求JSON傳參
請(qǐng)求參數(shù)
| 參數(shù)名 | 變量 | 類(lèi)型[長(zhǎng)度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 分頁(yè)頁(yè)碼 | offset | int | 是 | query 分頁(yè)頁(yè)碼，頁(yè)面從0開(kāi)始 示例值：1 |
| 分頁(yè)大小 | limit | int | 是 | query 分頁(yè)大小 特殊規(guī)則：最大取值為100，最小為1 示例值：20 |
| 活動(dòng)名稱(chēng) | activity_name | string[1,10] | 否 | query 活動(dòng)名稱(chēng)，支持模糊搜索 示例值：良品鋪?zhàn)踊仞伝顒?dòng) |
| 活動(dòng)狀態(tài) | activity_status | string[1,32] | 否 | query 活動(dòng)狀態(tài)，枚舉值： ACT_STATUS_UNKNOWN：狀態(tài)未知 CREATE_ACT_STATUS：已創(chuàng)建 ONGOING_ACT_STATUS：運(yùn)行中 TERMINATE_ACT_STATUS：已終止 STOP_ACT_STATUS：已暫停 OVER_TIME_ACT_STATUS：已過(guò)期 CREATE_ACT_FAILED：創(chuàng)建活動(dòng)失敗 示例值：CREATE_ACT_STATUS |
| 獎(jiǎng)品類(lèi)型 | award_type | string[1,10] | 否 | query 獎(jiǎng)品類(lèi)型，暫時(shí)只支持商家券 BUSIFAVOR：商家券 示例值：BUSIFAVOR |
請(qǐng)求示例
https://api.mch.weixin.qq.com/v3/marketing/paygiftactivity/activities?offset=0&limit=10&activity_status=ONGOING_ACT_STATUS
返回參數(shù)
| 參數(shù)名 | 變量 | 類(lèi)型[長(zhǎng)度限制] | 必填 | 描述 |
|---|---|---|---|---|
| + 結(jié)果集 | data | array | 否 | 支付有禮活動(dòng)列表 |
| 總數(shù) | total_count | int | 否 | 總數(shù) 示例值：245 |
| 分頁(yè)頁(yè)碼 | offset | int | 是 | 分頁(yè)頁(yè)碼 示例值：1 |
| 分頁(yè)大小 | limit | int | 是 | 分頁(yè)大小 特殊規(guī)則：最大取值為100，最小為1 示例值：20 |
卡券背景顏色圖
返回示例
{
"data": [
{
"activity_base_info": {
"activity_name": "滿減活動(dòng)",
"activity_second_title": "滿減活動(dòng)副",
"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": "滿減活動(dòng)",
"activity_second_title": "滿減活動(dòng)副",
"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
}錯(cuò)誤碼公共錯(cuò)誤碼
| 狀態(tài)碼 | 錯(cuò)誤碼 | 描述 | 解決方案 |
|---|---|---|---|
| 500 | SYSTEM_ERROR | 系統(tǒng)錯(cuò)誤 | 請(qǐng)使用相同參數(shù)稍后重新調(diào)用 |
| 400 | PARAM_ERROR | 參數(shù)錯(cuò)誤 | 根據(jù)錯(cuò)誤提示，傳入正確參數(shù) |
| 403 | NO_AUTH | 商戶未被授權(quán) | 登錄商戶平臺(tái)核對(duì)，傳入正確信息 |
| 429 | FREQUENCY_LIMITED | 頻率超限 | 請(qǐng)求量不要超過(guò)接口調(diào)用頻率限制 |
| 400 | INVALID_REQUEST | 請(qǐng)求參數(shù)符合參數(shù)格式，但不符合業(yè)務(wù)規(guī)則 | 根據(jù)錯(cuò)誤提示，傳入符合業(yè)務(wù)規(guī)則的參數(shù) |
| 400 | MCH_NOT_EXISTS | 商戶號(hào)不存在 | 請(qǐng)確認(rèn)發(fā)券商戶號(hào)信息是否有誤 |
| 404 | RESOURCE_NOT_EXISTS | 資源不存在或無(wú)可用 | 請(qǐng)確認(rèn)資源均存在且可用 |
| 400 | APPID_MCHID_NOT_MATCH | appid與mchid不匹配 | 請(qǐng)確認(rèn)appid是否正確填寫(xiě) |
| 401 | SIGN_ERROR | 簽名錯(cuò)誤或簽名信息不完整 | 登錄商戶平臺(tái)核對(duì)，傳入正確信息 |