开发者社区
社区提问意见反馈
开发者钉组织
扫描二维码
加入支付宝开发者钉组织
支付产品
私域产品
公域产品
营销产品
商家券 2.0
接入指南
api 列表
活动创建
活动修改
活动停止
预算追加
活动发放
优惠券核销
活动查询
蚂蚁店铺
相关资料
商家会员卡
红包
棋盘密云
支付券
芝麻实力标
资金产品
会员产品
信用产品
安全产品
广告产品
开发 > 服务端 >  >  >  > 接口概述
收藏
订阅更新
我的文档
设置
接入检测
即可查看检测结果)
若有未通过的接入检测项,接口将无法调通
资源关系
original.png

ordervoucheractivity(商家券活动)
商家举办的一场特定优惠规则的营销活动,以券的形式将活动权益发放出去。
商家券活动的字段列表
参数
类型
描述
activity_id
string
活动 id。
activity_lite_infos
activityliteinfo[]
活动摘要信息。
activity_name
string
活动名称,不对用户进行展示,仅供商家在后台管理活动使用。
activity_operation_status
string
活动操作状态。枚举值:
creating:创建中。
modifying:修改中。
appending:追加中。
finisheing:终止中。
注意:该值为空,说明活动当前没有正在执行中的操作。
activity_status
string
活动状态。 枚举值:
active:已激活(活动正常运行)。
finished:已终止(商家终止活动,不可再发放)。
注意:该值为空,说明活动还未创建成功。可以使用 activity_operation_status 字段判断活动是否处于 creating 状态。
app_infos
activityappinfo[]
可用小程序列表。
belong_merchant_id
string
归属商户 pid
belong_merchant_info
belongmerchantinfo
活动归属商户信息。限制:服务商身份接入时必传。
biz_tag
string
商家券业务标签,影响商家券对 c 端用户的展示形式。枚举值:
group_buy_exchange_voucher:兑换券团购场景。
fix_exchange_voucher:兑换券代金场景。
code_mode
string
券码模式,枚举值:
merchant_upload:商户上传自定义 code,发券时系统随机选取上传的券 code 发放。
merchant_api:发奖时指定券码发奖,此模式无须提前上传券码(该模式暂时只针对 exchange_voucher 生效)。
customer_guide
customerguide
券自定义入口。
goods_infos
activitygoodsinfo[]
商品编码列表。
merchant_id
string
商户 pid,默认为当前接口调用商家。
注意:接口调用者必须有商户代运营权限,可查看
merchant_infos
activitymerchantinfo[]
可用商户列表。
mini_app_id
string
小程序 id。
out_biz_no
string
外部业务单号,用作幂等控制。幂等作用:参数不变的情况下,再次请求返回与上一次相同的结果。外部接入方需保证业务单号唯一。
publish_end_time
date
券发放结束时间。格式为:yyyy-mm-dd hh:mm:ss。
publish_start_time
date
券发放开始时间。格式为:yyyy-mm-dd hh:mm:ss。
shop_id
string
支付宝侧蚂蚁店铺 id。
shop_infos
activityshopinfo[]
可用门店列表。
voucher_display_info
voucherdisplayinfo
券展示信息。
voucher_quantity
number
发券数量上限。券总预算值,不可减少,只能增加。
注意:券总预算小于或等于 999999 code_mode= merchant_upload 的情况下, voucher_quantity 需要与导入码的总数量保持一致。
voucher_send_rule
vouchersendruledetail
券发放规则。
voucher_type
string
券类型,枚举值:
fix_voucher:满减券。
discount_voucher:折扣券
special_voucher:特价券
exchange_voucher: 兑换券。
voucher_use_rule
voucheruserule
券核销规则。
voucher_use_rule_result
ordervoucheruseruleresult
核销规则请求结果。
商家券活动支持的操作
api 中文名称
api 英文名称
创建商家券活动
alipay.marketing.activity.ordervoucher.create
商家券活动创建通知
alipay.marketing.activity.message.created
修改商家券活动基本信息
alipay.marketing.activity.ordervoucher.modify
商家券活动修改通知
alipay.marketing.activity.message.modified
查询商家券活动
alipay.marketing.activity.ordervoucher.query
停止商家券活动
alipay.marketing.activity.ordervoucher.stop
商家券活动停止通知
alipay.marketing.activity.message.stopped
修改商家券活动发券数量上限
alipay.marketing.activity.ordervoucher.append
商家券活动预算追加通知
alipay.marketing.activity.message.appended
条件查询活动列表
alipay.marketing.activity.batchquery
查询活动详情
alipay.marketing.activity.query
商家营销活动咨询
alipay.marketing.activity.consult
查询活动可用小程序
alipay.marketing.activity.app.batchquery
查询活动可用门店
alipay.marketing.activity.shop.batchquery
查询活动适用商品
alipay.marketing.activity.goods.batchquery
ordervoucher(商家券)
商家券活动发放的符合活动规则的优惠券,每张优惠券有不同的券码。
商家券的字段列表
参数
类型
描述
voucher_code
string
券码,单个 code 最长 64 位。 code 允许包含的字符有 0-9、a-z、a-z、-、_、 、=、|。
activity_id
string
活动 id。
belong_merchant_id
string
券归属商户。
biz_dt
string
外部优惠券的核销时间,用于流水记录。格式为:yyyy-mm-dd hh:mm:ss。
fail_count
string
导入失败的券码数量。
goods_detail
goodsdetaildto[]
商品明细信息。 说明:若当前交易中存在商品信息,则建议传入商品明细信息。
out_biz_no
string
外部业务单号,用作幂等控制。 幂等作用: 参数不变的情况下,再次请求返回与上一次相同的结果。 外部接入方需保证业务单号唯一。
real_shop_id
string
用户核销优惠券的代运营商业关系门店 id。
store_id
string
用户核销优惠券的支付门店 id。
success_count
number
已经导入的券码数量。
trade_channel
string[]
交易渠道。枚举值:
zhifubao_trade_channel:支付宝交易渠道。
wx_trade_channel:微信交易渠道。
other_trade_channel:其他交易渠道。
trade_no
string
该交易在支付宝系统中的交易流水号。
注意:若用户使用支付宝为交易的渠道,本参数必填。
user_id(open_id)
string
支付宝用户 id。新商户建议使用open_id替代该字段。对于新商户,user_id字段未来计划逐步回收,存量商户可继续使用。如使用open_id,请确认 应用-开发配置-openid配置管理 已启用。无该配置项,可查看openid配置申请
user_voucher_infos
uservoucherinfo[]
用户券实例。
voucher_display_info
commonvoucherdisplayinfo
券展示信息。
voucher_name
string
券名称。
voucher_send_rule
commonvouchersendrule
券发放规则。
voucher_status
string
券状态,枚举值:
sended:可用。
used:已核销。
expired:已过期(可查询 6 个月内数据)。
voucher_use_rule
commonvoucheruserule
券核销规则。
商家券支持的操作
api 中文名称
api 英文名称
取消券核销状态
alipay.marketing.activity.ordervoucher.refund
同步券核销状态
alipay.marketing.activity.ordervoucher.use
同步商家券券码
alipay.marketing.activity.ordervoucher.codedeposit
统计商家券券码数量
alipay.marketing.activity.ordervoucher.codecount
条件查询用户券
alipay.marketing.activity.user.batchqueryvoucher
查询用户券详情
alipay.marketing.activity.user.queryvoucher
商家券领取通知
alipay.marketing.activity.message.received
券核销消息
alipay.marketing.activity.message.used
券过期消息
alipay.marketing.activity.message.expired
mrshop(蚂蚁店铺)
蚂蚁商家可通过接口经营单元(如门店)的创建、查询等功能,方便服务商帮助商家创建门店、管理门店信息。
蚂蚁店铺的字段列表
参数
类型
描述
shop_id
string
蚂蚁店铺 id
business_address
addressinfo
经营地址。
business_time
shopbusinesstime
店铺经营时间。
cert_image
string
营业执照图片。
contact_infos
contactinfo
联系人信息。
ip_role_id
string
商户角色 id,表示将要开的店属于哪个商户角色。对于直连开店场景,填写商户 pid;对于间连开店场景(线上、线下、直付通),填写商户 smid。若没传 shop_id,则本字段与 store_id 均必填。
mcc
string[]
商户 mcc 类目。
qualifications
industryqualificationinfo[]
行业特殊资质。
shop_category
string
店铺类目,取值可查看 中的三级门店类目。
shop_infos
shopqueryopenapivo[]
门店详情。
shop_name
string
店铺名称。
shop_type
string
店铺经营类型,枚举值:
01:表示直营。
02:表示加盟。
store_id
string
门店编号。
蚂蚁店铺支持的操作
api 中文名称
api 英文名称
蚂蚁店铺创建
ant.merchant.expand.shop.create
店铺保存审核通过消息
ant.merchant.expand.shop.save.passed
店铺保存拒绝消息
ant.merchant.expand.shop.save.rejected
修改蚂蚁店铺
ant.merchant.expand.shop.modify
商户申请单查询
ant.merchant.expand.order.query
店铺查询
ant.merchant.expand.shop.query
店铺分页查询
ant.merchant.expand.shop.page.query
蚂蚁店铺关闭
ant.merchant.expand.shop.close
mcc(商户类目)
商户类目信息。
商户类目的字段列表
参数
类型
描述
mcc
string
mcc 类目。
mcc_info_list
mccqueryinfo[]
mcc 查询信息结果列表。
商户类目支持的操作
api 中文名称
api 英文名称
商户 mcc 信息查询
ant.merchant.expand.mcc.query
image(商家图片)
商家信息相关图片。
商家图片的字段列表
参数
类型
描述
image_id
string
图片 id。
image_type
string
图片格式,支持格式:bmp、jpg、jpeg、png、gif。
商家图片支持的操作
api 中文名称
api 英文名称
图片上传
ant.merchant.expand.indirect.image.upload
内容没有解决您的问题?您还可以前往 或 寻求帮助
凯发k8官方网娱乐官方 copyright © 支付宝(杭州)信息技术有限公司  | icp证浙b2-20160559
该文档对你是否有帮助?
当前页面目录
网站地图