条件查询活动列表

通过此接口可查询多个活动的摘要信息。

错误码

公共错误码

业务错误码

状态码	错误码	错误描述	解决方案
400	SYSTEM_ERROR	服务器异常	可能发生了网络或者系统异常，导致服务调用失败，商户可以用同样的请求发起重试
400	INVALID_PARAMETER	参数有误参数非法	请根据接口返回的参数非法的具体错误信息，修改参数后进行重试。

curl --location --request POST 'http://dev-cn.your-api-server.com/v3/alipay/marketing/activity/batchquery' \ --header 'authorization: ALIPAY-SHA256withRSA app_id=$appid,timestamp=$now,nonce=$uuid,expired_seconds=600,sign=$sign' \ --header 'alipay-request-id: $requestid' \ --header 'Content-Type: application/json' \ --data-raw '{ "merchant_id":"2088202967380463", "activity_status":"ACTIVE", "page_num":1, "page_size":20, "merchant_access_mode":"SELF_MODE" }'

{ "activity_lite_infos":[ { "activity_base_info":{ "activity_id":"2016042700826004508401111111", "belong_merchant_info":{ "merchant_id":"2088102111111111" }, "activity_status":"ACTIVE" }, "voucher_deduct_info":{ "voucher_type":"FIX_VOUCHER", "fix_voucher_info":{ "amount":"50.00", "floor_amount":"1000.00" }, "discount_voucher_info":{ "discount":"6.5", "ceiling_amount":"50.00", "floor_amount":"1000.00" }, "special_voucher_info":{ "special_amount":"10.00", "floor_amount":"1000.00" }, "exchange_voucher_info":{ "amount":"100.00", "floor_amount":"1000.00", "biz_type":"GROUP_BUY_EXCHANGE_VOUCHER" } }, "voucher_display_pattern_info":{ "brand_name":"商家优惠", "brand_logo_url":"https://gw.alipayobjects.com/mdn/rms_9822d7/afts/img/A*1F4eSaaPHRQAAAAAAAAAAABkARQnAQ" }, "voucher_available_scope_info":{ "voucher_available_goods_info":{ "goods_name":"美味甜甜圈", "origin_amount":"100.00" } } } ], "page_num":2, "page_size":20, "total_size":"200" }

请求参数

Header 参数

authorization

string

必需

示例值:

ALIPAY-SHA256withRSA app_id=$appid,timestamp=$now,nonce=$uuid,expired_seconds=600,sign=$sign

alipay-request-id

string

必需

示例值:

$requestid

Content-Type

string

必需

示例值:

application/json

Body 参数application/json

merchant_id

string

可选

商户PID,默认为当前接口调用商户。限制: 接口调用者必须有商户代运营权限。代运营授权流程https://opendocs.alipay.com/mini/01hm6i#%E4%BB%A3%E8%BF%90%E8%90%A5%E6%8E%88%E6%9D%83 注意事项接口调用者必须有商户代运营权限。代运营授权流程https://opendocs.alipay.com/mini/01hm6i#%E4%BB%A3%E8%BF%90%E8%90%A5%E6%8E%88%E6%9D%83

activity_status

string

可选

活动状态。ACTIVE:活动已激活，表示活动已经生效，等到活动开始(publish_start_time)之后用户就可以参与活动。PAUSE:活动已暂停，表示商户临时暂停该活动，该状态下用户不能参与活动。枚举值活动已激活: ACTIVE 活动已暂停: PAUSE

page_num

integer

必需

分页查询页码。注意事项必须为大于0的整数。

page_size

integer

必需

分页查询单页数据条数。注意事项 1.必须为大于0的整数 2.每页最大值为20

merchant_access_mode

string

必需

商户接入模式。枚举值商户自接入模式: SELF_MODE 服务商代接入模式: AGENCY_MODE 注意事项选择服务商代接入模式需配合 app_auth_token 代调用使用

示例

返回响应

🟢200成功

application/json

Body

activity_lite_infos

array [object {4}]

活动摘要信息

必需

activity_base_info

object

活动基础信息

可选

voucher_deduct_info

object

券优惠信息

可选

voucher_display_pattern_info

object

券展示信息

可选

voucher_available_scope_info

object

券可用范围

可选

page_num

integer

分页查询页码

必需

page_size

integer

必需

分页查询单页数据条数。

total_size

string

必需

经过条件筛选，查询到的活动总数量

条件查询活动列表

错误码#

公共错误码#

业务错误码#

请求参数

返回响应

错误码

公共错误码

业务错误码