查询商家券活动

商户通过该接口查询商家券活动详情。

{ "activity_base_info": { "belong_merchant_info": { "business_type": "string", "merchant_id": "string", "merchant_id_type": "string" }, "activity_id": "string", "activity_name": "string", "activity_operation_status": "string", "activity_product_type": "string", "activity_status": "string", "code_mode": "string", "out_activity_id": "string" }, "belong_merchant_info": { "business_type": "string", "merchant_id": "string", "merchant_id_type": "string" }, "customer_guide": { "voucher_send_guide": { "voucher_detail_url": "string" }, "voucher_use_guide": { "mini_app_id": "string", "mini_app_path": "string", "mini_app_use_guide": true, "offline_code_use_guide": true, "service_codes": [ "string" ] }, "mini_app_id": "string", "mini_app_path": "string", "real_shop_ids": [ "string" ], "service_codes": [ "string" ], "shop_ids": [ "string" ], "store_ids": [ "string" ] }, "summary": { "publish_count": 0, "used_count": 0 }, "voucher_available_scope_info": { "voucher_available_account_info": { "available_pids": [ "string" ], "available_smids": [ "string" ] }, "voucher_available_app_info": { "available_app_ids": [ "string" ] }, "voucher_available_geography_scope_info": { "available_geography_city_info": { "all_city": true, "available_city_codes": [ "string" ] }, "available_geography_shop_info": { "available_geography_all_shop": { "available_brand_id": "string", "exclude_shop_ids": [ "string" ], "merchant_ids": [ "string" ] }, "available_real_shop_ids": [ "string" ], "available_shop_ids": [ "string" ] }, "available_geography_scope_type": "string" }, "voucher_available_goods_info": { "goods_description": "string", "goods_detail": "string", "goods_detail_rich_description": "string", "goods_name": "string", "origin_amount": "string", "available_goods_sku_ids": [ "string" ], "exclude_goods_sku_ids": [ "string" ], "goods_detail_images": [ "string" ] }, "voucher_available_item_info": { "item_id": "string", "out_item_info": [ { "item_app_id": "string", "out_item_id": "string" } ] } }, "voucher_customer_guide_info": { "voucher_send_guide_info": { "mini_app_send_guide_info": { "mini_app_url": "string" }, "send_guide_mode": [ "string" ] }, "voucher_use_guide_info": { "mini_app_use_guide_info": { "mini_app_url": "string", "mini_app_service_codes": [ "string" ] }, "use_guide_mode": [ "string" ] } }, "voucher_deduct_info": { "customer_define_voucher_info": { "deduct_info": { "customer_define_deduct_rule": { "customer_define_deduct_rule_desc": "string" } } }, "discount_voucher_info": { "voucher_deduct_threshold_info": { "voucher_express_info": { "pay_express": "string" }, "voucher_goods_quantity_specification_info": { "directional_type": "string", "specification_quantity": 0, "specification_unit": "string" }, "customer_define_voucher_threshold_desc": "string" }, "ceiling_amount": "string", "discount": "string", "floor_amount": "string" }, "exchange_voucher_info": { "exchange_goods_info": { "exchange_goods_name": "string" }, "voucher_deduct_threshold_info": { "voucher_express_info": { "pay_express": "string" }, "voucher_goods_quantity_specification_info": { "directional_type": "string", "specification_quantity": 0, "specification_unit": "string" }, "customer_define_voucher_threshold_desc": "string" }, "amount": "string", "biz_type": "string", "floor_amount": "string" }, "fix_voucher_info": { "voucher_deduct_threshold_info": { "voucher_express_info": { "pay_express": "string" }, "voucher_goods_quantity_specification_info": { "directional_type": "string", "specification_quantity": 0, "specification_unit": "string" }, "customer_define_voucher_threshold_desc": "string" }, "amount": "string", "floor_amount": "string" }, "special_voucher_info": { "voucher_deduct_threshold_info": { "voucher_express_info": { "pay_express": "string" }, "voucher_goods_quantity_specification_info": { "directional_type": "string", "specification_quantity": 0, "specification_unit": "string" }, "customer_define_voucher_threshold_desc": "string" }, "floor_amount": "string", "special_amount": "string" }, "voucher_type": "string" }, "voucher_display_info": { "brand_logo": "string", "brand_name": "string", "customer_service_mobile": "string", "customer_service_url": "string", "voucher_comment": "string", "voucher_description": "string", "voucher_image": "string", "voucher_detail_images": [ "string" ] }, "voucher_display_pattern_info": { "brand_logo": "string", "brand_logo_url": "string", "brand_name": "string", "customer_service_mobile": "string", "customer_service_url": "string", "voucher_description": "string", "voucher_image": "string", "voucher_image_url": "string", "voucher_name": "string", "voucher_detail_image_urls": [ "string" ], "voucher_detail_images": [ "string" ] }, "voucher_inventory_info": { "send_count": 0, "use_count": 0 }, "voucher_send_mode_info": { "voucher_package_mode_info": { "voucher_package_id": "string" }, "voucher_sale_mode_info": { "settle_info": { "settle_mode": "string", "settle_target_type": "string" }, "fund_custody_mode": "string", "overdue_refundable": true, "overdue_refundable_need_confirm": true, "payee_pid": "string", "refundable": true, "refundable_need_confirm": true, "sale_amount": "string" }, "voucher_send_rule_info": { "max_quantity_by_day": 0, "natural_person_limit": true, "phone_number_limit": true, "phone_number_need_input_limit": true, "publish_end_time": "string", "publish_start_time": "string", "quantity": 0, "quantity_limit_per_user": 0, "quantity_limit_per_user_period_type": "string", "real_name_limit": true }, "voucher_send_mode": "string" }, "voucher_send_rule": { "natural_person_limit": true, "phone_number_limit": true, "voucher_quantity": 0, "voucher_quantity_limit_per_user": 0 }, "voucher_use_rule": { "discount_voucher": { "ceiling_amount": "string", "discount": "string", "floor_amount": "string", "goods_name": "string", "origin_amount": "string" }, "exchange_voucher": { "amount": "string", "biz_type": "string", "customer_service_mobile": "string", "customer_service_url": "string", "floor_amount": "string", "overdue_refundable": true, "payee_pid": "string", "refundable": true, "sale_amount": "string", "settle_type": "string", "voucher_detail_url": "string", "voucher_name": "string" }, "fix_voucher": { "amount": "string", "floor_amount": "string", "goods_name": "string" }, "special_voucher": { "floor_amount": "string", "goods_name": "string", "origin_amount": "string", "special_amount": "string" }, "voucher_available_scope": { "order_voucher_available_city_code": { "all_city": true, "city_codes": [ "string" ] }, "order_voucher_available_shop": { "order_voucher_merchant_all_shop": { "exclude_shop_ids": [ "string" ] }, "real_shop_ids": [ "string" ], "shop_ids": [ "string" ] }, "voucher_available_type": "string" }, "voucher_valid_period": { "type": "string", "valid_begin_time": "string", "valid_days_after_receive": 0, "valid_end_time": "string", "wait_days_after_receive": 0 } }, "voucher_use_rule_info": { "voucher_use_time_info": { "absolute_period_info": { "time_restrict_info": { "disable_period_info": [ { "date_rule_info": { "date_range_info": { "begin_date": "string", "end_date": "string" }, "time_range_info": { "end_time_info": { "end_time": "string", "end_time_type": "string" }, "begin_time": "string" } }, "holiday_rule_info": { "time_range_info": { "end_time_info": { "end_time": "string", "end_time_type": "string" }, "begin_time": "string" } }, "week_rule_info": { "time_range_info": { "end_time_info": { "end_time": "string", "end_time_type": "string" }, "begin_time": "string" }, "week_day": "string" }, "rule_type": "string" } ], "usable_period_info": [ { "date_rule_info": { "date_range_info": { "begin_date": "string", "end_date": "string" }, "time_range_info": { "end_time_info": { "end_time": "string", "end_time_type": "string" }, "begin_time": "string" } }, "holiday_rule_info": { "time_range_info": { "end_time_info": { "end_time": "string", "end_time_type": "string" }, "begin_time": "string" } }, "week_rule_info": { "time_range_info": { "end_time_info": { "end_time": "string", "end_time_type": "string" }, "begin_time": "string" }, "week_day": "string" }, "rule_type": "string" } ] }, "valid_begin_time": "string", "valid_end_time": "string" }, "relative_period_info": { "time_restrict_info": { "disable_period_info": [ { "date_rule_info": { "date_range_info": { "begin_date": "string", "end_date": "string" }, "time_range_info": { "end_time_info": { "end_time": "string", "end_time_type": "string" }, "begin_time": "string" } }, "holiday_rule_info": { "time_range_info": { "end_time_info": { "end_time": "string", "end_time_type": "string" }, "begin_time": "string" } }, "week_rule_info": { "time_range_info": { "end_time_info": { "end_time": "string", "end_time_type": "string" }, "begin_time": "string" }, "week_day": "string" }, "rule_type": "string" } ], "usable_period_info": [ { "date_rule_info": { "date_range_info": { "begin_date": "string", "end_date": "string" }, "time_range_info": { "end_time_info": { "end_time": "string", "end_time_type": "string" }, "begin_time": "string" } }, "holiday_rule_info": { "time_range_info": { "end_time_info": { "end_time": "string", "end_time_type": "string" }, "begin_time": "string" } }, "week_rule_info": { "time_range_info": { "end_time_info": { "end_time": "string", "end_time_type": "string" }, "begin_time": "string" }, "week_day": "string" }, "rule_type": "string" } ] }, "valid_days_after_receive": 0, "wait_days_after_receive": 0 }, "period_type": "string" }, "quantity_limit_per_user": 0, "quantity_limit_per_user_period_type": "string", "voucher_max_use_times": 0, "voucher_use_ext_info": "string" }, "activity_id": "2016042700826004508401111111", "activity_name": "满10减1优惠券", "activity_operation_status": "MODIFYING", "activity_status": "ACTIVE", "biz_tag": "GROUP_BUY_EXCHANGE_VOUCHER", "voucher_type": "FIX_VOUCHER", "publish_end_time": {}, "publish_start_time": {} }

