创建商家券活动

商家调用该接口创建商家券活动。
创建商家券活动接口同步返回创建请求受理结果，后续通过alipay.marketing.activity.message.created消息接口异步发送活动创建成功事件消息。

如果在code_mode=MERCHANT_UPLOAD的模式下，创建商家券活动后，还需要进行券码导入操作，以及预算追加操作，然后商家券才能进行发放。

{ "voucher_available_scope_result_info": { "voucher_available_geography_scope_result_info": { "available_geography_shop_result_info": { "available_geography_all_shop_result_info": { "fail_exclude_shop_infos": [ { "fail_message": "string", "real_shop_id": "string", "shop_id": "string", "fail_reasons": [ "string" ] } ], "success_exclude_shop_ids": [ "string" ] }, "fail_available_real_shop_infos": [ { "fail_message": "string", "real_shop_id": "string", "shop_id": "string", "fail_reasons": [ "string" ] } ], "fail_available_shop_infos": [ { "fail_message": "string", "real_shop_id": "string", "shop_id": "string", "fail_reasons": [ "string" ] } ], "success_available_real_shop_ids": [ "string" ], "success_available_shop_ids": [ "string" ] } } }, "voucher_use_rule_result": { "voucher_available_scope_result": { "order_voucher_available_shop_result": { "order_voucher_merchant_all_shop_result": { "exclude_shop_fail_infos": [ { "fail_message": "string", "shop_id": "string", "fail_reasons": [ "string" ] } ], "success_exclude_shop_ids": [ "string" ] }, "real_shop_fail_infos": [ { "fail_message": "string", "real_shop_id": "string", "fail_reasons": [ "string" ] } ], "shop_fail_infos": [ { "fail_message": "string", "shop_id": "string", "fail_reasons": [ "string" ] } ], "success_real_shop_ids": [ "string" ], "success_shop_ids": [ "string" ] }, "voucher_available_type": "string" } }, "activity_id": "2016042700826004508401111111" }

请求参数

Body 参数application/json

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。接口参数是列表类型。

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_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_name

string

可选

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

示例值:

满10减1活动

biz_tag

string

可选

该字段废弃！后续不要使用该字段！商家券业务标签，影响商家券对C端用户的展示形式。

示例值:

GROUP_BUY_EXCHANGE_VOUCHER

code_mode

string

可选

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

示例值:

MERCHANT_UPLOAD

merchant_access_mode

string

商户接入模式

可选

示例值:

AGENCY_MODE

out_biz_no

string

可选

外部业务单号，用作幂等控制。幂等作用：参数不变的情况下，再次请求返回与上一次相同的结果。

示例值:

20170101000001654bb46ba

voucher_type

string

可选

券类型。兑换券仅支持一类券类型：EXCHANGE_VOUCHER: 兑换券；

示例值:

FIX_VOUCHER

publish_end_time

string

可选

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

示例值:

{}

publish_start_time

string

可选

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

示例值:

{}

示例

返回响应

🟢200common response

application/json

Body

voucher_available_scope_result_info

object (VoucherAvailableScopeResultInfo)

可选

voucher_available_geography_scope_result_info

object (VoucherAvailableGeographyScopeResultInfo)

可选

voucher_use_rule_result

object (OrderVoucherUseRuleResult)

可选

voucher_available_scope_result

object (OrderVoucherAvailableScopeResult)

可选

activity_id

string

活动id

可选

示例值:

2016042700826004508401111111

🔴500请求失败