本地生活商品
商户调用该接口，通过扫码或输码进行核销准备，获取支付宝平台加密券码信息
注意：
1、该接口只返回未使用状态的凭证券码。
2、支付宝平台码需要先调用核销准备接口获取加密券码，再调用核销接口；三方码直接调用核销接口。
2、支付宝平台码需要先调用核销准备接口获取加密券码，再调用核销接口；三方码直接调用核销接口。
公共请求参数
业务请求参数
以下参数 二选一 传入必选
encrypted_data｜加密数据string[0,128]
【描述】根据用户出示的核销二维码解析出来的标识
【注意事项】encrypted_data/code必须二选一
【示例值】jrtfsqw5wk1c4bmxvbnnwduq2wk8
code｜券码string[0,12]
【描述】用户出示的核销二维码下方的12位券码
【注意事项】encrypted_data/code必须二选一
【示例值】00000000000
cross_order｜是否开启跨单核销可选boolean
【描述】是否启用跨单核销。 该值默认为false
用户多次下单购买相同商品，当cross_order为true时，传入任一订单二维码信息可以获取用户多次购买该商品的所有有效券码信息。
用户多次下单购买相同商品，当cross_order为true时，传入任一订单二维码信息可以获取用户多次购买该商品的所有有效券码信息。
【示例值】false
常见请求示例
通过原始券码获取加密券码
通过二维码解析标识获取加密券码
默认示例
curl 'https://openapi.alipay.com/gateway.do?charset=utf-8&method=alipay.marketing.certificate.certification.prepareuse&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=rsa2×tamp=${now}' \
-f 'biz_content={
"code":"00000000000"
}' 说明：本示例仅供参考。
公共响应参数
业务响应参数
order_id｜订单id必选string(128)
【描述】购买商品的订单id，核销接口使用
【示例值】2021042322001426261436764012
certificate_prepare_info_list｜凭证信息必选certificateprepareinfo[]
【描述】凭证信息列表
certificate_id｜凭证id必选string(32)
【描述】凭证id
【示例值】2021042322001426261436764012
encrypted_code｜加密券码必选string(128)
【描述】加密券码，核销接口使用
【示例值】q2wk85y1n0ehprufpmmmzwntdfm2nkewlfn
order_id｜购买商品的订单id必选string(64)
【描述】购买商品的订单id
【示例值】1997081101502300000001290055702988
valid_begin_time｜券的有效期开始时间必选date(19)
【描述】券的有效期开始时间
【示例值】2023-05-15 10:00:00
valid_end_time｜券的有效期结束时间必选date(19)
【描述】券的有效期结束时间
【示例值】2023-06-21 10:00:00
sku_info｜商品信息可选certificateskuinfo
【描述】商品信息
【注意事项】商品下单购买时该值必传
sku_id｜支付宝平台侧skuid可选string(128)
【描述】支付宝平台侧商品sku的唯一标识，后续与平台交互，需要使用该 id，建议持久化。
【示例值】2018091300502200001600103072
out_sku_id｜商家侧skuid可选string(128)
【描述】商家侧sku id，appid 下全局唯一。
【示例值】2018091300502200001600103072
item_id｜支付宝平台侧商品id可选string(128)
【描述】支付宝平台侧商品id，是支付宝平台侧商品的唯一标识，后续与平台交互，需要使用该 id，建议持久化。
【示例值】2018091300502200004400104166
out_item_id｜商家侧商品id可选string(128)
【描述】商家侧商品id，要求 appid 下全局唯一。
【示例值】2018091300502200004400104166
title｜商品名称可选string(128)
【描述】商品名称。 商品名称，字符类型，最少不低于3，最长不超过60个字。注：1.商品名称只允许汉字、数字、英文字母、特殊字符集；2.商品名称不得仅为数字、字母、特殊字符集或上述三种的组合。
【示例值】测试商品名称
item_type｜商品模版类型可选string(2)
【描述】商品模版类型：
1. 团购套餐
2. 代金券
此字段与使用alipay.open.app.localitem.create接口创建本地生活商品时传入的item_type字段值保持一致。
1. 团购套餐
2. 代金券
此字段与使用alipay.open.app.localitem.create接口创建本地生活商品时传入的item_type字段值保持一致。
【枚举值】
团购套餐: 1
代金券: 2
【示例值】1
amount_info｜凭证金额信息可选certificateinstanceamountinfo
【描述】凭证实例的金额信息，在异常场景下可能为空，需要判断是否有值才可进行使用。
【注意事项】在网络异常的场景下此字段可能为空，商家需要保证对此字段非强诉求。
original_price｜商品原价可选price(10)
【描述】商品标注的原价，单位为元。
【注意事项】异常情况下可能为空，需要判断是否有值才可使用。
【示例值】10.00
sale_price｜商品售价可选price(10)
【描述】商品售卖的价格，单位为元。
【注意事项】异常情况下可能为空，需要判断是否有值才可使用。
【示例值】5.00
pay_amount｜用户实付金额可选price(10)
【描述】用户实付金额，单位为元
【示例值】20.00
receipt_amount｜商家实收金额可选price(10)
【描述】商品售价去除商家订单优惠后的商家实收，未计算收单费率等，单位为元。
【注意事项】异常情况下可能为空，需要判断是否有值才可使用。
【示例值】4.00
merchant_discount_amount｜商家优惠金额可选price(10)
【描述】核销后商家减收部分，单位为元
【示例值】20.00
platform_discount_amount｜支付宝优惠金额可选price(10)
【描述】核销生效后平台、商家等出资的优惠部分，单位为元
【示例值】1.00
times_card_info｜次卡详情可选certificatetimescardinfo
【描述】商品类型为次卡时该值必填
total_count｜次卡总次数必选number(32)
【描述】次卡总次数
【示例值】10
used_count｜已使用次数必选number(32)
【描述】已使用次数
【示例值】0
serial_info_list｜次卡次序号信息必选certificateserialinfo[]
【描述】次卡次序号信息
serial_no｜次序号必选string(32)
【描述】次序号
【示例值】11111
status｜次序号状态必选string(32)
【描述】次序号状态
【示例值】used
amount_info｜次序号的金额信息必选certificateinstanceamountinfo
【描述】次序号的金额信息
original_price｜商品原价可选price(10)
【描述】商品标注的原价，单位为元。
【注意事项】异常情况下可能为空，需要判断是否有值才可使用。
【示例值】10.00
sale_price｜商品售价可选price(10)
【描述】商品售卖的价格，单位为元。
【注意事项】异常情况下可能为空，需要判断是否有值才可使用。
【示例值】5.00
pay_amount｜用户实付金额可选price(10)
【描述】用户实付金额，单位为元
【示例值】20.00
receipt_amount｜商家实收金额可选price(10)
【描述】商品售价去除商家订单优惠后的商家实收，未计算收单费率等，单位为元。
【注意事项】异常情况下可能为空，需要判断是否有值才可使用。
【示例值】4.00
merchant_discount_amount｜商家优惠金额可选price(10)
【描述】核销后商家减收部分，单位为元
【示例值】20.00
platform_discount_amount｜支付宝优惠金额可选price(10)
【描述】核销生效后平台、商家等出资的优惠部分，单位为元
【示例值】1.00
user_id｜支付宝用户id特殊可选string(32)
【描述】凭证归属支付宝用户id，核销接口使用
新商户建议使用open_id替代该字段。对于新商户，user_id字段未来计划逐步回收，存量商户可继续使用。如使用open_id，请确认 应用-开发配置-openid配置管理 已启用。无该配置项，可查看openid配置申请。
【示例值】2088xxxxx
open_id｜凭证归属支付宝用户openid特殊可选string(128)
【描述】凭证归属支付宝用户openid 详情可查看 openid简介
【示例值】074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5
响应示例
正常示例
异常示例
{
"alipay_marketing_certificate_certification_prepareuse_response": {
"code": "10000",
"msg": "success",
"user_id": "2088xxxxx",
"open_id": "074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5",
"order_id": "2021042322001426261436764012",
"certificate_prepare_info_list": [
{
"certificate_id": "2021042322001426261436764012",
"encrypted_code": "q2wk85y1n0ehprufpmmmzwntdfm2nkewlfn",
"order_id": "1997081101502300000001290055702988",
"valid_begin_time": "2023-05-15 10:00:00",
"valid_end_time": "2023-06-21 10:00:00",
"sku_info": {
"sku_id": "2018091300502200001600103072",
"out_sku_id": "2018091300502200001600103072",
"item_id": "2018091300502200004400104166",
"out_item_id": "2018091300502200004400104166",
"title": "测试商品名称",
"item_type": "1"
},
"amount_info": {
"original_price": "10.00",
"sale_price": "5.00",
"pay_amount": "20.00",
"receipt_amount": "4.00",
"merchant_discount_amount": "20.00",
"platform_discount_amount": "1.00"
},
"times_card_info": {
"total_count": 10,
"used_count": 0,
"serial_info_list": [
{
"serial_no": "11111",
"status": "used",
"amount_info": {
"original_price": "10.00",
"sale_price": "5.00",
"pay_amount": "20.00",
"receipt_amount": "4.00",
"merchant_discount_amount": "20.00",
"platform_discount_amount": "1.00"
}
}
]
}
}
]
},
"sign": "eritjkeijkjhkkkkkkkhjereeeeeeeeeee"
}说明：本示例仅供参考。
公共错误码
业务错误码
| 错误码 | 错误描述 | 凯发app官方网站的解决方案 |
|---|---|---|
| system_error | 系统繁忙 | 可能发生了网络或者系统异常，导致服务调用失败，商户可以用同样的请求发起重试 |
| invalid_parameter | 参数有误 | 请根据接口返回的参数非法的具体错误信息，修改参数后进行重试。 |
| certificate_merchant_not_permission | 凭证不归属于该商户 | 凭证与该商户没有归属关系,不能进行操作 |
| time_out_exception | 调用超时 | 调用超时，请求可能成功也可能失败，请以相同的请求发起重试 |