更新时间：2025-03-12 15:20:57收藏订阅更新我的文档设置返回文档商家/服务商可根据本文指引快速集成 领券组件插件。1 完整接口时序图商家/服务商完成商家券和支付券的创建后，可通过该接口发放优惠券。说明：●支付宝提供 alipay.marketing.activity.consult（商家营销活动咨询接口），用于商家/服务商前置过滤用户不可领取的优惠券，提升用户体验。●支持发券的内容包括：商家券 与 支付券，其中商家券：○通过 openapi 创建商家券。■针对 导码（导入 code（券码））模式，可以在使用领取组件的发券功能，无需传入 vouchercode，进行支付宝侧的商家券发放。■针对 发券时指定券码（非导码） 模式，在使用领券组件时可查看接口时序图中的 2.1.1 步骤。先进行商家侧的商家券发放，获取对应的 vouchercode 券码。在调用领券组件的发券功能时，传入该 vouchercode，进行支付宝侧的商家券发放。●支持发券的内容包括：商家券 与 支付券，其中支付券：○支持 、 配置的支付券。○支持最新的 openapi 配置的支付券。○由于支付券不需要导入券码，因此在发放后返回的结果中，商家/服务商可根据自身情况，使用 voucherid 字段（该字段在后面的发放参数中有详细说明）。2 接入活动咨询接口在用户正式领券前，商家/服务商可在服务端提前调用 alipay.marketing.activity.consult（活动领取咨询接口）过滤用户不可领取的优惠券，并在小程序中展示用户可领取优惠券，供用户判断是否领取，提升用户体验。2.1 示例代码2.2 响应示例3 接入领券组件插件商家/服务商可根据本文指引快速集成 领券组件插件，在商家小程序中推广商家券。3.1 第一步：订购插件使用小程序归属的支付宝主账号订购 。注意：服务商代商家接入时，由服务商订购插件。3.2 第二步：接入插件3.2.1 插件使用声明使用插件前，使用者需要在 app.json 中声明需要使用的插件。示例代码：3.2.2 版本兼容使用插件的小程序项目支持 ide 0.60 及以上版本进行编译构建。插件的运行要求小程序基础库为 1.22.4 及以上版本，支付宝客户端 10.1.85 及以上版本，小程序在使用插件的时候，需要按照以下方式兼容。注意：●兼容代码一定要放到 app.js 文件的开头处，不能放到生命周期方法中，如果不做上述兼容处理，在基础库版本低于 1.18.0 时可能会导致页面白屏。●插件官方文档是使用 !my.caniuse('plugin') && !my.iside 来判断插件是否可用，但该方法对于 10.1.82 的客户端返回 true，故需要用直接判断客户端版本号的方式。●需安装 compare-versions 依赖。●更多详情可查看 插件使用。3.2.3 使用插件组件领券组件是以插件 component（组件）的形式提供，插件的自定义组件和普通的 自定义组件 使用方法类似。在需要使用插件的小程序页面 .json 文件中，定义需要引用的插件自定义组件时，通过 plugin:// 协议指明需要引用的插件自定义组件。示例代码：在使用插件的小程序页面 .axml 文件中，使用上一步声明依赖的插件 component。注意：插件内部元素不支持嵌套插槽（slot）。在使用插件的小程序页面 .js 文件中定义插件使用的方法。示例代码：3.2.4 插件参数说明名称类型是否必填描述ongetcouponsuccessstring否领券请求 成功调用的事件，领券结果可能成功也可能失败。ongetcouponfailstring否领券请求 失败调用的事件，如网络错误、接口超时、用户未登录、接口报错等。onuseimmediatelystring否点击 立即使用 按钮触发的事件，前提是设置了 dialogbtntype 值为 2。onclosestring否弹窗关闭事件。paramsarray是发券参数，一次最多 10 张。 示例值： 发一张券 json：[{ "activityid": "20220426008260043360152xxxx","outbizno": "12xxxqccc1qxxc1"}]发多张券 json（支持同时发放 导码模式、非导码模式 商家券）：[{activityid: '20220426008260043360152xxxx',outbizno: '20220xxxx',// 导码模式商家券},{activityid: '20220426008260043360152xxxx',outbizno: '20220xxxx',},{ activityid: '20220426008260043360152xxxx',outbizno: '20220xxxx',vouchercode: '2022xxxxxxx',//非导码模式商家券}]sendermerchantidstring否发放者商户号。注意：投放券的小程序 appid、发放商户号 sendermerchantid 要和制券方或者是券的归属方对应的 pid 保持一致。dialogbtntypenumber否弹窗按钮的类型，默认值为 1。按钮状态有可能为 重新领取，由插件内部控制，使用者不感知；券领取全部失败时仍为 我知道了。1显示按钮文本为 我知道了，点击关闭弹窗。2显示按钮文本为 立即使用，在用户点击的时候触发 onuseimmediately 事件并关闭弹窗。dialogbtnstyleobject否弹窗按钮的样式，可以设置 color、bordercolor、backgroundcolor 三种样式值。示例：{color: '#000',bordercolor: 'yellowgreen',backgroundcolor: 'yellowgreen'}zindexnumber否弹窗的层级。boxboundingobject否影响 fixed 定位的祖先元素的边界信息。即该祖先元素距离视口（viewport）的左边距（left）和底部边距（bottom）。示例：{left: 30,bottom: 500,}params 参数说明params 是一个包含以下字段的 object 类型的数组。参数名称是否必填参数说明activityid是活动 id，创建商家券活动成功后获取。outbizno是发券的唯一幂等 id，商家自定义，需保证唯一性。vouchercode否商家券 非导码模式 必填。发券的唯一标识，商家自定义，需保证唯一性。boxbounding 计算方式返回处理 - ongetcouponsuccess事件接收的返回结果 resultlist 是一个 array 类型，数组的每一项信息查看以下说明。字段类型是否必填描述activityidstring是活动 id。outbiznostring是发券的唯一幂等 id。vouchercodestring是券的唯一标识。商家券会返回 vouchercode，支付券该字段为空。voucheridstring是券 id。该券 id 只有在支付券的时候才使用，商家券无需感知该字段。codestring是领券结果，见下列表。领券结果对应值见下表，商家可根据业务情况优化领券结果描述。领券结果描述凯发app官方网站的解决方案success成功-activity_not_start活动未开始-count_over_limit领取次数超过限制-budget_not_enough预算不足-other其他原因出现 other 原因请咨询支付宝凯发app官方网站的技术支持。返回处理 - ongetcouponfail事件接收的返回结果 result 是一个 object 类型，数据查看以下说明。字段类型是否必填描述errorcodenamestring是错误码，可查看下方列表。errormsgstring是错误描述。错误码列表 :错误码描述凯发app官方网站的解决方案request_param_illegal请求参数非法。-integration_error下游服务调用异常。-misc_error杂类错误，如网络断开、传参错误等。请检查网络、前端传参等信息。unknown_exception未知异常。请咨询支付宝凯发app官方网站的技术支持。注意：如果是 misc_error 错误，可以打开调试器 > applog > 找到对应的 rpc 请求，查看具体原因。
