通用场景
服务商平台运营商家券
兑换券
商家券
商家调用该接口创建商家券活动。
创建商家券活动接口同步返回创建请求受理结果，后续通过alipay.marketing.activity.message.created消息接口异步发送活动创建成功事件消息。
如果在code_mode=merchant_upload的模式下，创建商家券活动后，还需要进行券码导入操作，以及预算追加操作，然后商家券才能进行发放。
创建商家券活动接口同步返回创建请求受理结果，后续通过alipay.marketing.activity.message.created消息接口异步发送活动创建成功事件消息。
如果在code_mode=merchant_upload的模式下，创建商家券活动后，还需要进行券码导入操作，以及预算追加操作，然后商家券才能进行发放。
公共请求参数
业务请求参数
activity_name｜活动名称必选string[0,20]
【描述】活动名称。不对用户进行展示，仅供商家在后台管理活动使用。
【示例值】满10减1活动
code_mode｜码模式必选string[12,20]
【描述】码模式。merchant_upload：商户上传自定义code，发券时系统随机选取上传的券code发放。merchant_api：发奖时指定券码发奖，此模式无须提前上传券码。
【枚举值】
商户上传自定义code: merchant_upload
发奖时指定券码发奖: merchant_api
【示例值】merchant_upload
voucher_type｜券类型必选string[0,16]
【描述】券类型。
兑换券仅支持一类券类型：exchange_voucher: 兑换券；
【枚举值】
满减券: fix_voucher
折扣券: discount_voucher
特价券: special_voucher
【示例值】fix_voucher
publish_start_time｜券发放开始时间必选date
【描述】券发放开始时间。格式为：yyyy-mm-dd hh:mm:ss
匹配格式yyyy-mm-dd hh:mm:ss的date类型
【示例值】2017-01-01 00:00:01
publish_end_time｜券发放结束时间必选date
【描述】券发放结束时间。格式为：yyyy-mm-dd hh:mm:ss
匹配格式yyyy-mm-dd hh:mm:ss的date类型
【注意事项】券发放结束时间publish_end_time与券发放开始时间publish_start_time间隔必须小于等于180天
【示例值】2017-01-29 23:59:59
voucher_display_info｜券展示信息必选voucherdisplayinfo
【描述】券展示信息
voucher_description｜券详细使用说明必选string[0,1000]
【描述】券详细使用说明。
【示例值】1、本券不可兑换现金，不可找零。2、每个用户最多可以领取1张。3、如果订单发生退款，优惠券无法退还。
brand_name｜商户品牌名称特殊可选string[0,12]
【描述】商户品牌名称。如果不设置品牌名称，则默认使用支付宝商家系统中维护的商家别名。如果没有维护商家别名，则使用默认名称：商家优惠。用户领取优惠券后，品牌名称会对用户进行展示
【注意事项】1、服务商平台模式即belong_merchant_info.business_type为isv时必传
【示例值】商家优惠
brand_logo｜商家logo特殊可选string[0,64]
【描述】商家logo。需要通过
alipay.marketing.material.image.upload接口上传图片，指定file_key为promo_brand_logo，返回的resource_id即为该参数的值
【注意事项】1、服务商平台模式即belong_merchant_info.business_type为isv时必传
2、上传图片尺寸600*600，支持格式：png、jpg、jpeg、bmp，大小不超过2mb
【示例值】adedsktiqo-u5vjuqvbcqwaaacmaaqed
voucher_comment｜券补充说明特殊可选string[0,12]
【描述】券补充说明，该字段为可运营字段，可描述商品特色
会展示在用户支付宝卡包券详情页
【注意事项】1、该字段目前只支持兑换券即voucher_type为exchange_voucher
【示例值】食材新鲜，品质之选
voucher_image｜券详情页封面图特殊可选string[0,64]
【描述】券详情页封面图，会展示在用户支付宝卡包券详情页。需要通过
alipay.marketing.material.image.upload接口上传图片，指定file_key为promo_voucher_image，接口返回的resource_id即为该参数的值
【注意事项】该字段在兑换券场景下必传，上传图片尺寸670*335，支持格式：png、jpg、jpeg、bmp，大小不超过2mb
【示例值】adedsktiqo-u5vjuqvbcqwaaacmaaqed
voucher_detail_images｜券详细图列表特殊可选array[1,3]
【描述】券详细图列表，会展示在用户支付宝卡包券详情页。需要通过
alipay.marketing.material.image.upload接口上传图片，指定file_key为promo_voucher_detail_image
,接口返回的resource_id即为该参数的值。上传图片尺寸600*600，支持格式：png、jpg、jpeg、bmp，大小不超过2mb。
【注意事项】1、voucher_image填入，该值才能填入；
2、最多3张；
3、兑换券即voucher_type为exchange_voucher时不支持
【示例值】["adedsktiqo-u5vjuqvbcqwaaacmaaqe1","adedsktiqo-u5vjuqvbcqwaaacmaaqe2","adedsktiqo-u5vjuqvbcqwaaacmaaqe3"]
customer_service_mobile｜客服电话特殊可选string[0,20]
【描述】客服电话
【注意事项】客服电话和客服链接必须二选一
【示例值】81xxxxxxx
customer_service_url｜客服链接特殊可选string[0,255]
【描述】客服链接
【注意事项】客服电话和客服链接必须二选一
【示例值】alipay://xxxx
voucher_use_rule｜券核销规则必选voucheruserule
【描述】券核销规则
voucher_valid_period｜日期区间内可以使用优惠必选vouchervalidperiod
【描述】日期区间内可以使用优惠
type｜券有效期类型必选string[1,32]
【描述】券有效期类型
【枚举值】
绝对时间: absolute
相对时间: relative
【示例值】absolute
valid_begin_time｜券可使用的开始时间可选date
【描述】券可使用的开始时间。格式为：yyyy-mm-dd hh:mm:ss
匹配格式yyyy-mm-dd hh:mm:ss的date类型
【注意事项】type为absolute时该字段必填
【示例值】2017-01-10 00:00:00
valid_end_time｜券可使用的结束时间可选date
【描述】券可使用的结束时间。格式为yyyy-mm-dd hh:mm:ss
匹配格式yyyy-mm-dd hh:mm:ss的date类型
【注意事项】type为absolute必填。券可使用的结束时间valid_end_time 必须大于 券的发放结束时间publish_end_time
【示例值】2017-01-13 23:59:59
valid_days_after_receive｜券生效后n天内可以使用可选number[1,999999]
【描述】券生效后n天内可以使用。可以配合wait_days_after_receive字段使用。
【注意事项】type为relative时必填。
valid_days_after_receive必须大于0。
【示例值】3
wait_days_after_receive｜用户领券后需要等待 n 天生效可选number[0,999999]
【描述】用户领券后需要等待n天，券才可以生效。如果该字段填入0或者不填写，则用户领券后立刻生效。
【注意事项】type为relative时可选。
【示例值】2
voucher_available_scope｜商家券可用范围必选voucheravailablescope
【描述】商家券可用范围
voucher_available_type｜可用范围类型必选string[1,32]
【描述】可用范围类型。
【枚举值】
可用门店: shop
可用城市: city_code
【示例值】shop
order_voucher_available_shop｜券可用门店信息特殊可选ordervoucheravailableshop
【描述】券可用门店信息。当voucher_available_type=shop时，该字段必填。
shop_ids｜券可使用的门店列表特殊可选array[1,1000]
【描述】券可使用的门店列表。列表中的门店id是通过调用接口ant.merchant.expand.shop.create创建门店返回的支付宝门店id 接口参数是列表类型。
【注意事项】1、shop_ids中的门店id必须是支付宝门店id。
2、shop_ids如果包含重复的门店id会自动进行去重操作。
3、shop_ids、real_shop_ids、order_voucher_merchant_all_shop必须三选一
【示例值】["2018051000502000000011111111","2018040200502000000011111111","2018062800502000000022271997"]
real_shop_ids｜券可使用的物理门店列表特殊可选array[1,1000]
【描述】代运营商业关系门店列表，列表中的门店id是调用接口alipay.business.relation.shop.create创建门店返回的real_shop_id 接口参数是列表类型。
【注意事项】1、real_shop_ids中的门店id必须是代运营商业关系门店id。 2、real_shop_ids如果包含重复的门店id会自动进行去重操作。3、shop_ids、real_shop_ids、order_voucher_merchant_all_shop必须三选一
【示例值】["2018051000502000000011111111","2018040200502000000011111111","2018062800502000000022271997"]
order_voucher_merchant_all_shop｜商户全部门店可用可选ordervouchermerchantallshop
【描述】商户全部门店可用。
【注意事项】shop_ids、real_shop_ids、order_voucher_merchant_all_shop必须三选一
exclude_shop_ids｜券不可使用的门店列表可选array[1,1000]
【描述】券不可使用的门店列表。指定商户全部门店可用时可通过该字段排除部分不可用门店。列表中的门店id是通过调用接口ant.merchant.expand.shop.create创建门店返回的支付宝门店id 接口参数是列表类型。
【注意事项】1. 创建活动时传入了该值修改才会生效。2. exclude_shop_ids中的门店id必须是支付宝门店id。 3. exclude_shop_ids如果包含重复的门店id会自动进行去重操作。
【示例值】["2018051000502000000011111111","2018040200502000000011111111","2018062800502000000022271997"]
order_voucher_available_city_code｜券可用城市信息特殊可选ordervoucheravailablecitycode
【描述】券可用城市信息。 当voucher_available_type=city_code时，该字段必填。
all_city｜是否全国可选boolean
【描述】是否全国。选择全国后，无须填写city_codes字段。系统默认填充全国全部城市信息。
【示例值】false
city_codes｜城市编码可选array[1,1000]
【描述】城市编码。请按照中内容填写。 （）
【示例值】["100100"]
fix_voucher｜满减券详情特殊可选fixvoucher
【描述】满减券详情
【注意事项】券类型为满减券时必传
amount｜面额必选price[0.10,3000.00]
【描述】面额，每张代金券可以抵扣的金额。
【注意事项】币种为人民币，单位为元。小数点以后最多保留两位。
取值范围:0.1<=x<=3000
【示例值】100.00
floor_amount｜门槛金额可选price[0.10,50000.00]
【描述】门槛金额。该字段不填写，认为无门槛。
【注意事项】只有当订单金额大于等于门槛金额时券才能使用。 币种为人民币，单位为元。小数点以后最多保留两位。 设置门槛：取值范围:0.1<=x<= 50000。 如果设置了门槛金额，则必须大于等于0.1，不可以等于0
【示例值】1000.00
goods_name｜商品名称可选string[1,12]
【描述】商品名称。
【注意事项】说明：
该字段可不填，填入则origin_amount必填。
【示例值】美味甜甜圈
exchange_voucher｜兑换券详情特殊可选exchangevoucher
【描述】兑换券详情
【注意事项】券类型为兑换券时必传
voucher_name｜对消费者展示的券(商品)名称必选string[1,12]
【描述】对消费者展示的券(商品)名称。
【示例值】满10减1
sale_amount｜用户购买优惠券需要支付的金额必选price[0.10,3000.00]
【描述】用户购买优惠券需要支付的金额
【注意事项】币种为人民币，单位为元。小数点以后最多保留两位。取值范围:0.1<=x<=3000
【示例值】50.00
amount｜券的价值必选price[0.10,3000.00]
【描述】券的价值
【注意事项】币种为人民币，单位为元。小数点以后最多保留两位。取值范围:0.1<=x<=3000
【示例值】100.00
customer_service_mobile｜客服电话特殊可选string[1,20]
【描述】客服电话
【注意事项】客服电话和客服链接必须二选一
【示例值】1304004538x
customer_service_url｜客服链接特殊可选string[0,255]
【描述】客服链接
【注意事项】客服电话和客服链接必须二选一
【示例值】alipay://xxxx
payee_pid｜收款账号特殊可选string[1,32]
【描述】收款账号。目前的结算规则是，每核销一笔优惠券，支付宝会打款到该收款账户。
【示例值】2088010100121
floor_amount｜门槛金额可选string[undefined,undefined]
【描述】门槛金额。说明：该字段可不填，认为无门槛;
【注意事项】只有当订单金额大于等于门槛金额时券才能使用。 币种为人民币，单位为元。小数点以后最多保留两位。 设置门槛：取值范围:0.1<=x<= 50000。 如果设置了门槛金额，则必须大于等于0.1，不可以等于0
【示例值】1000.00
refundable｜购买的优惠券是否允许退款可选boolean
【描述】购买的优惠券是否允许退款。不填默认否，枚举值：
true：是
false：否
【示例值】false
overdue_refundable｜是否过期自动退可选boolean
【描述】是否支持优惠券过期后，自动退款给用户。
不填默认否，枚举值：
true：是
false：否
【注意事项】自动退款功能需要服务商在优惠券过期时，主动调用alipay.marketing.activity.order.refund接口进行退款。如果配置优惠券时选择了过期自动退款，但是实际券过期后，服务商没有进行退款，那么用户投诉后，需要服务商进行解决。
【示例值】true
biz_type｜兑换券业务类型可选string[1,64]
【描述】兑换券业务类型。
枚举值
团购券：group_buy_exchange_voucher
代金券：fix_exchange_voucher
注意：兑换券通过大促活动权益报名能力推广至支付宝会场时，本参数必填。
【枚举值】
团购券: group_buy_exchange_voucher
代金券: fix_exchange_voucher
【示例值】group_buy_exchange_voucher
settle_type｜解决类型可选string[1,16]
【描述】解决类型。
【枚举值】
账期模式:走默认结算账号: period_merchant
分账模式:门店分账: capture_shop
分账模式:合作商户: capture_merchant
【示例值】period_merchant
discount_voucher｜折扣券详情特殊可选discountvoucher
【描述】折扣券详情
【注意事项】券类型voucher_type为折扣券discount_voucher时必传
discount｜折扣率必选string[3,3]
【描述】折扣率。
【注意事项】取值范围：0.1<=x<=9.9，比如：6.5折填入6.5;
【示例值】6.5
ceiling_amount｜封顶金额必选price[0.10,15000.00]
【描述】封顶金额。
【注意事项】币种为人民币，单位为元;
小数点以后最多保留两位;
取值范围:0.1<=x<=15000;
【示例值】50.00
floor_amount｜门槛金额可选price[0.10,50000.00]
【描述】门槛金额。说明：该字段可不填，认为无门槛;
【注意事项】只有当订单金额大于等于门槛金额时券才能使用。 币种为人民币，单位为元。小数点以后最多保留两位。 设置门槛：取值范围:0.1<=x<= 50000。 如果设置了门槛金额，则必须大于等于0.1，不可以等于0
【示例值】1000.00
goods_name｜商品名称可选string[1,12]
【描述】商品名称。
【注意事项】说明：该字段可不填，填入则origin_amount必填。
【示例值】美味甜甜圈
origin_amount｜原价可选price[0.10,9999.00]
【描述】原价。说明：该字段可不填，填入商品名称goods_name则必填;
【注意事项】币种为人民币，单位为元。小数点以后最多保留两位;
取值范围:0.1<=x<=9999;
【示例值】65.00
special_voucher｜特价券详情特殊可选specialvoucher
【描述】特价券详情
【注意事项】券类型voucher_type为特价券special_voucher时必传
origin_amount｜原价必选price[0.10,9999.00]
【描述】原价。
限制：
币种为人民币，单位为元。小数点以后最多保留两位;
取值范围:0.1<=x<=9999。
【注意事项】币种为人民币，单位为元。小数点以后最多保留两位;
取值范围:0.1<=x<=9999;
【示例值】65.00
special_amount｜特价必选string[0,16]
【描述】特价，即：原价-特价=优惠金额。
【注意事项】币种为人民币，单位为元。小数点以后最多保留两位;
取值范围:0<=x<=999;
原价必须大于特价，即:origin_amount>special_amount;
【示例值】10.00
goods_name｜商品名称必选string[1,12]
【描述】商品名称。
【示例值】美味甜甜圈
floor_amount｜门槛金额可选price[0.10,50000.00]
【描述】门槛金额。说明：该字段可不填，认为无门槛;
【注意事项】只有当订单金额大于等于门槛金额时券才能使用。 币种为人民币，单位为元。小数点以后最多保留两位。 设置门槛：取值范围:0.1<=x<= 50000。 如果设置了门槛金额，则必须大于等于0.1，不可以等于0
【示例值】1000.00
voucher_send_rule｜券发放规则必选vouchersendruledetail
【描述】券发放规则
voucher_quantity｜发行券的数量可选number[0,9999999999]
【描述】发行券的数量。
【注意事项】code_mode=merchant_upload模式下数量必须为0或者选择不填。其他模式下该数值必须是大于0的整数。
【示例值】100
voucher_quantity_limit_per_user｜每人领取限制可选number[0,9999999999]
【描述】每人领取限制。默认按照支付宝uid进行领取限制;
不填写或填入0，默认没有领取限制。
【示例值】1
natural_person_limit｜是否做身份证号限制可选boolean
【描述】是否开启自然人领取限制。自然人表示按照身份证纬度进行领取限制。
【示例值】false
phone_number_limit｜是否开启电话号码领取限制可选boolean
【描述】是否开启电话号码领取限制。
【示例值】false
out_biz_no｜外部业务单号必选string[0,64]
【描述】外部业务单号，用作幂等控制。
幂等作用：参数不变的情况下，再次请求返回与上一次相同的结果。
【注意事项】外部接入方需保证业务单号唯一
【示例值】20170101000001654bb46ba
activity_base_info｜活动基础信息必选activitybaseinfo
【描述】活动基础信息
activity_id｜活动 id可选string[1,128]
【描述】活动id
【示例值】2016042700826004508401111111
activity_name｜活动名称可选string[1,20]
【描述】活动名称。
【注意事项】不对用户进行展示，仅供商家在后台管理活动使用。
【示例值】满10减1活动
belong_merchant_info｜券活动归属的商户信息可选belongmerchantinfo
【描述】商家券活动归属的商户信息。 说明： 如果该复杂对象不填。则默认为该商家券活动的归属者是调用者本人。 如果填写，则认为该商家券活动的归属者是该商户。
【注意事项】自研商户可以不传，服务商身份接入时必传
merchant_id_type｜商户id类型特殊可选string[1,10]
【描述】商户id类型。特别说明：如果merchant_id_type选择smid。则表明当前商家券活动的归属者是该smid所绑定的支付宝pid。因此要求该smid必须绑定相应的支付宝pid。
【枚举值】
间连smid: smid
直连pid: pid
【注意事项】服务商代运营模式必传
【示例值】smid
merchant_id｜商户id特殊可选string[1,32]
【描述】商户pid,默认为当前接口调用商户。
【注意事项】1、服务商代运营模式必传
2、服务商代运营模式下服务商必须与商户建立代运营授权关系。
【必选条件】服务商代运营模式必传
【示例值】2088202967380463
business_type｜合作业务类型可选string[1,16]
【描述】合作业务类型,默认为isv_for_merchant
【枚举值】
服务商平台模式: isv
服务商代运营模式: isv_for_merchant
【注意事项】1、isv(平台模式)只有兑换券即voucher_type值为exchange_voucher时才能使用
【示例值】isv_for_merchant
code_mode｜码模式可选string[1,32]
【描述】码模式。 merchant_upload：商户上传自定义code，发券时系统随机选取上传的券code发放 merchant_api：发奖时指定券码发奖，此模式无须提前上传券码。
【枚举值】
商户上传自定义code: merchant_upload
发奖时指定券码发奖: merchant_api
【示例值】merchant_upload
activity_operation_status｜活动操作状态可选string[1,32]
【描述】活动操作状态。
【枚举值】
创建中: creating
修改中: modifying
追加中: appending
【注意事项】该值为空，说明活动当前没有正在执行中的操作。
【示例值】modifying
activity_status｜活动状态可选string[1,32]
【描述】活动状态 。 active:活动已激活，表示活动已经生效，等到活动开始(publish_start_time)之后用户就可以参与活动。 pause:活动已暂停，表示商户临时暂停该活动，该状态下用户不能参与活动。
【枚举值】
活动已激活，表示活动已经生效，等到活动开始(publish_start_time)之后用户就可以参与活动: active
活动已暂停，表示商户临时暂停该活动，该状态下用户不能参与活动: pause
活动已结束，表示商户主动停止活动或活动到期结束(publish_end_time)不能再进行领取或修改等操作: finished
【注意事项】1.该值为空，说明活动还未创建成功。可以使用 activity_operation_status字段判断活动是否处于creating状态。
【示例值】active
activity_product_type｜券活动产品码可选string[1,32]
【描述】券活动产品类型
【枚举值】
支付券: payment_voucher
商家券: order_voucher
兑换券: exchange_voucher
【示例值】order_voucher
out_activity_id｜外部活动id可选string[1,128]
【描述】外部活动id
【示例值】20230331001
voucher_display_pattern_info｜券展示信息必选voucherdisplaypatterninfo
【描述】券展示信息
以下参数 二选一 传入必选
customer_service_mobile｜客服电话string[1,20]
【描述】客服电话。
【注意事项】客服电话和客服链接必须二选一。
【示例值】1304004538x
customer_service_url｜客服链接string[1,255]
【描述】客服链接。
【注意事项】客服电话和客服链接必须二选一。
【示例值】alipay://xxxx
brand_name｜商户品牌名称可选string[1,12]
【描述】商户品牌名称。
【注意事项】服务商平台模式即belong_merchant_info.business_type为isv时必传
【示例值】商家优惠
brand_logo｜商家 logo可选string[1,128]
【描述】商家logo 需要通过 alipay.marketing.material.image.upload接口上传图片，指定file_key为promo_brand_logo，返回的resource_id即为该参数的值。
【注意事项】1. 服务商平台模式即belong_merchant_info.business_type为isv时必传。
2. 上传图片尺寸600*600，支持格式：png、jpg、jpeg、bmp，大小不超过2mb。
【示例值】adedsktiqo-u5vjuqvbcqwaaacmaaqed
brand_logo_url｜商家品牌logo链接可选string[1,255]
【描述】商家品牌logo链接
【示例值】https://gw.alipayobjects.com/mdn/rms_9822d7/afts/img/a*1f4esaaphrqaaaaaaaaaaabkarqnaq
voucher_name｜对消费者展示的券(商品)名称可选string[1,20]
【描述】券名称。
【注意事项】兑换券必传
【示例值】满10减1券
voucher_description｜券详细使用说明可选string[1,1000]
【描述】券详细使用说明。
【示例值】1、本券不可兑换现金，不可找零。2、每个用户最多可以领取1张。3、如果订单发生退款，优惠券无法退还。
voucher_image｜券封面图可选string[1,64]
【描述】券详情页封面图，会展示在用户支付宝卡包券详情页。
需要通过 alipay.marketing.material.image.upload接口上传图片，指定file_key为promo_voucher_image，接口返回的resource_id即为该参数的值。
【注意事项】上传图片尺寸600*600，支持格式：png、jpg、jpeg、bmp，大小不超过2mb。
【示例值】adedsktiqo-u5vjuqvbcqwaaacmaaqed
voucher_image_url｜券封面链接可选string[1,255]
【描述】券封面链接
【示例值】https://gw.alipayobjects.com/mdn/rms_9822d7/afts/img/a*1f4esaaphrqaaaaaaaaaaabkarqnaq
voucher_detail_images｜图片详情列表可选array[1,3]
【描述】券详细图列表，会展示在用户支付宝卡包券详情页 需要通过 alipay.marketing.material.image.upload接口上传图片，指定file_key为promo_voucher_detail_image ,接口返回的resource_id即为该参数的值 上传图片尺寸600*600，支持格式：png、jpg、jpeg、bmp，大小不超过2mb。
【注意事项】1. voucher_image填入，该值才能填入。
2. 最多3张。
3. 兑换券即voucher_type为exchange_voucher时不支持
【示例值】["adedsktiqo-u5vjuqvbcqwaaacmaaqe1","adedsktiqo-u5vjuqvbcqwaaacmaaqe2","adedsktiqo-u5vjuqvbcqwaaacmaaqe3"]
voucher_detail_image_urls｜券详情图链接可选array[1,1000]
【描述】券详情链接
【示例值】["https://gw.alipayobjects.com/mdn/rms_9822d7/afts/img/a*1f4esaaphrqaaaaaaaaaaabkarqnaq"]
belong_merchant_info｜商家券活动归属的商户信息特殊可选belongmerchantinfo
【描述】商家券活动归属的商户信息。说明：如果该复杂对象不填。则默认为该商家券活动的归属者是调用者本人。如果填写，则认为该商家券活动的归属者是该商户。
【注意事项】自研商户可以不传，服务商身份接入时必传
merchant_id_type｜商户id类型特殊可选string[1,10]
【描述】商户id类型。特别说明：如果merchant_id_type选择smid。则表明当前商家券活动的归属者是该smid所绑定的支付宝pid。因此要求该smid必须绑定相应的支付宝pid。
【枚举值】
间连smid: smid
直连pid: pid
【注意事项】服务商代运营模式必传
【示例值】smid
merchant_id｜商户id特殊可选string[1,32]
【描述】商户pid,默认为当前接口调用商户。
【注意事项】1、服务商代运营模式必传
2、服务商代运营模式下服务商必须与商户建立代运营授权关系。
【必选条件】服务商代运营模式必传
【示例值】2088202967380463
business_type｜合作业务类型可选string[1,16]
【描述】合作业务类型,默认为isv_for_merchant
【枚举值】
服务商平台模式: isv
服务商代运营模式: isv_for_merchant
【注意事项】1、isv(平台模式)只有兑换券即voucher_type值为exchange_voucher时才能使用
【示例值】isv_for_merchant
customer_guide｜客户指导可选customerguide
【描述】自定义入口
voucher_use_guide｜券核销引导必选voucheruseguide
【描述】券核销引导
mini_app_path｜指定跳转到mini_app_id时的具体页面路径特殊可选string[1,64]
【描述】指定跳转到mini_app_id时的具体页面路径。
【注意事项】1、只有mini_app_id有值时该值传入才会有效 2、该小程序路径是相对路径。详情参考小程序scheme链接介绍https://opendocs.alipay.com/support/01rb18。
3.service_codes与mini_app_path只能二选一或者都不填写。
【示例值】/index/path/path&query=xx=xx
service_codes｜小程序服务编码特殊可选array[1,1000]
【描述】小程序服务编码，通过 alipay.open.app.appcontent.function.create(小程序服务创建)接口创建服务后获取。
【注意事项】1.只有mini_app_id有值时该值传入才会有效 2.当前只支持一个服务code 3.service_codes与mini_app_path只能二选一或者都不填写。
【示例值】["2020030921000303380758"]
offline_code_use_guide｜线下扫码核销可选boolean
【描述】线下扫码核销。
【注意事项】1、该字段为true。则卡包会展示相应券码信息。
2、offline_code_use_guide 与 mini_app_use_guide至少2选1
【示例值】true
mini_app_use_guide｜小程序核销可选boolean
【描述】小程序核销。
【注意事项】1、该字段为true。则卡包会展示小程序核销按钮跳转至小程序。 2、offline_code_use_guide 与 mini_app_use_guide至少2选1。3、该字段为true，则下面的mini_app_id字段必须填写。
【示例值】true
mini_app_id｜跳转小程序id可选string[1,16]
【描述】券可用的小程序appid，卡包详情页可跳转到该appid
【注意事项】该appid归属的pid必须和当前商户存在同mid关系或跨mid的授权关系。
【示例值】2021238412323412
voucher_send_guide｜券发放引导信息特殊可选vouchersendguide
【描述】券发放引导信息。
【注意事项】当voucher_type=exchange_voucher时，该字段必须填写
voucher_detail_url｜领（购）券详情页链接特殊可选string[1,255]
【描述】领(购)券详情页链接，从支付宝公域跳转到服务商(商户)自定义领(购)券详情页。
【注意事项】当voucher_type=exchange_voucher时，该字段必须填写。
【示例值】alipays://platformapi/startapp?appid=xxxx
merchant_access_mode｜商户接入模式可选string[0,32]
【描述】商户接入模式
【枚举值】
商户自接入模式: self_mode
服务商代接入模式: agency_mode
【示例值】agency_mode
voucher_send_mode_info｜券发放模式信息可选vouchersendmodeinfo
【描述】券发放
voucher_send_mode｜券发放模式可选string[1,32]
【描述】券发放模式。
【枚举值】
售卖模式: sale_mode
直领模式: direct_send_mode
券包: voucher_package
【示例值】direct_send_mode
voucher_sale_mode_info｜券售卖信息可选vouchersalemodeinfo
【描述】券售卖信息。
payee_pid｜收款账号可选string[1,32]
【描述】收款账号。 目前的结算规则是，每核销一笔优惠券，支付宝会打款到该收款账户。
【示例值】2088xxxxx
sale_amount｜用户购买优惠券需要支付的金额可选price[0.10,3000.00]
【描述】用户购买优惠券需要支付的金额
【注意事项】币种为人民币，单位为元。小数点以后最多保留两位。 取值范围:0.1<=x<=3000
【示例值】50.00
fund_custody_mode｜资金托管方式可选string[1,32]
【描述】资金托管方式
【枚举值】
担保交易: guarantee
【示例值】guarantee
refundable｜购买的优惠券是否允许退款可选boolean
【描述】购买的优惠券是否允许退款。 不填默认否，枚举值： true：是 false：否
【示例值】false
overdue_refundable｜是否过期自动退可选boolean
【描述】是否支持优惠券过期后，自动退款给用户。 不填默认否，枚举值： true：是 false：否。自动退款功能需要服务商在优惠券过期时，主动调用alipay.marketing.activity.order.refund接口进行退款。 如果配置优惠券时选择了过期自动退款，但是实际券过期后，服务商没有进行退款，那么用户投诉后，需要服务商进行解决。
【示例值】true
settle_info｜结算信息可选bizfundsettleinfo
【描述】结算信息
settle_target_type｜结算的目标对象类型可选string[1,16]
【描述】结算的目标对象类型
【枚举值】
默认结算到进件的收款账号: merchant
结算到门店: shop
自定义账户: user_define
【示例值】merchant
settle_mode｜结算资金模式可选string[1,16]
【描述】请款|账期 模式
【枚举值】
账期模式: period
请款模式: capture
【示例值】period
overdue_refundable_need_confirm｜是否过期自动退-退款前向商户确认是否可以退款可选boolean
【描述】在支持过期自动退款后，支付宝发起自动退款前 是否需要向商户确认退款。 不填默认否，枚举值： true：是 false：否。
如果选择了 true:是 ，则需要商户配合接入 过期自动退款前是否需要向商户确认spi(spi.alipay.marketing.activity.order.refundconfirm) 以及 退款确认结果api(alipay.marketing.activity.order.refundconfirmcommit)
【注意事项】1. 如果商户填写为true，实际未接入接口，则支付宝依旧会发起过期自动退款
2. 如果商户填写了true，并且接入了接口，但是未在指定时间范围内 响应或者返回确认结果，则支付宝依旧会发起过期自动退款，商户需要自行处理退款事宜以及对应潜在的风险
【示例值】true
refundable_need_confirm｜用户主动退是否退款需要向商户确认可选boolean
【描述】在支持随时退后，支付宝发起退款前用于判断是否需要向商户确认退款。 不填默认否，枚举值： true：是 false：否。 如果选择了 true:是 ，则需要商户配合接入退款前是否需要向商户确认spi(spi.alipay.marketing.activity.order.refundconfirm)
【注意事项】1. 如果商户填写为true，实际未接入接口，则支付宝依旧会发起退款
2. 如果商户填写了true，并且接入了接口，但是未在指定时间范围内 响应或者返回确认结果，则支付宝依旧会发起退款，商户需要自行处理退款事宜以及对应潜在的风险
【示例值】false
voucher_package_mode_info｜券包信息可选voucherpackagemodeinfo
【描述】券包信息。
voucher_package_id｜券包id可选string[1,64]
【描述】券包id，对应alipay.marketing.activity.voucherpackage.query中voucher_package_id。
【示例值】ip20220628016671405804297103167741
voucher_send_rule_info｜券发放规则可选vouchersendruleinfo
【描述】券发放规则。
quantity｜发行券的数量可选number[1,99999999]
【描述】发行券的数量。
【注意事项】code_mode=merchant_upload模式下数量必须为0。 其他模式下该数值必须是大于0的整数。
【示例值】100
max_quantity_by_day｜单天最大发券数量可选number[0,999999999]
【描述】设置此字段，允许指定单天最大发券数量。
【注意事项】每天发放张数*活动天数应小于等于优惠券发放总量
【示例值】10
quantity_limit_per_user｜每人领取限制可选number[0,999999999]
【描述】每人领取限制。 默认按照支付宝账号进行领取限制; 不填写或填入0表示没有领取限制.
【示例值】1
quantity_limit_per_user_period_type｜每人领取周期类型可选string[1,32]
【描述】周期限领配置,限制每人在固定周期内领取张数(voucher_quantity_limit_per_user),默认life_cycle
【枚举值】
每天: day
每周: week
每月: month
【示例值】life_cycle
natural_person_limit｜是否做身份证号限制可选boolean
【描述】是否开启自然人领取限制。 自然人表示按照身份证纬度进行领取限制。
【示例值】false
phone_number_limit｜是否开启电话号码领取限制可选boolean
【描述】是否开启电话号码领取限制。
【示例值】false
real_name_limit｜支付宝实名限制可选boolean
【描述】限制支付宝实名用户才能领取支付券,默认为false表示不限制 枚举值 true\false
【示例值】false
publish_start_time｜券发放开始时间可选date
【描述】券发放开始时间。 格式为：yyyy-mm-dd hh:mm:ss
匹配格式yyyy-mm-dd hh:mm:ss的date类型
【示例值】2017-01-01 00:00:01
publish_end_time｜券发放结束时间可选date
【描述】券发放结束时间。 格式为：yyyy-mm-dd hh:mm:ss
匹配格式yyyy-mm-dd hh:mm:ss的date类型
【示例值】2017-01-29 23:59:59
phone_number_need_input_limit｜发放时是否需要输入电话号码的限制可选boolean
【描述】下单时是否需要用户填写手机号码
【注意事项】1. 仅支持兑换券即voucher_type为exchange_voucher时支持
2. 仅支持兑换券为售卖类型 （即团购券业务）支持
【示例值】false
voucher_deduct_info｜券优惠抵扣信息可选voucherdeductinfo
【描述】券优惠抵扣信息
fix_voucher_info｜满减券详情特殊可选fixvoucherinfo
【描述】满减券详情。
【注意事项】券类型为满减券时必传。
【必选条件】voucher_type = fix_voucher必传
amount｜券面额可选price[0.10,3000.00]
【描述】面额，每张代金券可以抵扣的金额。
【注意事项】币种为人民币，单位为元。小数点以后最多保留两位。 取值范围:0.1<=x<=3000
【示例值】100.00
floor_amount｜门槛金额可选price[0.1,50000]
【描述】门槛金额。该字段不填写，认为无门槛。
【注意事项】只有当订单金额大于等于门槛金额时券才能使用。 币种为人民币，单位为元。小数点以后最多保留两位。 设置门槛：取值范围:0.1<=x<= 50000。 如果设置了门槛金额，则必须大于等于0.1，不可以等于0
【示例值】1000.00
voucher_deduct_threshold_info｜优惠门槛信息可选voucherdeductthresholdinfo
【描述】优惠门槛信息
voucher_express_info｜邮费信息可选voucherexpressinfo
【描述】邮费信息
pay_express｜邮费标识必选string[1,32]
【描述】邮费标识，属于券的服务，用于用户门槛信息展示
【枚举值】
付邮费: pay_for_express
免邮费: free_for_express
【注意事项】如果不涉及邮费信息，可以选择不填
【示例值】pay_for_express
voucher_goods_quantity_specification_info｜商品规格信息可选vouchergoodsquantityspecificationinfo
【描述】商品规格信息，数量，尺寸，大小等
directional_type｜定向类型必选string[1,32]
【描述】定向类型用于规格设置，比如：fix 表示 固定满x件，appoint 表示指定第n件
【枚举值】
固定: fix
指定: appoint
【示例值】fix
specification_quantity｜数量必选number[1,999999999]
【描述】数量
【注意事项】大于0
【示例值】2
specification_unit｜单位必选string[1,32]
【描述】单位
【枚举值】
件: count_number
单: order_number
【示例值】count_number
customer_define_voucher_threshold_desc｜自定义门槛描述可选string[1,16]
【描述】自定义门槛描述
【注意事项】自定义门槛描述优先级高于其他门槛，展示时门槛描述只展示该字段信息
【示例值】会员可用
discount_voucher_info｜折扣券详情特殊可选discountvoucherinfo
【描述】折扣券详情。
【注意事项】券类型 voucher_type 为折扣券 discount_voucher 时必传。
【必选条件】voucher_type=discount_voucher时必传
discount｜折扣率可选string[1,12]
【描述】折扣率。
【注意事项】取值范围：0.1<=x<=9.9，比如：6.5折填入6.5;
【示例值】6.5
ceiling_amount｜封顶金额可选price[0.10,15000.00]
【描述】封顶金额。
【注意事项】币种为人民币，单位为元; 小数点以后最多保留两位; 取值范围:0.1<=x<=15000;
【示例值】50.00
floor_amount｜门槛金额可选price[0.10,50000.00]
【描述】门槛金额。说明：该字段可不填，认为无门槛;
【注意事项】只有当订单金额大于等于门槛金额时券才能使用。 币种为人民币，单位为元。小数点以后最多保留两位。 设置门槛：取值范围:0.1<=x<= 50000。 如果设置了门槛金额，则必须大于等于0.1，不可以等于0
【示例值】1000.00
voucher_deduct_threshold_info｜优惠门槛信息可选voucherdeductthresholdinfo
【描述】优惠门槛信息
voucher_express_info｜邮费信息可选voucherexpressinfo
【描述】邮费信息
pay_express｜邮费标识必选string[1,32]
【描述】邮费标识，属于券的服务，用于用户门槛信息展示
【枚举值】
付邮费: pay_for_express
免邮费: free_for_express
【注意事项】如果不涉及邮费信息，可以选择不填
【示例值】pay_for_express
voucher_goods_quantity_specification_info｜商品规格信息可选vouchergoodsquantityspecificationinfo
【描述】商品规格信息，数量，尺寸，大小等
directional_type｜定向类型必选string[1,32]
【描述】定向类型用于规格设置，比如：fix 表示 固定满x件，appoint 表示指定第n件
【枚举值】
固定: fix
指定: appoint
【示例值】fix
specification_quantity｜数量必选number[1,999999999]
【描述】数量
【注意事项】大于0
【示例值】2
specification_unit｜单位必选string[1,32]
【描述】单位
【枚举值】
件: count_number
单: order_number
【示例值】count_number
customer_define_voucher_threshold_desc｜自定义门槛描述可选string[1,16]
【描述】自定义门槛描述
【注意事项】自定义门槛描述优先级高于其他门槛，展示时门槛描述只展示该字段信息
【示例值】会员可用
special_voucher_info｜特价券详情特殊可选specialvoucherinfo
【描述】特价券详情。
【注意事项】券类型 voucher_type 为特价券 special_voucher 时必传。
【必选条件】券类型 voucher_type 为特价券 special_voucher 时必传。
special_amount｜特价可选price[0.00,999.00]
【描述】特价，即：原价-特价=优惠金额。
【注意事项】币种为人民币，单位为元。小数点以后最多保留两位; 取值范围:0<=x<=999; 原价必须大于特价，即:origin_amount>special_amount;
【示例值】10.00
floor_amount｜门槛金额可选price[0.10,50000.00]
【描述】门槛金额。说明：该字段可不填，认为无门槛;
【注意事项】只有当订单金额大于等于门槛金额时券才能使用。 币种为人民币，单位为元。小数点以后最多保留两位。 设置门槛：取值范围:0.1<=x<= 50000。 如果设置了门槛金额，则必须大于等于0.1，不可以等于0
【示例值】1000.00
voucher_deduct_threshold_info｜优惠门槛信息可选voucherdeductthresholdinfo
【描述】优惠门槛信息
voucher_express_info｜邮费信息可选voucherexpressinfo
【描述】邮费信息
pay_express｜邮费标识必选string[1,32]
【描述】邮费标识，属于券的服务，用于用户门槛信息展示
【枚举值】
付邮费: pay_for_express
免邮费: free_for_express
【注意事项】如果不涉及邮费信息，可以选择不填
【示例值】pay_for_express
voucher_goods_quantity_specification_info｜商品规格信息可选vouchergoodsquantityspecificationinfo
【描述】商品规格信息，数量，尺寸，大小等
directional_type｜定向类型必选string[1,32]
【描述】定向类型用于规格设置，比如：fix 表示 固定满x件，appoint 表示指定第n件
【枚举值】
固定: fix
指定: appoint
【示例值】fix
specification_quantity｜数量必选number[1,999999999]
【描述】数量
【注意事项】大于0
【示例值】2
specification_unit｜单位必选string[1,32]
【描述】单位
【枚举值】
件: count_number
单: order_number
【示例值】count_number
customer_define_voucher_threshold_desc｜自定义门槛描述可选string[1,16]
【描述】自定义门槛描述
【注意事项】自定义门槛描述优先级高于其他门槛，展示时门槛描述只展示该字段信息
【示例值】会员可用
exchange_voucher_info｜兑换券详情特殊可选exchangevoucherinfo
【描述】兑换券详情。
【注意事项】券类型为兑换券时必传。
【必选条件】券类型为兑换券时必传。
amount｜券的价值可选price[0.10,3000.00]
【描述】券的价值
【注意事项】币种为人民币，单位为元。小数点以后最多保留两位。 取值范围:0.1<=x<=3000
【示例值】100.00
floor_amount｜门槛金额可选price[0.10,50000.00]
【描述】优惠门槛金额，表示只有当订单金额大于等于门槛金额时券才能使用。该字段为空时表示无门槛。 门槛金额的校验由服务商(商户)核销时自行校验，支付宝侧只做展示使用。
【注意事项】只有当订单金额大于等于门槛金额时券才能使用。 币种为人民币，单位为元。小数点以后最多保留两位。 设置门槛：取值范围:0.1<=x<= 50000。 如果设置了门槛金额，则必须大于等于0.1，不可以等于0
【示例值】1000.00
biz_type｜兑换券业务类型可选string[1,64]
【描述】兑换券业务类型。 注意：兑换券通过大促活动权益报名能力推广至支付宝会场时，本参数必填。
【枚举值】
团购券: group_buy_exchange_voucher
代金券: fix_exchange_voucher
【示例值】group_buy_exchange_voucher
exchange_goods_info｜兑换商品信息可选voucherexchangegoodsinfo
【描述】兑换商品信息
exchange_goods_name｜兑换商品名称必选string[1,16]
【描述】兑换商品名称
【示例值】荣耀耳机
voucher_deduct_threshold_info｜优惠门槛信息可选voucherdeductthresholdinfo
【描述】优惠门槛信息
voucher_express_info｜邮费信息可选voucherexpressinfo
【描述】邮费信息
pay_express｜邮费标识必选string[1,32]
【描述】邮费标识，属于券的服务，用于用户门槛信息展示
【枚举值】
付邮费: pay_for_express
免邮费: free_for_express
【注意事项】如果不涉及邮费信息，可以选择不填
【示例值】pay_for_express
voucher_goods_quantity_specification_info｜商品规格信息可选vouchergoodsquantityspecificationinfo
【描述】商品规格信息，数量，尺寸，大小等
directional_type｜定向类型必选string[1,32]
【描述】定向类型用于规格设置，比如：fix 表示 固定满x件，appoint 表示指定第n件
【枚举值】
固定: fix
指定: appoint
【示例值】fix
specification_quantity｜数量必选number[1,999999999]
【描述】数量
【注意事项】大于0
【示例值】2
specification_unit｜单位必选string[1,32]
【描述】单位
【枚举值】
件: count_number
单: order_number
【示例值】count_number
customer_define_voucher_threshold_desc｜自定义门槛描述可选string[1,16]
【描述】自定义门槛描述
【注意事项】自定义门槛描述优先级高于其他门槛，展示时门槛描述只展示该字段信息
【示例值】会员可用
customer_define_voucher_info｜自定义券详情特殊可选customerdefinevoucherinfo
【描述】自定义券类型
【必选条件】券类型为自定义券时必传。
deduct_info｜优惠信息必选deductinfo
【描述】优惠信息
customer_define_deduct_rule｜自定义优惠规则可选customerdefinedeductrule
【描述】自定义优惠规则
customer_define_deduct_rule_desc｜自定义优惠规则描述必选string[1,12]
【描述】自定义优惠规则描述
【示例值】生日优惠
voucher_type｜券类型可选string[1,32]
【描述】券类型。
【枚举值】
满减券: fix_voucher
折扣券: discount_voucher
特价券: special_voucher
【示例值】fix_voucher
voucher_available_scope_info｜券可用范围可选voucheravailablescopeinfo
【描述】券可用范围
voucher_available_account_info｜券可用账号可选voucheravailableaccountinfo
【描述】券可用账号。
以下参数 二选一 传入必选
available_pids｜优惠券可核销的直连商户pidarray[0,4000]
【描述】优惠券可核销的直连商户pid
【示例值】["2088102111111111"]
available_smids｜优惠券可核销的间连商户smidarray[0,4000]
【描述】优惠券可核销的间连商户smid
【示例值】["2088102111111111"]
voucher_available_app_info｜券可用小程序可选voucheravailableappinfo
【描述】券可用小程序。
available_app_ids｜可核销小程序id列表可选array[1,10000]
【描述】可核销的支付宝小程序id
【注意事项】1、必须是支付宝小程序 2、如果包含重复的小程序id会自动进行去重操作。
【示例值】["2021238412323412"]
voucher_available_geography_scope_info｜券可用地理位置可选voucheravailablegeographyscopeinfo
【描述】券可用地理位置。
available_geography_scope_type｜券可用地理位置类型可选string[1,32]
【描述】券可用地理位置类型。
【枚举值】
可用门店: shop
可用城市: city_code
历史接入的服务商.无任何可用范围: compatible
【示例值】shop
available_geography_shop_info｜券可用门店可选voucheravailablegeographyshopinfo
【描述】券可用门店
以下参数 二选一 传入必选
available_shop_ids｜券可使用的门店列表array[0,1024]
【描述】券可使用的门店列表。列表中的门店id是通过调用接口ant.merchant.expand.shop.create创建门店返回的支付宝门店id 接口参数是列表类型。
【注意事项】1、shop_ids中的门店id必须是支付宝门店id。 2、shop_ids如果包含重复的门店id会自动进行去重操作。 3、shop_ids、real_shop_ids、order_voucher_merchant_all_shop必须三选一
【示例值】["2018051000502000000011111111","2018040200502000000011111111","2018062800502000000022271997"]
available_geography_all_shop｜全部门店可用voucheravailablegeographyallshopinfo
【描述】全部门店可用
merchant_ids｜全部门店可用的商户id可选array[0,1]
【描述】全部门店可用的商户id
【注意事项】1.目前只支持传当前活动归属的商户id
2.目前只支持传入单个商户id
【示例值】["208805x000502"]
exclude_shop_ids｜券不可使用的门店列表可选array[1,10000]
【描述】券不可使用的门店列表。指定商户全部门店可用时可通过该字段排除部分不可用门店。 列表中的门店id是通过调用接口ant.merchant.expand.shop.create创建门店返回的支付宝门店id 接口参数是列表类型。
【注意事项】1、exclude_shop_ids中的门店id必须是支付宝门店id。 2、exclude_shop_ids如果包含重复的门店id会自动进行去重操作。
【示例值】["2018051000502000000011111111","2018040200502000000011111111","2018062800502000000022271997"]
available_brand_id｜全部门店可用的品牌id可选string[1,84000]
【描述】全部门店可用的品牌id
提示:
1.目前只支持传入当前券归属商户的品牌id
2.品牌id可以在登录b.alipay.com-账户中心-品牌管理里查看。如果没有品牌，可以先创建品牌。sop：
注意事项
1.只支持传入单个品牌id
2.传入品牌id后，券的商户品牌和logo仍以voucher_display_pattern_info传入为准。
【注意事项】1、只允许入参当前调用接口pid创建的品牌，代运营模式取被代运营商户的品牌。
2、自动同步和更新品牌下的全部门店
【示例值】2022111600502042000001279859
available_real_shop_ids｜代运营商业关系门店列表可选array[0,1024]
【描述】代运营商业关系门店列表，列表中的门店id是调用接口alipay.business.relation.shop.create创建门店返回的real_shop_id 接口参数是列表类型。
【注意事项】1、real_shop_ids中的门店id必须是代运营商业关系门店id。 2、real_shop_ids如果包含重复的门店id会自动进行去重操作。3、shop_ids、real_shop_ids、order_voucher_merchant_all_shop必须三选一
【示例值】["2018051000502000000011111111","2018040200502000000011111111","2018062800502000000022271997"]
available_geography_city_info｜券可用城市可选voucheravailablegeographycityinfo
【描述】券可用城市
以下参数 二选一 传入必选
all_city｜是否全国boolean
【描述】是否全国。 选择全国后，无须填写city_codes字段。系统默认填充全国全部城市信息。
【示例值】false
available_city_codes｜城市编码array[1,10000]
【描述】城市编码。请按照中内容填写。（）
【示例值】["100100"]
voucher_available_goods_info｜券可用商品可选voucheravailablegoodsinfo
【描述】券可用商品。
goods_name｜商品名称可选string[1,12]
【描述】商品名称。
【示例值】美味甜甜圈
goods_description｜商品描述可选string[1,120]
【描述】商品描述信息。 用于券面展示，向用户介绍商品
【示例值】美味甜甜圈很美味
origin_amount｜原价可选price[0.01,999999999]
【描述】原价。说明：该字段可不填，填入商品名称goods_name则必填;
【示例值】65.00
available_goods_sku_ids｜可优惠商品编码可选array[1,10000]
【描述】可优惠商品编码，商家自定义商品编码。当用户支付时，交易中的商品编码和支付券配置的商品编码有任一匹配时，可以使用优惠券。
【示例值】["apple-01","apple-02"]
exclude_goods_sku_ids｜不可核销商品编码可选array[1,1000]
【描述】不可核销商品编码，商家自定义商品编码。当用户支付时，交易中的商品编码和支付券配置的商品编码有任一匹配时，不可以使用优惠券。
【注意事项】available_goods与unavailable_goods_ids只能二选一或者同时为空
【示例值】['apple-03','apple-04']
goods_detail_images｜商品详情图片列表可选array[1,5]
【描述】商品详情图片列表，会展示在特定渠道(如服务市场团购业务插件的头图)
【注意事项】1、最多5张
2、仅支持兑换券即voucher_type为exchange_voucher时支持
【示例值】["adedsktiqo-u5vjuqvbcqwaaacmaaqe1","adedsktiqo-u5vjuqvbcqwaaacmaaqe2","adedsktiqo-u5vjuqvbcqwaaacmaaqe3"]
goods_detail_rich_description｜商品详情富文本描述可选string[1,1000]
【描述】商品详情富文本描述
【示例值】美食团购
goods_detail｜商品详情可选string[1,1000]
【描述】商品详情，会展示在特定渠道(如服务市场团购业务插件的套餐明细)。
【注意事项】1.如果有特定格式诉求，可以支持传入自定义格式，如数组
【示例值】米饭1份
voucher_use_rule_info｜券核销限制可选voucheruseruleinfo
【描述】券核销限制
quantity_limit_per_user｜核销次数限制可选number[0,999999999]
【描述】核销次数限制。
【示例值】1
quantity_limit_per_user_period_type｜每人领取周期类型可选string[1,32]
【描述】周期限领配置,限制每人在固定周期内领取张数(voucher_quantity_limit_per_user),默认life_cycle
【枚举值】
每天: day
每周: week
每月: month
【示例值】life_cycle
voucher_max_use_times｜券最大核销次数可选number[1,999999999]
【描述】券最大核销次数。
【示例值】1
voucher_use_time_info｜券核销时间可选voucherusetimeinfo
【描述】券核销时间。
period_type｜券有效期可选string[1,32]
【描述】券有效期。
【枚举值】
绝对时间 : absolute
相对时间: relative
【示例值】absolute
absolute_period_info｜券绝对时间可用可选voucherabsoluteperiodinfo
【描述】券绝对时间可用。
valid_begin_time｜券可使用的开始时间可选date
【描述】券可使用的开始时间。 格式为：yyyy-mm-dd hh:mm:ss。
匹配格式yyyy-mm-dd hh:mm:ss的date类型
【示例值】2017-01-10 00:00:00
valid_end_time｜券可使用的结束时间可选date
【描述】券可使用的结束时间。 格式为yyyy-mm-dd hh:mm:ss。
匹配格式yyyy-mm-dd hh:mm:ss的date类型
【注意事项】券可使用的结束时间 valid_end_time 必须大于券的发放结束时间 publish_end_time。
【示例值】2017-01-13 23:59:59
time_restrict_info｜核销时间限制可选timerestrictinfo
【描述】核销时间限制
usable_period_info｜可用时间段可选array
【描述】可用时间段
rule_type｜规则类型必选string[1,32]
【描述】规则类型
【枚举值】
周期类型: week
日期类型: date
法定节假日类型: holiday
【示例值】week
week_rule_info｜周期规则特殊可选weekruleinfo
【描述】周期规则。当rule_type = week时，不能为空
week_day｜星期数必选string[1,32]
【描述】星期数，以“,”连接多个星期数
【示例值】1,2
time_range_info｜时间段必选timerangeinfo
【描述】时间段
begin_time｜开始时间必选string[1,8]
【描述】开始时间 格式：hh:mm:ss
【示例值】00:00:00
end_time_info｜结束时间必选endtimeinfo
【描述】结束时间，可设置当日或次日结束，例如：22:00~次日07:00
end_time_type｜结束时间类型必选string[1,32]
【描述】结束时间类型
【枚举值】
当日: same_day
次日: next_day
【示例值】next_day
end_time｜结束时间必选string[1,8]
【描述】结束时间 格式：hh:mm:ss
【示例值】23:59:59
date_rule_info｜日期规则特殊可选dateruleinfo
【描述】日期规则。当ruletype = date时，不能为空
date_range_info｜日期范围必选daterangeinfo
【描述】日期范围
begin_date｜开始日期必选string[1,12]
【描述】开始日期 格式：yyyy-mm-dd
【示例值】2023-02-01
end_date｜结束日期必选string[1,12]
【描述】结束日期 格式：yyyy-mm-dd
【示例值】2023-03-31
time_range_info｜时间段必选timerangeinfo
【描述】时间段
begin_time｜开始时间必选string[1,8]
【描述】开始时间 格式：hh:mm:ss
【示例值】00:00:00
end_time_info｜结束时间必选endtimeinfo
【描述】结束时间，可设置当日或次日结束，例如：22:00~次日07:00
end_time_type｜结束时间类型必选string[1,32]
【描述】结束时间类型
【枚举值】
当日: same_day
次日: next_day
【示例值】next_day
end_time｜结束时间必选string[1,8]
【描述】结束时间 格式：hh:mm:ss
【示例值】23:59:59
holiday_rule_info｜节假日规则特殊可选holidayruleinfo
【描述】节假日规则。当ruletype = holiday时，不能为空
time_range_info｜时间段必选timerangeinfo
【描述】时间段
begin_time｜开始时间必选string[1,8]
【描述】开始时间 格式：hh:mm:ss
【示例值】00:00:00
end_time_info｜结束时间必选endtimeinfo
【描述】结束时间，可设置当日或次日结束，例如：22:00~次日07:00
end_time_type｜结束时间类型必选string[1,32]
【描述】结束时间类型
【枚举值】
当日: same_day
次日: next_day
【示例值】next_day
end_time｜结束时间必选string[1,8]
【描述】结束时间 格式：hh:mm:ss
【示例值】23:59:59
disable_period_info｜不可用时间段可选array
【描述】不可用时间段
rule_type｜规则类型必选string[1,32]
【描述】规则类型
【枚举值】
周期类型: week
日期类型: date
法定节假日类型: holiday
【示例值】week
week_rule_info｜周期规则特殊可选weekruleinfo
【描述】周期规则。当rule_type = week时，不能为空
week_day｜星期数必选string[1,32]
【描述】星期数，以“,”连接多个星期数
【示例值】1,2
time_range_info｜时间段必选timerangeinfo
【描述】时间段
begin_time｜开始时间必选string[1,8]
【描述】开始时间 格式：hh:mm:ss
【示例值】00:00:00
end_time_info｜结束时间必选endtimeinfo
【描述】结束时间，可设置当日或次日结束，例如：22:00~次日07:00
end_time_type｜结束时间类型必选string[1,32]
【描述】结束时间类型
【枚举值】
当日: same_day
次日: next_day
【示例值】next_day
end_time｜结束时间必选string[1,8]
【描述】结束时间 格式：hh:mm:ss
【示例值】23:59:59
date_rule_info｜日期规则特殊可选dateruleinfo
【描述】日期规则。当ruletype = date时，不能为空
date_range_info｜日期范围必选daterangeinfo
【描述】日期范围
begin_date｜开始日期必选string[1,12]
【描述】开始日期 格式：yyyy-mm-dd
【示例值】2023-02-01
end_date｜结束日期必选string[1,12]
【描述】结束日期 格式：yyyy-mm-dd
【示例值】2023-03-31
time_range_info｜时间段必选timerangeinfo
【描述】时间段
begin_time｜开始时间必选string[1,8]
【描述】开始时间 格式：hh:mm:ss
【示例值】00:00:00
end_time_info｜结束时间必选endtimeinfo
【描述】结束时间，可设置当日或次日结束，例如：22:00~次日07:00
end_time_type｜结束时间类型必选string[1,32]
【描述】结束时间类型
【枚举值】
当日: same_day
次日: next_day
【示例值】next_day
end_time｜结束时间必选string[1,8]
【描述】结束时间 格式：hh:mm:ss
【示例值】23:59:59
holiday_rule_info｜节假日规则特殊可选holidayruleinfo
【描述】节假日规则。当ruletype = holiday时，不能为空
time_range_info｜时间段必选timerangeinfo
【描述】时间段
begin_time｜开始时间必选string[1,8]
【描述】开始时间 格式：hh:mm:ss
【示例值】00:00:00
end_time_info｜结束时间必选endtimeinfo
【描述】结束时间，可设置当日或次日结束，例如：22:00~次日07:00
end_time_type｜结束时间类型必选string[1,32]
【描述】结束时间类型
【枚举值】
当日: same_day
次日: next_day
【示例值】next_day
end_time｜结束时间必选string[1,8]
【描述】结束时间 格式：hh:mm:ss
【示例值】23:59:59
relative_period_info｜券相对时间可选voucherrelativeperiodinfo
【描述】券相对时间。
wait_days_after_receive｜用户领券后需要等待 n 天生效可选number[0,999999999]
【描述】用户领券后需要等待 n 天，券才可以生效。
字段值为 0 表示用户领券后立刻生效。
【示例值】2
valid_days_after_receive｜券生效后 n 天内可以使用可选number[1,999999999]
【描述】券生效后 n 天内可以使用。 可以配合wait_days_after_receive 字段使用。
【注意事项】valid_days_after_receive 必须大于 0。
【示例值】3
time_restrict_info｜核销时间限制可选timerestrictinfo
【描述】核销时间限制
usable_period_info｜可用时间段可选array
【描述】可用时间段
rule_type｜规则类型必选string[1,32]
【描述】规则类型
【枚举值】
周期类型: week
日期类型: date
法定节假日类型: holiday
【示例值】week
week_rule_info｜周期规则特殊可选weekruleinfo
【描述】周期规则。当rule_type = week时，不能为空
week_day｜星期数必选string[1,32]
【描述】星期数，以“,”连接多个星期数
【示例值】1,2
time_range_info｜时间段必选timerangeinfo
【描述】时间段
begin_time｜开始时间必选string[1,8]
【描述】开始时间 格式：hh:mm:ss
【示例值】00:00:00
end_time_info｜结束时间必选endtimeinfo
【描述】结束时间，可设置当日或次日结束，例如：22:00~次日07:00
end_time_type｜结束时间类型必选string[1,32]
【描述】结束时间类型
【枚举值】
当日: same_day
次日: next_day
【示例值】next_day
end_time｜结束时间必选string[1,8]
【描述】结束时间 格式：hh:mm:ss
【示例值】23:59:59
date_rule_info｜日期规则特殊可选dateruleinfo
【描述】日期规则。当ruletype = date时，不能为空
date_range_info｜日期范围必选daterangeinfo
【描述】日期范围
begin_date｜开始日期必选string[1,12]
【描述】开始日期 格式：yyyy-mm-dd
【示例值】2023-02-01
end_date｜结束日期必选string[1,12]
【描述】结束日期 格式：yyyy-mm-dd
【示例值】2023-03-31
time_range_info｜时间段必选timerangeinfo
【描述】时间段
begin_time｜开始时间必选string[1,8]
【描述】开始时间 格式：hh:mm:ss
【示例值】00:00:00
end_time_info｜结束时间必选endtimeinfo
【描述】结束时间，可设置当日或次日结束，例如：22:00~次日07:00
end_time_type｜结束时间类型必选string[1,32]
【描述】结束时间类型
【枚举值】
当日: same_day
次日: next_day
【示例值】next_day
end_time｜结束时间必选string[1,8]
【描述】结束时间 格式：hh:mm:ss
【示例值】23:59:59
holiday_rule_info｜节假日规则特殊可选holidayruleinfo
【描述】节假日规则。当ruletype = holiday时，不能为空
time_range_info｜时间段必选timerangeinfo
【描述】时间段
begin_time｜开始时间必选string[1,8]
【描述】开始时间 格式：hh:mm:ss
【示例值】00:00:00
end_time_info｜结束时间必选endtimeinfo
【描述】结束时间，可设置当日或次日结束，例如：22:00~次日07:00
end_time_type｜结束时间类型必选string[1,32]
【描述】结束时间类型
【枚举值】
当日: same_day
次日: next_day
【示例值】next_day
end_time｜结束时间必选string[1,8]
【描述】结束时间 格式：hh:mm:ss
【示例值】23:59:59
disable_period_info｜不可用时间段可选array
【描述】不可用时间段
rule_type｜规则类型必选string[1,32]
【描述】规则类型
【枚举值】
周期类型: week
日期类型: date
法定节假日类型: holiday
【示例值】week
week_rule_info｜周期规则特殊可选weekruleinfo
【描述】周期规则。当rule_type = week时，不能为空
week_day｜星期数必选string[1,32]
【描述】星期数，以“,”连接多个星期数
【示例值】1,2
time_range_info｜时间段必选timerangeinfo
【描述】时间段
begin_time｜开始时间必选string[1,8]
【描述】开始时间 格式：hh:mm:ss
【示例值】00:00:00
end_time_info｜结束时间必选endtimeinfo
【描述】结束时间，可设置当日或次日结束，例如：22:00~次日07:00
end_time_type｜结束时间类型必选string[1,32]
【描述】结束时间类型
【枚举值】
当日: same_day
次日: next_day
【示例值】next_day
end_time｜结束时间必选string[1,8]
【描述】结束时间 格式：hh:mm:ss
【示例值】23:59:59
date_rule_info｜日期规则特殊可选dateruleinfo
【描述】日期规则。当ruletype = date时，不能为空
date_range_info｜日期范围必选daterangeinfo
【描述】日期范围
begin_date｜开始日期必选string[1,12]
【描述】开始日期 格式：yyyy-mm-dd
【示例值】2023-02-01
end_date｜结束日期必选string[1,12]
【描述】结束日期 格式：yyyy-mm-dd
【示例值】2023-03-31
time_range_info｜时间段必选timerangeinfo
【描述】时间段
begin_time｜开始时间必选string[1,8]
【描述】开始时间 格式：hh:mm:ss
【示例值】00:00:00
end_time_info｜结束时间必选endtimeinfo
【描述】结束时间，可设置当日或次日结束，例如：22:00~次日07:00
end_time_type｜结束时间类型必选string[1,32]
【描述】结束时间类型
【枚举值】
当日: same_day
次日: next_day
【示例值】next_day
end_time｜结束时间必选string[1,8]
【描述】结束时间 格式：hh:mm:ss
【示例值】23:59:59
holiday_rule_info｜节假日规则特殊可选holidayruleinfo
【描述】节假日规则。当ruletype = holiday时，不能为空
time_range_info｜时间段必选timerangeinfo
【描述】时间段
begin_time｜开始时间必选string[1,8]
【描述】开始时间 格式：hh:mm:ss
【示例值】00:00:00
end_time_info｜结束时间必选endtimeinfo
【描述】结束时间，可设置当日或次日结束，例如：22:00~次日07:00
end_time_type｜结束时间类型必选string[1,32]
【描述】结束时间类型
【枚举值】
当日: same_day
次日: next_day
【示例值】next_day
end_time｜结束时间必选string[1,8]
【描述】结束时间 格式：hh:mm:ss
【示例值】23:59:59
voucher_use_ext_info｜券使用扩展信息可选string[1,256]
【描述】自定义扩展信息
【枚举值】
123: sku_id
true: over_lay_flag
【注意事项】1.该属性暂未开放。
2.值必须是json格式。
3.json的key值受管控。
4.不允许传空对象{}。
【示例值】{"sku_id":"123","over_lay_flag":"true"}
voucher_customer_guide_info｜券引导详情可选vouchercustomerguideinfo
【描述】券引导详情
voucher_send_guide_info｜券发放引导可选vouchersendguideinfo
【描述】券发放引导
send_guide_mode｜发放引导模式可选array[1,1000]
【描述】发放引导模式
【枚举值】
小程序发放引导: mini_app
【示例值】["mini_app"]
mini_app_send_guide_info｜小程序发放引导可选voucherminiappsendguideinfo
【描述】小程序发放引导
mini_app_url｜指定跳转到mini_app_id时的具体页面路径可选string[1,255]
【描述】小程序发券链接
【示例值】alipays://platformapi/startapp?appid=xxxx
voucher_use_guide_info｜券核销详情可选voucheruseguideinfo
【描述】券核销详情
use_guide_mode｜使用引导模式可选array[1,1000]
【描述】使用引导模式
【枚举值】
券码扫码核销: offline_code
小程序线上核销: mini_app
跳转付款码支付核销: scan_code
【示例值】["mini_app"]
mini_app_use_guide_info｜小程序核销引导可选voucherminiappuseguideinfo
【描述】小程序核销引导
以下参数 二选一 传入必选
mini_app_url｜指定跳转到mini_app_id时的具体页面路径string[1,64]
【描述】小程序核销链接
【注意事项】mini_app_service_codes与mini_app_url只能二选一
【示例值】alipays://platformapi/startapp?appid=xxxx
mini_app_service_codes｜小程序服务编码array[0,16]
【描述】小程序服务编码。取值来源：通过接口创建服务后获取。
【注意事项】mini_app_service_codes与mini_app_url只能二选一
【示例值】["2020030921000303380758"]
常见请求示例
默认示例
curl 'https://openapi.alipay.com/gateway.do?charset=utf-8&method=alipay.marketing.activity.ordervoucher.create&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=rsa2×tamp=${now}' \
-f 'biz_content={
"voucher_deduct_info":{
"fix_voucher_info":{
"amount":"100.00",
"voucher_deduct_threshold_info":{
"voucher_express_info":{
"pay_express":"pay_for_express"
},
"voucher_goods_quantity_specification_info":{
"specification_unit":"count_number",
"directional_type":"fix",
"specification_quantity":2
},
"customer_define_voucher_threshold_desc":"会员可用"
},
"floor_amount":"1000.00"
},
"voucher_type":"fix_voucher",
"discount_voucher_info":{
"ceiling_amount":"50.00",
"voucher_deduct_threshold_info":{
"voucher_express_info":{
"pay_express":"pay_for_express"
},
"voucher_goods_quantity_specification_info":{
"specification_unit":"count_number",
"directional_type":"fix",
"specification_quantity":2
},
"customer_define_voucher_threshold_desc":"会员可用"
},
"discount":"6.5",
"floor_amount":"1000.00"
},
"special_voucher_info":{
"voucher_deduct_threshold_info":{
"voucher_express_info":{
"pay_express":"pay_for_express"
},
"voucher_goods_quantity_specification_info":{
"specification_unit":"count_number",
"directional_type":"fix",
"specification_quantity":2
},
"customer_define_voucher_threshold_desc":"会员可用"
},
"special_amount":"10.00",
"floor_amount":"1000.00"
},
"exchange_voucher_info":{
"amount":"100.00",
"voucher_deduct_threshold_info":{
"voucher_express_info":{
"pay_express":"pay_for_express"
},
"voucher_goods_quantity_specification_info":{
"specification_unit":"count_number",
"directional_type":"fix",
"specification_quantity":2
},
"customer_define_voucher_threshold_desc":"会员可用"
},
"biz_type":"group_buy_exchange_voucher",
"floor_amount":"1000.00",
"exchange_goods_info":{
"exchange_goods_name":"荣耀耳机"
}
},
"customer_define_voucher_info":{
"deduct_info":{
"customer_define_deduct_rule":{
"customer_define_deduct_rule_desc":"生日优惠"
}
}
}
},
"activity_name":"满10减1活动",
"voucher_use_rule":{
"voucher_available_scope":{
"order_voucher_available_city_code":{
"city_codes":[
"100100"
],
"all_city":false
},
"order_voucher_available_shop":{
"real_shop_ids":[
"2018051000502000000011111111",
"2018040200502000000011111111",
"2018062800502000000022271997"
],
"order_voucher_merchant_all_shop":{
"exclude_shop_ids":[
"2018051000502000000011111111",
"2018040200502000000011111111",
"2018062800502000000022271997"
]
},
"shop_ids":[
"2018051000502000000011111111",
"2018040200502000000011111111",
"2018062800502000000022271997"
]
},
"voucher_available_type":"shop"
},
"voucher_valid_period":{
"wait_days_after_receive":2,
"valid_days_after_receive":3,
"valid_end_time":"2017-01-13 23:59:59",
"type":"absolute",
"valid_begin_time":"2017-01-10 00:00:00"
},
"discount_voucher":{
"goods_name":"美味甜甜圈",
"ceiling_amount":"50.00",
"origin_amount":"65.00",
"discount":"6.5",
"floor_amount":"1000.00"
},
"exchange_voucher":{
"overdue_refundable":true,
"customer_service_mobile":"1304004538x",
"amount":"100.00",
"settle_type":"period_merchant",
"voucher_name":"满10减1",
"biz_type":"group_buy_exchange_voucher",
"refundable":false,
"floor_amount":"1000.00",
"payee_pid":"2088010100121",
"sale_amount":"50.00",
"customer_service_url":"alipay://xxxx"
},
"special_voucher":{
"goods_name":"美味甜甜圈",
"origin_amount":"65.00",
"floor_amount":"1000.00",
"special_amount":"10.00"
},
"fix_voucher":{
"goods_name":"美味甜甜圈",
"amount":"100.00",
"floor_amount":"1000.00"
}
},
"voucher_display_pattern_info":{
"customer_service_mobile":"1304004538x",
"voucher_image":"adedsktiqo-u5vjuqvbcqwaaacmaaqed",
"voucher_name":"满10减1券",
"voucher_image_url":"https://gw.alipayobjects.com/mdn/rms_9822d7/afts/img/a*1f4esaaphrqaaaaaaaaaaabkarqnaq",
"voucher_description":"1、本券不可兑换现金，不可找零。2、每个用户最多可以领取1张。3、如果订单发生退款，优惠券无法退还。",
"voucher_detail_images":[
"adedsktiqo-u5vjuqvbcqwaaacmaaqe1",
"adedsktiqo-u5vjuqvbcqwaaacmaaqe2",
"adedsktiqo-u5vjuqvbcqwaaacmaaqe3"
],
"brand_name":"商家优惠",
"brand_logo":"adedsktiqo-u5vjuqvbcqwaaacmaaqed",
"brand_logo_url":"https://gw.alipayobjects.com/mdn/rms_9822d7/afts/img/a*1f4esaaphrqaaaaaaaaaaabkarqnaq",
"voucher_detail_image_urls":[
"https://gw.alipayobjects.com/mdn/rms_9822d7/afts/img/a*1f4esaaphrqaaaaaaaaaaabkarqnaq"
],
"customer_service_url":"alipay://xxxx"
},
"out_biz_no":"20170101000001654bb46ba",
"belong_merchant_info":{
"merchant_id_type":"smid",
"business_type":"isv_for_merchant",
"merchant_id":"2088202967380463"
},
"publish_start_time":"2017-01-01 00:00:01",
"voucher_send_mode_info":{
"voucher_send_rule_info":{
"quantity":100,
"natural_person_limit":false,
"phone_number_need_input_limit":false,
"real_name_limit":false,
"publish_end_time":"2017-01-29 23:59:59",
"quantity_limit_per_user":1,
"quantity_limit_per_user_period_type":"life_cycle",
"max_quantity_by_day":10,
"phone_number_limit":false,
"publish_start_time":"2017-01-01 00:00:01"
},
"voucher_sale_mode_info":{
"overdue_refundable":true,
"settle_info":{
"settle_target_type":"merchant",
"settle_mode":"period"
},
"refundable_need_confirm":false,
"refundable":false,
"overdue_refundable_need_confirm":true,
"payee_pid":"2088xxxxx",
"fund_custody_mode":"guarantee",
"sale_amount":"50.00"
},
"voucher_package_mode_info":{
"voucher_package_id":"ip20220628016671405804297103167741"
},
"voucher_send_mode":"direct_send_mode"
},
"voucher_display_info":{
"customer_service_mobile":"81xxxxxxx",
"voucher_image":"adedsktiqo-u5vjuqvbcqwaaacmaaqed",
"voucher_description":"1、本券不可兑换现金，不可找零。2、每个用户最多可以领取1张。3、如果订单发生退款，优惠券无法退还。",
"voucher_detail_images":[
"adedsktiqo-u5vjuqvbcqwaaacmaaqe1",
"adedsktiqo-u5vjuqvbcqwaaacmaaqe2",
"adedsktiqo-u5vjuqvbcqwaaacmaaqe3"
],
"brand_name":"商家优惠",
"brand_logo":"adedsktiqo-u5vjuqvbcqwaaacmaaqed",
"voucher_comment":"食材新鲜，品质之选",
"customer_service_url":"alipay://xxxx"
},
"voucher_customer_guide_info":{
"voucher_send_guide_info":{
"mini_app_send_guide_info":{
"mini_app_url":"alipays://platformapi/startapp?appid=xxxx"
},
"send_guide_mode":[
"mini_app"
]
},
"voucher_use_guide_info":{
"use_guide_mode":[
"mini_app"
],
"mini_app_use_guide_info":{
"mini_app_url":"alipays://platformapi/startapp?appid=xxxx",
"mini_app_service_codes":[
"2020030921000303380758"
]
}
}
},
"voucher_use_rule_info":{
"quantity_limit_per_user":1,
"quantity_limit_per_user_period_type":"life_cycle",
"voucher_use_time_info":{
"relative_period_info":{
"time_restrict_info":{
"disable_period_info":[
{
"holiday_rule_info":{
"time_range_info":{
"begin_time":"00:00:00",
"end_time_info":{
"end_time_type":"next_day",
"end_time":"23:59:59"
}
}
},
"rule_type":"week",
"week_rule_info":{
"week_day":"1,2",
"time_range_info":{
"begin_time":"00:00:00",
"end_time_info":{
"end_time_type":"next_day",
"end_time":"23:59:59"
}
}
},
"date_rule_info":{
"date_range_info":{
"end_date":"2023-03-31",
"begin_date":"2023-02-01"
},
"time_range_info":{
"begin_time":"00:00:00",
"end_time_info":{
"end_time_type":"next_day",
"end_time":"23:59:59"
}
}
}
}
],
"usable_period_info":[
{
"holiday_rule_info":{
"time_range_info":{
"begin_time":"00:00:00",
"end_time_info":{
"end_time_type":"next_day",
"end_time":"23:59:59"
}
}
},
"rule_type":"week",
"week_rule_info":{
"week_day":"1,2",
"time_range_info":{
"begin_time":"00:00:00",
"end_time_info":{
"end_time_type":"next_day",
"end_time":"23:59:59"
}
}
},
"date_rule_info":{
"date_range_info":{
"end_date":"2023-03-31",
"begin_date":"2023-02-01"
},
"time_range_info":{
"begin_time":"00:00:00",
"end_time_info":{
"end_time_type":"next_day",
"end_time":"23:59:59"
}
}
}
}
]
},
"wait_days_after_receive":2,
"valid_days_after_receive":3
},
"period_type":"absolute",
"absolute_period_info":{
"time_restrict_info":{
"disable_period_info":[
{
"holiday_rule_info":{
"time_range_info":{
"begin_time":"00:00:00",
"end_time_info":{
"end_time_type":"next_day",
"end_time":"23:59:59"
}
}
},
"rule_type":"week",
"week_rule_info":{
"week_day":"1,2",
"time_range_info":{
"begin_time":"00:00:00",
"end_time_info":{
"end_time_type":"next_day",
"end_time":"23:59:59"
}
}
},
"date_rule_info":{
"date_range_info":{
"end_date":"2023-03-31",
"begin_date":"2023-02-01"
},
"time_range_info":{
"begin_time":"00:00:00",
"end_time_info":{
"end_time_type":"next_day",
"end_time":"23:59:59"
}
}
}
}
],
"usable_period_info":[
{
"holiday_rule_info":{
"time_range_info":{
"begin_time":"00:00:00",
"end_time_info":{
"end_time_type":"next_day",
"end_time":"23:59:59"
}
}
},
"rule_type":"week",
"week_rule_info":{
"week_day":"1,2",
"time_range_info":{
"begin_time":"00:00:00",
"end_time_info":{
"end_time_type":"next_day",
"end_time":"23:59:59"
}
}
},
"date_rule_info":{
"date_range_info":{
"end_date":"2023-03-31",
"begin_date":"2023-02-01"
},
"time_range_info":{
"begin_time":"00:00:00",
"end_time_info":{
"end_time_type":"next_day",
"end_time":"23:59:59"
}
}
}
}
]
},
"valid_end_time":"2017-01-13 23:59:59",
"valid_begin_time":"2017-01-10 00:00:00"
}
},
"voucher_max_use_times":1,
"voucher_use_ext_info":"{\"sku_id\":\"123\",\"over_lay_flag\":\"true\"}"
},
"publish_end_time":"2017-01-29 23:59:59",
"voucher_type":"fix_voucher",
"customer_guide":{
"voucher_use_guide":{
"mini_app_path":"/index/path/path&query=xx=xx",
"offline_code_use_guide":true,
"mini_app_id":"2021238412323412",
"service_codes":[
"2020030921000303380758"
],
"mini_app_use_guide":true
},
"voucher_send_guide":{
"voucher_detail_url":"alipays://platformapi/startapp?appid=xxxx"
}
},
"voucher_available_scope_info":{
"voucher_available_geography_scope_info":{
"available_geography_shop_info":{
"available_geography_all_shop":{
"exclude_shop_ids":[
"2018051000502000000011111111",
"2018040200502000000011111111",
"2018062800502000000022271997"
],
"merchant_ids":[
"208805x000502"
],
"available_brand_id":"2022111600502042000001279859"
},
"available_shop_ids":[
"2018051000502000000011111111",
"2018040200502000000011111111",
"2018062800502000000022271997"
],
"available_real_shop_ids":[
"2018051000502000000011111111",
"2018040200502000000011111111",
"2018062800502000000022271997"
]
},
"available_geography_scope_type":"shop",
"available_geography_city_info":{
"available_city_codes":[
"100100"
],
"all_city":false
}
},
"voucher_available_app_info":{
"available_app_ids":[
"2021238412323412"
]
},
"voucher_available_goods_info":{
"goods_name":"美味甜甜圈",
"origin_amount":"65.00",
"available_goods_sku_ids":[
"apple-01",
"apple-02"
],
"goods_detail_rich_description":"美食团购",
"goods_description":"美味甜甜圈很美味",
"goods_detail":"米饭1份",
"exclude_goods_sku_ids":[
"apple-03",
"apple-04"
],
"goods_detail_images":[
"adedsktiqo-u5vjuqvbcqwaaacmaaqe1",
"adedsktiqo-u5vjuqvbcqwaaacmaaqe2",
"adedsktiqo-u5vjuqvbcqwaaacmaaqe3"
]
},
"voucher_available_account_info":{
"available_smids":[
"2088102111111111"
],
"available_pids":[
"2088102111111111"
]
}
},
"code_mode":"merchant_upload",
"voucher_send_rule":{
"voucher_quantity":100,
"natural_person_limit":false,
"voucher_quantity_limit_per_user":1,
"phone_number_limit":false
},
"activity_base_info":{
"activity_name":"满10减1活动",
"activity_product_type":"order_voucher",
"out_activity_id":"20230331001",
"activity_id":"2016042700826004508401111111",
"code_mode":"merchant_upload",
"activity_operation_status":"modifying",
"belong_merchant_info":{
"merchant_id_type":"smid",
"business_type":"isv_for_merchant",
"merchant_id":"2088202967380463"
},
"activity_status":"active"
},
"merchant_access_mode":"agency_mode"
}' 说明：本示例仅供参考。
公共响应参数
业务响应参数
activity_id｜活动id必选string(128)
【描述】活动id
【示例值】2016042700826004508401111111
voucher_use_rule_result｜券核销规则请求结果可选ordervoucheruseruleresult
【描述】券核销规则请求结果
voucher_available_scope_result｜商家券可用范围请求结果必选ordervoucheravailablescoperesult
【描述】商家券可用范围请求结果
voucher_available_type｜可用范围类型必选string(32)
【描述】可用范围类型。
【枚举值】
可用门店: shop
可用城市: city_code
【示例值】shop
order_voucher_available_shop_result｜可用门店请求结果可选ordervoucheravailableshopresult
【描述】可用门店请求结果。
success_shop_ids｜请求成功的支付宝门店可选string[](84000)
【描述】请求成功的支付宝门店。
【示例值】["2018051000502000000011111111","2018040200502000000011111111","2018062800502000000022271997"]
shop_fail_infos｜请求失败的支付宝门店详情可选ordervouchershopfailinfo[]
【描述】请求失败的支付宝门店详情。
shop_id｜门店id必选string(32)
【描述】支付宝侧蚂蚁店铺 id。
【示例值】2018051000502000000011111111
fail_reasons｜请求失败的原因必选string[](32)
【描述】请求失败的原因。
【枚举值】
门店信息不全: shop_info_not_pass
门店不存在: shop_not_exist
门店与商户没有关联关系: merchant_shop_relation_not_exist
【示例值】["shop_not_exist"]
fail_message｜请求失败提示信息可选string(1000)
【描述】请求失败提示信息。
【示例值】门店不存在
success_real_shop_ids｜请求成功的代运营商业关系门店可选string[](84000)
【描述】请求成功的代运营商业关系门店
【示例值】["2018051000502000000011111111","2018040200502000000011111111","2018062800502000000022271997"]
real_shop_fail_infos｜请求失败的代运营商业关系门店详情可选ordervoucherrealshopfailinfo[]
【描述】请求失败的代运营商业关系门店详情
real_shop_id｜物理门店id必选string(32)
【描述】请求失败的代运营商业关系门店 id。
【示例值】2018051000502000000011111111
fail_reasons｜请求失败原因必选string[](32)
【描述】请求失败原因。
【枚举值】
门店信息不全: shop_info_not_pass
门店不存在: shop_not_exist
门店与商户没有关联关系: merchant_shop_relation_not_exist
【示例值】["shop_not_exist"]
fail_message｜请求失败提示信息可选string(1000)
【描述】请求失败提示信息。
【示例值】门店不存在
order_voucher_merchant_all_shop_result｜商户全部门店可用请求结果可选ordervouchermerchantallshopresult
【描述】商户全部门店可用请求结果。
success_exclude_shop_ids｜请求成功的不可用门店列表可选string[](84000)
【描述】请求成功的不可用门店列表。
【示例值】["2018051000502000000011111111","2018040200502000000011111111","2018062800502000000022271997"]
exclude_shop_fail_infos｜请求失败的不可用门店详情可选ordervouchershopfailinfo[]
【描述】请求失败的不可用门店详情。
shop_id｜门店id必选string(32)
【描述】支付宝侧蚂蚁店铺 id。
【示例值】2018051000502000000011111111
fail_reasons｜请求失败的原因必选string[](32)
【描述】请求失败的原因。
【枚举值】
门店信息不全: shop_info_not_pass
门店不存在: shop_not_exist
门店与商户没有关联关系: merchant_shop_relation_not_exist
【示例值】["shop_not_exist"]
fail_message｜请求失败提示信息可选string(1000)
【描述】请求失败提示信息。
【示例值】门店不存在
voucher_available_scope_result_info｜券可用范围结果可选voucheravailablescoperesultinfo
【描述】可用范围结果
voucher_available_geography_scope_result_info｜可用地理位置可选voucheravailablegeographyscoperesultinfo
【描述】可用地理位置。
available_geography_shop_result_info｜可用门店结果可选voucheravailablegeographyshopresultinfo
【描述】可用门店结果。
success_available_shop_ids｜券可使用的门店列表可选string[](84000)
【描述】券可使用的门店列表。列表中的门店id是通过调用接口ant.merchant.expand.shop.create创建门店返回的支付宝门店id 接口参数是列表类型。
【注意事项】1. shop_ids 中的门店id必须是支付宝门店 id。
2. shop_ids 如果包含重复的门店id会自动进行去重操作。
3. shop_ids、real_shop_ids、order_voucher_merchant_all_shop 必须三选一。
【示例值】["2018051000502000000011111111","2018040200502000000011111111","2018062800502000000022271997"]
fail_available_shop_infos｜失败的可用门店可选voucherfailshopinfo[]
【描述】失败的可用门店。
shop_id｜门店 id可选string(32)
【描述】支付宝侧蚂蚁店铺 id。
【示例值】2018051000502000000011111111
real_shop_id｜物理门店id可选string(32)
【描述】请求失败的物理门店 id。
【示例值】2018051000502000000011111111
fail_reasons｜请求失败的原因可选string[](32)
【描述】请求失败的原因。
【枚举值】
门店信息不全: shop_info_not_pass
门店不存在: shop_not_exist
门店与商户没有关联关系: merchant_shop_relation_not_exist
【示例值】["shop_not_exist"]
fail_message｜请求失败提示信息可选string(1000)
【描述】请求失败提示信息。
【示例值】门店不存在
success_available_real_shop_ids｜代运营商业关系门店列表可选string[](84000)
【描述】代运营商业关系门店列表，列表中的门店id是调用接口alipay.business.relation.shop.create创建门店返回的real_shop_id 接口参数是列表类型。
【注意事项】1. real_shop_ids 中的门店id必须是代运营商业关系门店 id。
2. real_shop_ids 如果包含重复的门店 id 会自动进行去重操作。
3. shop_ids、real_shop_ids、order_voucher_merchant_all_shop 必须三选一。
【示例值】["2018051000502000000011111111","2018040200502000000011111111","2018062800502000000022271997"]
fail_available_real_shop_infos｜失败的物理门店详情可选voucherfailshopinfo[]
【描述】失败的物理门店详情。
shop_id｜门店 id可选string(32)
【描述】支付宝侧蚂蚁店铺 id。
【示例值】2018051000502000000011111111
real_shop_id｜物理门店id可选string(32)
【描述】请求失败的物理门店 id。
【示例值】2018051000502000000011111111
fail_reasons｜请求失败的原因可选string[](32)
【描述】请求失败的原因。
【枚举值】
门店信息不全: shop_info_not_pass
门店不存在: shop_not_exist
门店与商户没有关联关系: merchant_shop_relation_not_exist
【示例值】["shop_not_exist"]
fail_message｜请求失败提示信息可选string(1000)
【描述】请求失败提示信息。
【示例值】门店不存在
available_geography_all_shop_result_info｜全部门店结果可选voucheravailablegeographyallshopresultinfo
【描述】全部门店结果。
success_exclude_shop_ids｜请求成功的不可用门店列表可选string[](84000)
【描述】请求成功的不可用门店列表。
【示例值】["2018051000502000000011111111","2018040200502000000011111111","2018062800502000000022271997"]
fail_exclude_shop_infos｜请求失败的不可用门店详情可选voucherfailshopinfo[]
【描述】请求失败的不可用门店详情。
shop_id｜门店 id可选string(32)
【描述】支付宝侧蚂蚁店铺 id。
【示例值】2018051000502000000011111111
real_shop_id｜物理门店id可选string(32)
【描述】请求失败的物理门店 id。
【示例值】2018051000502000000011111111
fail_reasons｜请求失败的原因可选string[](32)
【描述】请求失败的原因。
【枚举值】
门店信息不全: shop_info_not_pass
门店不存在: shop_not_exist
门店与商户没有关联关系: merchant_shop_relation_not_exist
【示例值】["shop_not_exist"]
fail_message｜请求失败提示信息可选string(1000)
【描述】请求失败提示信息。
【示例值】门店不存在
响应示例
正常示例
异常示例
{
"alipay_marketing_activity_ordervoucher_create_response": {
"code": "10000",
"msg": "success",
"activity_id": "2016042700826004508401111111",
"voucher_use_rule_result": {
"voucher_available_scope_result": {
"voucher_available_type": "shop",
"order_voucher_available_shop_result": {
"success_shop_ids": [
"2018051000502000000011111111",
"2018040200502000000011111111",
"2018062800502000000022271997"
],
"shop_fail_infos": [
{
"shop_id": "2018051000502000000011111111",
"fail_reasons": [
"shop_not_exist"
],
"fail_message": "门店不存在"
}
],
"success_real_shop_ids": [
"2018051000502000000011111111",
"2018040200502000000011111111",
"2018062800502000000022271997"
],
"real_shop_fail_infos": [
{
"real_shop_id": "2018051000502000000011111111",
"fail_reasons": [
"shop_not_exist"
],
"fail_message": "门店不存在"
}
],
"order_voucher_merchant_all_shop_result": {
"success_exclude_shop_ids": [
"2018051000502000000011111111",
"2018040200502000000011111111",
"2018062800502000000022271997"
],
"exclude_shop_fail_infos": [
{
"shop_id": "2018051000502000000011111111",
"fail_reasons": [
"shop_not_exist"
],
"fail_message": "门店不存在"
}
]
}
}
}
},
"voucher_available_scope_result_info": {
"voucher_available_geography_scope_result_info": {
"available_geography_shop_result_info": {
"success_available_shop_ids": [
"2018051000502000000011111111",
"2018040200502000000011111111",
"2018062800502000000022271997"
],
"fail_available_shop_infos": [
{
"shop_id": "2018051000502000000011111111",
"real_shop_id": "2018051000502000000011111111",
"fail_reasons": [
"shop_not_exist"
],
"fail_message": "门店不存在"
}
],
"success_available_real_shop_ids": [
"2018051000502000000011111111",
"2018040200502000000011111111",
"2018062800502000000022271997"
],
"fail_available_real_shop_infos": [
{
"shop_id": "2018051000502000000011111111",
"real_shop_id": "2018051000502000000011111111",
"fail_reasons": [
"shop_not_exist"
],
"fail_message": "门店不存在"
}
],
"available_geography_all_shop_result_info": {
"success_exclude_shop_ids": [
"2018051000502000000011111111",
"2018040200502000000011111111",
"2018062800502000000022271997"
],
"fail_exclude_shop_infos": [
{
"shop_id": "2018051000502000000011111111",
"real_shop_id": "2018051000502000000011111111",
"fail_reasons": [
"shop_not_exist"
],
"fail_message": "门店不存在"
}
]
}
}
}
}
},
"sign": "eritjkeijkjhkkkkkkkhjereeeeeeeeeee"
}说明：本示例仅供参考。
公共错误码
业务错误码
| 错误码 | 错误描述 | 凯发app官方网站的解决方案 |
|---|---|---|
| system_error | 系统繁忙 | 服务器异常 可能发生了网络或者系统异常，导致服务调用失败，商户可以用同样的请求发起重试 |
| invalid_parameter | 参数有误 | 请根据接口返回的参数非法的具体错误信息，修改参数后进行重试 |
| biz_error | 业务异常门店无效.请检查门店是否存在,并且门店属于该商户pid | 检查传入的门店id在支付宝体系中是否存在。同时门店id要归属于商户pid 或 pid所关联的smid。 |
| biz_error | 业务异常小程序无效.请检查小程序是否存在,并且小程序属于该商户pid | 检查传入的小程序id在支付宝体系中是否存在。同时小程序id要归属于商户pid。 |
| biz_error | 业务异常缺少代运营关系 | isv与商户进行代运营关系的授权 |
| biz_error | 业务异常业务异常活动存在正在进行中的其他操作 | 活动的创建、修改、追加等操作都是异步进行的。因此如在活动修改中时，发出追加操作，会提示活动存在正在进行中的其他操作。 |
| business_has_risk | 请求存在风险 | 请检查参数传入是否正确 |
| discount_amount_insufficient | 最高优惠金额小于下限 | 请提高优惠金额后重新发起请求 |