同步券核销状态

商户调用该接口，通过券码进行优惠券核销，接口同步返回核销结果。

curl --location --request POST 'http://dev-cn.your-api-server.com/v3/alipay/marketing/ordervoucher/activity//voucher//use' \ --header 'Content-Type: application/json' \ --data-raw '{ "voucher_use_detail_info": { "voucher_use_times": 1 }, "goods_detail": [ { "goods_id": "apple-01", "goods_name": "ipad", "price": "2000.00", "quantity": 1 } ], "merchant_access_mode": "AGENCY_MODE", "out_biz_no": "20170101000001654bb46ba", "real_shop_id": "2018051000502000000011111111", "store_id": "2018051000502000000011111111", "total_fee": "999.99", "trade_channel": "ZHIFUBAO_TRADE_CHANNEL", "trade_no": "2021042322001426261436764012", "biz_dt": {} }'

请求参数

Path 参数

activity_id

string

活动id

必需

voucher_code

string

待核销的券码。

必需

Body 参数application/json

voucher_use_detail_info

object (VoucherUseDetailInfo)

可选

voucher_use_times

integer

可选

本次核销次数（不包含撤销核销的次数）

示例值:

goods_detail

array[object (GoodsDetailDTO) {4}]

可选

"商品明细信息。限制：当前交易中存在商品信息，则建议传入商品明细信息。"

goods_id

string

商品编号

可选

示例值:

apple-01

goods_name

string

商品名称

可选

示例值:

ipad

price

string

可选

商品单价。单位元精确到小数点后2位。

示例值:

2000.00

quantity

integer

商品数量

可选

示例值:

merchant_access_mode

string

商户接入模式

可选

示例值:

AGENCY_MODE

out_biz_no

string

可选

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

示例值:

20170101000001654bb46ba

real_shop_id

string

可选

用户核销优惠券的代运营商业关系门店id，调用接口alipay.business.relation.shop.create创建门店返回的real_shop_id。限制: 传入的门店id必须是创建商家券voucher_use_rule. voucher_available_scope. order_voucher_available_shop对象中real_shop_ids中的门店id

示例值:

2018051000502000000011111111

store_id

string

可选

用户核销优惠券的支付门店id,调用接口ant.merchant.expand.shop.create创建门店返回的门店id。限制: 传入的门店id必须是创建商家券voucher_use_rule. voucher_available_scope. order_voucher_available_shop对象中shop_ids中的门店id

示例值:

2018051000502000000011111111

total_fee

string

订单优惠前的总金额

可选

示例值:

999.99

trade_channel

string

交易渠道。

可选

示例值:

ZHIFUBAO_TRADE_CHANNEL

trade_no

string

可选

该交易在支付宝系统中的交易流水号。注意：若用户使用支付宝为交易的渠道，本参数必填。

示例值:

2021042322001426261436764012

biz_dt

string

可选

外部优惠券的核销时间，用于流水记录。格式为：yyyy-MM-dd HH:mm:ss

示例值:

{}

示例

application/json

Body

voucher_use_detail_result_info

object (VoucherUseDetailResultInfo)

可选

voucher_max_un_use_times

integer

剩余可核销次数

可选

activity_id

string

优惠券活动id

可选

示例值:

2016042700826004508401111111

同步券核销状态

请求参数

返回响应