返回响应

🟢200common response

application/json

Body

activity_base_info

object (ActivityBaseInfo)

可选

belong_merchant_info

object (BelongMerchantInfo)

可选

activity_id

string

活动id

可选

activity_name

string

活动名称。

可选

activity_operation_status

string

活动操作状态。

可选

activity_product_type

string

券活动产品类型

可选

activity_status

string

可选

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

code_mode

string

可选

码模式。 MERCHANT_UPLOAD：商户上传自定义code，发券时系统随机选取上传的券code发放 MERCHANT_API：发奖时指定券码发奖，此模式无须提前上传券码。

out_activity_id

string

外部活动ID

可选

belong_merchant_info

object (BelongMerchantInfo)

可选

customer_guide

object (CustomerGuide)

可选

voucher_send_guide

object (VoucherSendGuide)

可选

voucher_use_guide

object (VoucherUseGuide)

可选

mini_app_id

string

可选

券可用的小程序appId，卡包详情页可跳转到该appId

mini_app_path

string

可选

指定跳转到mini_app_id时的具体页面路径。限制： 1、只有mini_app_id有值时该值传入才会有效 2、该小程序路径是相对路径。详情参见小程序scheme链接介绍

real_shop_ids

array[string]

可选

代运营商业关系门店列表，列表中的门店id是调用接口alipay.business.relation.shop.create创建门店返回的real_shop_id。接口参数是列表类型。

