查询用户券详情

 description 　选填   string(1000)

【使用须知】用于说明详细的活动规则，会展示在代金券详情页。

 merchant_logo_url 　选填   string

【商户logo】若券归属商户号有认证品牌，则系统将自动拉取对应品牌logo；若券归属商户号不在认证品牌下，需自定义上传logo，未上传时将展示兜底灰色logo样式，影响券详情页用户体验，请及时上传。

商户logo的URL地址，仅支持通过《图片上传API》接口获取的图片URL地址。

1、商户logo大小需为120像素*120像素。

2、支持JPG/JPEG/PNG格式，且图片小于1M。

注：该字段暂不支持修改

 merchant_name 　选填   string(16)

【商户名称】不支持商户自定义。若券归属商户号有认证品牌，系统将自动拉取认证品牌号下的品牌名称；若券归属商户号不在认证品牌下，则拉取本商户号的商户简称。展示上限12个字符。
注：该字段暂不支持修改

 background_color 　选填   string

【背景颜色】券的背景颜色，可设置10种颜色，色值请参考下方说明。颜色取值为颜色图中的颜色名称。

 coupon_image_url 　选填   string

【券详情图片】券详情图片，1074像素（宽）*603像素（高），图片大小不超过2M，支持JPG/PNG格式。仅支持通过《图片上传API》接口获取的图片URL地址。*

 finder_info 　选填   object

【视频号相关信息】视频号相关信息

 finder_id 　选填   string

【视频号ID】关联视频号将展示在优惠券详情的顶部右侧，作为跳转去视频号的入口，入参参数请配置视频号id，请前往视频号助手管理查看视频号ID

 finder_video_id 　选填   string

【视频号视频ID】券详情视频内容，支持配置关联视频号下的具体视频内容，入参参数请配置视频id，请前往视频号助手管理后台复制具体视频ID

 finder_video_cover_image_url 　选填   string

【视频号封面图】截取的视频号图片将在券到期提醒消息、券详情中展示。

1.图片尺寸：716像素（宽）*402像素（高）；图片大小不超过2M，支持JPG/PNG格式。

2.仅支持通过《图片上传API》接口获取的图片URL地址。

 coupon_available_time 　必填   object

【券可核销时间】日期区间内可以使用优惠

 available_begin_time 　必填   string

【开始时间】批次开始时间，遵循rfc3339标准格式，格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE，yyyy-MM-DD表示年月日，T出现在字符串中，表示time元素的开头，HH:mm:ss表示时分秒，TIMEZONE表示时区（+08:00表示东八区时间，领先UTC 8小时，即北京时间）。例如：2015-05-20T13:29:35+08:00表示，北京时间2015年5月20日 13点29分35秒。
注意：商家券有效期最长为1年。

 available_end_time 　必填   string

【结束时间】批次结束时间，遵循rfc3339标准格式，格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE，yyyy-MM-DD表示年月日，T出现在字符串中，表示time元素的开头，HH:mm:ss表示时分秒，TIMEZONE表示时区（+08:00表示东八区时间，领先UTC 8小时，即北京时间）。例如：2015-05-20T13:29:35+08:00表示，北京时间2015年5月20日 13点29分35秒。
注意：商家券有效期最长为1年。

 available_day_after_receive 　选填   integer

【生效后N天内有效】日期区间内，券生效后x天内有效。例如生效当天内有效填1，生效后2天内有效填2，以此类推……注意，用户在有效期开始前领取商家券，则从有效期第1天开始计算天数，用户在有效期内领取商家券，则从领取当天开始计算天数，无论用户何时领取商家券，商家券在活动有效期结束后均不可用。可配合wait_days_after_receive一同填写，也可单独填写。单独填写时，有效期内领券后立即生效，生效后x天内有效。

 available_week 　选填   object

【固定周期有效时间段】可以设置多个星期下的多个可用时间段，比如每周二10点到18点

 week_day 　选填   array[integer]

【可用星期数】0代表周日，1代表周一，以此类推 当填写available_day_time时，week_day必填

 available_day_time 　选填   array[object]

【当天可用时间段】可以填写多个时间段，最多不超过2个

 begin_time 　选填   integer

【当天可用开始时间】当天可用开始时间 单位秒 1代表当天0点0分1秒

 end_time 　选填   integer

【当天可用结束时间】当天可用结束时间 单位秒 86399代表当天23点59分59秒

 irregulary_avaliable_time 　选填   array[object]

【无规律的有效时间段】无规律的有效时间，多个无规律时间段

 begin_time 　选填   string

【开始时间】开始时间，遵循rfc3339标准格式，格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE，yyyy-MM-DD表示年月日，T出现在字符串中，表示time元素的开头，HH:mm:ss表示时分秒，TIMEZONE表示时区（+08:00表示东八区时间，领先UTC 8小时，即北京时间）。例如：2015-05-20T13:29:35+08:00表示，北京时间2015年5月20日 13点29分35秒。

 end_time 　选填   string

