# 团购优惠券枚举值定义
# Voucher
| 参数 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| code | string | 必填 | 券code，平台生成的code是数字加字母的组合，最长32位，商家自定义code不超过48位，也是数字加字母的组合 |
| status | number | 必填 | 券状态，详细见VoucherStatus |
| send_time | number | 必填 | 发放时间，时间戳 |
| update_time | number | 必填 | 最近更新时间，时间戳 |
| start_time | number | 必填 | 核销生效时间，时间戳 |
| end_time | number | 必填 | 核销结束时间，时间戳 |
| consume_time | number | 选填 | 核销时间，时间戳。次卡时不返回此字段 |
| refund_time | number | 选填 | 退券时间，时间戳。次卡时不返回此字段 |
| product_id | string | 必填 | 通过本地生活api创建的商品id |
| consume_store_name | string | 选填 | 如果券是已核销状态，会返回核销的门店名称（商户在核销券接口传入后才会返回）。次卡时不返回此字段 |
| voucher_type | number | 必填 | 券类型，详细见VoucherType |
| voucher_buy_amount | number | 选填 | 券的售卖价格（分），如果有平台补贴，即为用户实际支付金额加上平台补贴金额 |
| voucher_actual_amount | number | 选填 | 券市场金额（分）,券对应的价值金额 |
| telphone_no | string | 选填 | 用户手机号，仅在商品创建时勾选了需要用户手机号才返回 |
| openid | string | 必填 | 用户在商家品牌appid下的openid |
| code_type | number | 必填 | 参考 VoucherCodeType |
| order_id | string | 选填 | 购买券的订单id |
| sku_id | string | 必填 | 商品下的skuid |
| voucher_settle_status | number | 选填 | status为VOUCHER_STATUS_USED才返回，枚举见VoucherSettleStatus。次卡时不返回此字段 |
| union_id | string | 必填 | 用户在微信开放平台下的unionid |
| out_store_id | string | 选填 | 核销接口传入out_store_id。次卡时不返回此字段 |
| last_consume_no | string | 选填 | 券最后一次成功发起核销的核销单号，从未发起过核销的券不返回。 |
| last_withdraw_consume_no | string | 选填 | 券最后一次成功发起撤销核销的撤销核销单号，从未发起过撤销核销的券不返回。 |
| time_card | VoucherTimeCard | 选填 | 仅voucher_type为VOUCHER_TYPE_MULTIPLE_PRODUCT_EXCHANGE次卡时返回 |
# RevokeVoucher
| 参数 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| encrypted_code | string | 选填 | 券加密code，和券code二选一 |
| code | string | 选填 | 券code，和券加密code二选一 |
| sku_id | string | 选填 | 商品下的skuid,填写code时必填 |
| cancel_count | number | 选填 | 已废弃 |
# VoucherBill
| 参数 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| voucher_name | string | 必填 | 商品名称 |
| product_id | string | 必填 | 通过本地生活api创建的商品id |
| code | string | 必填 | 券code |
| order_id | string | 必填 | 购买券的订单ID |
| openid | string | 必填 | 用户在商家品牌appid下的openid |
| voucher_buy_time | number | 必填 | 购买时间 |
| voucher_buy_amount | number | 必填 | 券售卖金额(分)。次卡时为单次金额 |
| voucher_pay_amount | number | 必填 | 用户支付金额(分) 。次卡时为单次金额 |
| mch_favor_amount | number | 必填 | 视频号小店商家优惠减价金额(分)。次卡时为单次金额 |
| platform_favor_amount | number | 必填 | 视频号小店平台优惠减价金额(分)。次卡时为单次金额 |
| consume_time | number | 必填 | 核销时间，时间戳 |
| consume_store_name | string | 必填 | 核销的门店名称（商户在核销券接口传入后才会返回） |
| mch_settle_amount | number | 必填 | 给商家的已结算金额(分)。次卡时为单次金额。 |
| finder_settle_amount | number | 必填 | 给达人的结算金额(分)。次卡时为单次金额 |
| out_store_id | string | 选填 | 核销接口传入out_store_id |
| time_index | number | 必填 | 次序号标识2024年2月底次卡上线后返回 |
# OperateFailVoucher
| 参数 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| code | string | 选填 | 操作的券code，核销时传code时或者传了有效的加密code时返回 |
| sku_id | string | 选填 | 操作的券sku_id，核销时传code时或者传了有效的加密code时返回 |
| encrypted_code | string | 选填 | 核销时传的加密code非法返回 |
| ret_code | string | 必填 | 操作结果 |
| ret_msg | string | 选填 | 操作结果说明 |
# VoucherSerial
次卡各次序号详情，2月底上线
| 参数 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| index | number | 必填 | 次序号 |
| status | number | 必填 | 次序号状态，详细见VoucherStatus |
| buy_amount | number | 必填 | 次卡单次售卖价格(分) |
| actual_amount | number | 必填 | 次卡单次原价(分) |
| consume_time | number | 选填 | 指定次序号最后一次核销时间，时间戳 |
| refund_time | number | 选填 | 指定次序号退券时间，时间戳 |
| voucher_settle_status | number | 选填 | status为VOUCHER_STATUS_USED才返回，枚举见VoucherSettleStatus |
| consume_store_name | string | 选填 | 如果次序号是已核销状态，会返回核销的门店名称（商户在核销券接口传入后才会返回） |
| out_store_id | string | 选填 | 核销接口传入out_store_id |
| last_consume_no | string | 选填 | 次序号最后一次成功发起核销的核销单号，从未发起过核销的次序号不返回 |
| last_withdraw_consume_no | string | 选填 | 次序号最后一次成功发起撤销核销的撤销核销单号，从未发起过撤销核销的次序号不返回 |
# VoucherTimeCard
| 参数 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| serials | array<VoucherSerial > | 必填 | 次序号列表 |
| total_count | number | 必填 | 次卡可用总次数 |
| available_count | number | 必填 | 剩余可用次数 |
| consumed_count | number | 必填 | 已核销次数 |
| refunded_count | number | 必填 | 已退券次数 |