service_codes

array[string]

可选

小程序服务编码，通过 alipay.open.app.appcontent.function.create(小程序服务创建)接口创建服务后获取。

shop_ids

array[string]

可选

券可使用的门店列表。列表中的门店id是通过调用接口ant.merchant.expand.shop.create创建门店返回的支付宝门店id 接口参数是列表类型。

store_ids

array[string]

可选

该字段后续废弃。券可使用的门店列表。列表中的门店id是通过调用接口ant.merchant.expand.shop.create创建门店返回的支付宝门店id。接口参数是列表类型。

summary

object (VoucherSummary)

可选

publish_count

integer

券已发放数量。

可选

used_count

integer

券已核销数量。

可选

voucher_available_scope_info

object (VoucherAvailableScopeInfo)

可选

voucher_available_account_info

object (VoucherAvailableAccountInfo)

可选

voucher_available_app_info

object (VoucherAvailableAppInfo)

可选

voucher_available_geography_scope_info

object (VoucherAvailableGeographyScopeInfo)

可选

voucher_available_goods_info

object (VoucherAvailableGoodsInfo)

可选

voucher_available_item_info

object (VoucherAvailableItemInfo)

可选

voucher_customer_guide_info

object (VoucherCustomerGuideInfo)

可选

voucher_send_guide_info