【结束时间】结束时间，遵循rfc3339标准格式，格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE，yyyy-MM-DD表示年月日，T出现在字符串中，表示time元素的开头，HH:mm:ss表示时分秒，TIMEZONE表示时区（+08:00表示东八区时间，领先UTC 8小时，即北京时间）。例如：2015-05-20T13:29:35+08:00表示，北京时间2015年5月20日 13点29分35秒。

 wait_days_after_receive 　选填   integer

【领取后N天开始生效】日期区间内，用户领券后需等待x天开始生效。例如领券后当天开始生效则无需填写，领券后第2天开始生效填1，以此类推……用户在有效期开始前领取商家券，则从有效期第1天开始计算天数，用户在有效期内领取商家券，则从领取当天开始计算天数。无论用户何时领取商家券，商家券在活动有效期结束后均不可用。需配合available_day_after_receive一同填写，不可单独填写。注：最大不能超过30天

 fixed_normal_coupon 　选填   object

【固定面额满减券使用规则】固定面额满减，折扣券，换购券使用规则三选一，stock_type为NORMAL时必填。

 discount_amount 　选填   integer

【优惠金额】优惠金额 单位分。
特殊规则：取值范围 1 ≤ value ≤ 10000000

 transaction_minimum 　选填   integer

【消费门槛】消费门槛，单位：分。
特殊规则：取值范围 1 ≤ value ≤ 10000000

 discount_coupon 　选填   object

【折扣券使用规则】固定面额满减，折扣券，换购券使用规则三选一，stock_type为DISCOUNT时必填。

 discount_percent 　选填   integer

【折扣比例】折扣百分比，88为88折

 transaction_minimum 　选填   integer

【消费门槛】消费门槛，单位：分。
特殊规则：取值范围 1 ≤ value ≤ 10000000

 exchange_coupon 　选填   object

【换购券使用规则】固定面额满减，折扣券，换购券使用规则三选一，stock_type为EXCHANGE时必填。

 exchange_price 　选填   integer

【单品换购价】单品换购价，单位：分。
特殊规则：取值范围 0 ≤ value ≤ 10000000

 transaction_minimum 　选填   integer

【消费门槛】消费门槛，单位：分。
特殊规则：取值范围 1 ≤ value ≤ 10000000

 use_method 　必填   string

【核销方式】核销方式

可选取值：：

• OFF_LINE: 线下滴码核销，点击券“立即使用”跳转展示券二维码详情。

• MINI_PROGRAMS: 线上小程序核销，点击券“立即使用”跳转至配置的商家小程序（需要添加小程序AppID和path）。

• SELF_CONSUME: 用户自助核销，点击券“立即使用”跳转至用户自助操作核销界面（当前暂不支持用户自助核销）。

• PAYMENT_CODE: 微信支付付款码核销，点击券“立即使用”跳转至微信支付钱包付款码。

 mini_programs_appid 　选填   string

【小程序AppID】核销方式为线上小程序核销才有效

 mini_programs_path 　选填   string

【小程序path】核销方式为线上小程序核销才有效

 mini_programs_info 　选填   object

【小程序入口】需要小程序APPID、path、入口文案、引导文案。如果需要跳转小程序，APPID、path、入口文案为必填，引导文案非必填。
AppID要与归属商户号有M-A or M-m-suba关系。
注：请查看绑定关系说明文档

 mini_programs_appid 　必填   string

【商家小程序AppID】商家小程序AppID要与归属商户号有M-A or M-m-suba关系。
校验规则：传入的AppID得是与调用方商户号（即请求头里面的商户号）有绑定关系的AppID 或 传入的AppID得是归属商户号有绑定关系的AppID

 mini_programs_path 　必填   string

【商家小程序path】商家小程序path

 entrance_words 　必填   string(5)

【入口文案】入口文案，字数上限为5个，一个中文汉字/英文字母/数字均占用一个字数。

 guiding_words 　选填   string(6)

【引导文案】小程序入口引导文案，用户自定义字段。字数上限为6个，一个中文汉字/英文字母/数字均占用一个字数。

 appid 　选填   string

【商户公众号AppID】可配置商户公众号，从券详情可跳转至公众号，用户自定义字段。
校验规则：传入的AppID得是与调用方商户号（即请求头里面的商户号）有绑定关系的AppID 或 传入的AppID得是归属商户号有绑定关系的AppID

 hall_id 　选填   string

【更多优惠入口；营销馆创建地址：https://pay.weixin.qq.com/index.php/xphp/cfav_market/hall#/pages/list/list】 填写微信支付营销馆的馆ID，用户自定义字段。营销馆需在商户平台创建。

 store_id 　选填   string

【可用门店ID】填写代金券可用门店ID

 code_display_mode 　选填   string

【code展示模式】code展示模式

可选取值：：

• NOT_SHOW: 不展示code

• BARCODE: 一维码

• QRCODE: 二维码