object (VoucherSendGuideInfo)

可选

voucher_use_guide_info

object (VoucherUseGuideInfo)

可选

voucher_deduct_info

object (VoucherDeductInfo)

可选

customer_define_voucher_info

object (CustomerDefineVoucherInfo)

可选

discount_voucher_info

object (DiscountVoucherInfo)

可选

exchange_voucher_info

object (ExchangeVoucherInfo)

可选

fix_voucher_info

object (FixVoucherInfo)

可选

special_voucher_info

object (SpecialVoucherInfo)

可选

voucher_type

string

券类型。

可选

voucher_display_info

object (VoucherDisplayInfo)

可选

brand_logo

string

可选

商家logo。需要通过 alipay.marketing.material.image.upload接口上传图片，指定file_key为PROMO_BRAND_LOGO，返回的resource_id即为该参数的值

brand_name

string

可选

商户品牌名称。如果不设置品牌名称，则默认使用支付宝商家系统中维护的商家别名。如果没有维护商家别名，则使用默认名称：商家优惠。用户领取优惠券后，品牌名称会对用户进行展示

customer_service_mobile

string

客服电话

可选

customer_service_url

string

客服链接

可选

voucher_comment

string

可选

券补充说明，该字段为可运营字段，可描述商品特色会展示在用户支付宝卡包券详情页

voucher_description

string

券详细使用说明。

可选

voucher_image

string

可选

券详情页封面图，会展示在用户支付宝卡包券详情页。需要通过 alipay.marketing.material.image.upload接口上传图片，指定file_key为PROMO_VOUCHER_IMAGE，接口返回的resource_id即为该参数的值

voucher_detail_images

array[string]

可选

券详细图列表，会展示在用户支付宝卡包券详情页。需要通过 alipay.marketing.material.image.upload接口上传图片，指定file_key为PROMO_VOUCHER_DETAIL_IMAGE ,接口返回的resource_id即为该参数的值。上传图片尺寸600*600，支持格式：png、jpg、jpeg、bmp，大小不超过2MB。

voucher_display_pattern_info

object (VoucherDisplayPatternInfo)

可选

brand_logo

string

可选

商家logo 需要通过 alipay.marketing.material.image.upload接口上传图片，指定file_key为PROMO_BRAND_LOGO，返回的resource_id即为该参数的值。

brand_logo_url

string

可选

商家品牌logo链接

brand_name

string

商户品牌名称。

可选

customer_service_mobile

string

客服电话。

可选

customer_service_url

string

客服链接。

可选

voucher_description

string

券详细使用说明。

可选

voucher_image

string

可选

券详情页封面图，会展示在用户支付宝卡包券详情页。需要通过 alipay.marketing.material.image.upload接口上传图片，指定file_key为PROMO_VOUCHER_IMAGE，接口返回的resource_id即为该参数的值。

voucher_image_url

string

券封面链接

可选

voucher_name

string

券名称。

可选

voucher_detail_image_urls

array[string]

券详情链接

可选

voucher_detail_images

array[string]

可选

券详细图列表，会展示在用户支付宝卡包券详情页需要通过 alipay.marketing.material.image.upload接口上传图片，指定file_key为PROMO_VOUCHER_DETAIL_IMAGE ,接口返回的resource_id即为该参数的值上传图片尺寸600*600，支持格式：png、jpg、jpeg、bmp，大小不超过2MB。

voucher_inventory_info

object (VoucherInventoryInfo)

可选

send_count

integer

已发放数量。

可选

use_count

integer

已核销数量。

可选

voucher_send_mode_info

object (VoucherSendModeInfo)

可选

voucher_package_mode_info

object (VoucherPackageModeInfo)

可选

voucher_sale_mode_info

object (VoucherSaleModeInfo)

可选

voucher_send_rule_info

object (VoucherSendRuleInfo)

可选

voucher_send_mode

string

券发放模式。

可选

voucher_send_rule

object (VoucherSendRuleDetail)

可选

natural_person_limit

boolean

可选

是否开启自然人领取限制。自然人表示按照身份证纬度进行领取限制。

phone_number_limit

boolean

可选

是否开启电话号码领取限制。

voucher_quantity

integer

发行券的数量。

可选

voucher_quantity_limit_per_user

integer

可选

每人领取限制。默认按照支付宝uid进行领取限制; 不填写或填入0，默认没有领取限制。

voucher_use_rule

object (VoucherUseRule)

可选

discount_voucher

object (DiscountVoucher)

可选

exchange_voucher

object (ExchangeVoucher)

可选

fix_voucher

object (FixVoucher)

可选

special_voucher

object (SpecialVoucher)

可选

voucher_available_scope

object (VoucherAvailableScope)

可选

voucher_valid_period

object (VoucherValidPeriod)

可选

voucher_use_rule_info

object (VoucherUseRuleInfo)

可选

voucher_use_time_info

object (VoucherUseTimeInfo)

可选

quantity_limit_per_user

integer

核销次数限制。

可选

quantity_limit_per_user_period_type

string

可选

周期限领配置,限制每人在固定周期内领取张数(voucher_quantity_limit_per_user),默认LIFE_CYCLE

voucher_max_use_times

integer

券最大核销次数。

可选

voucher_use_ext_info

string

自定义扩展信息

可选

activity_id

string

活动id

可选

示例值:

2016042700826004508401111111

activity_name

string

可选

活动名称。不对用户进行展示，仅供商家在后台管理活动使用。

示例值:

满10减1优惠券

activity_operation_status

string

活动操作状态

可选

示例值:

MODIFYING

activity_status

string

可选

活动状态。已激活状态代表活动正常运行，已终止状态代表商家终止活动，不可再发放。

示例值:

ACTIVE

biz_tag

string

可选

商家券业务标签，影响商家券对C端用户的展示形式。

示例值:

GROUP_BUY_EXCHANGE_VOUCHER

voucher_type

string

券类型

可选

示例值:

FIX_VOUCHER

publish_end_time

string

可选

券发放结束时间。格式为：yyyy-MM-dd HH:mm:ss

示例值:

{}

publish_start_time

string

可选

券发放开始时间。格式为：yyyy-MM-dd HH:mm:ss

示例值:

{}

🔴500请求失败

查询商家券活动

请求参数

返回响应