P10-卡券实例详情
<p><strong>简要描述：</strong> </p>
<ul>
<li>卡券实例详情查询</li>
</ul>
<p><strong>请求URL：</strong> </p>
<ul>
<li>环境地址: <code>https://kylinapi.aupres.com.cn/openapi/v2/offer/instance/detail</code></li>
</ul>
<p><strong>请求方式：</strong></p>
<ul>
<li>GET </li>
</ul>
<p><strong>Body 参数：</strong> </p>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">必选</th>
<th style="text-align: left;">说明</th>
<th>类型</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">channelType</td>
<td style="text-align: left;">Y</td>
<td style="text-align: left;">渠道类型 POS</td>
<td>string</td>
</tr>
<tr>
<td style="text-align: left;">instanceId</td>
<td style="text-align: left;">Y</td>
<td style="text-align: left;">卡券实例ID</td>
<td>string</td>
</tr>
<tr>
<td style="text-align: left;">memberType</td>
<td style="text-align: left;">Y</td>
<td style="text-align: left;">会员类型 传固定值aupres</td>
<td>string</td>
</tr>
<tr>
<td style="text-align: left;">projectId</td>
<td style="text-align: left;">Y</td>
<td style="text-align: left;">卡券项目ID</td>
<td>string</td>
</tr>
<tr>
<td style="text-align: left;">ruleAnalyze</td>
<td style="text-align: left;">Y</td>
<td style="text-align: left;">是否解析门店/商品规则</td>
<td>boolean</td>
</tr>
</tbody>
</table>
<p><strong>响应参数：</strong> </p>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">必选</th>
<th style="text-align: left;">说明</th>
<th>类型</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">effectText</td>
<td style="text-align: left;">N</td>
<td style="text-align: left;">效果描述，代金券为具体代金金额，折扣券为具体的折扣</td>
<td>string</td>
</tr>
<tr>
<td style="text-align: left;">expireTime</td>
<td style="text-align: left;">N</td>
<td style="text-align: left;">实例过期时间 yyyy-MM-dd’T’HH:mm:ss.SSSXXX</td>
<td>string</td>
</tr>
<tr>
<td style="text-align: left;">grantTime</td>
<td style="text-align: left;">N</td>
<td style="text-align: left;">发放时间 yyyy-MM-dd’T’HH:mm:ss.SSSXXX</td>
<td>string</td>
</tr>
<tr>
<td style="text-align: left;">instanceId</td>
<td style="text-align: left;">N</td>
<td style="text-align: left;">卡券实例ID</td>
<td>string</td>
</tr>
<tr>
<td style="text-align: left;">memberId</td>
<td style="text-align: left;">Y</td>
<td style="text-align: left;">会员id</td>
<td>string</td>
</tr>
<tr>
<td style="text-align: left;">projectId</td>
<td style="text-align: left;">Y</td>
<td style="text-align: left;">卡券项目Id</td>
<td>string</td>
</tr>
<tr>
<td style="text-align: left;">projectName</td>
<td style="text-align: left;">Y</td>
<td style="text-align: left;">卡券项目名称</td>
<td>string</td>
</tr>
<tr>
<td style="text-align: left;">projectStatus</td>
<td style="text-align: left;">Y</td>
<td style="text-align: left;">卡券项目状态，已生效:VALID, 已结束:HAS_FINISHED</td>
<td>string</td>
</tr>
<tr>
<td style="text-align: left;">ruleText</td>
<td style="text-align: left;">N</td>
<td style="text-align: left;">使用规则/使用说明</td>
<td>string</td>
</tr>
<tr>
<td style="text-align: left;">selectorRule</td>
<td style="text-align: left;">N</td>
<td style="text-align: left;">选择器规则</td>
<td>object</td>
</tr>
<tr>
<td style="text-align: left;">status</td>
<td style="text-align: left;">Y</td>
<td style="text-align: left;">券实例状态 GRANTED 未生效 VALID 已生效 USED 已使用 EXPIRED 已失效</td>
<td>string</td>
</tr>
<tr>
<td style="text-align: left;">useTime</td>
<td style="text-align: left;">N</td>
<td style="text-align: left;">核销时间 yyyy-MM-dd’T’HH:mm:ss.SSSXXX</td>
<td>string</td>
</tr>
<tr>
<td style="text-align: left;">validTime</td>
<td style="text-align: left;">N</td>
<td style="text-align: left;">实例生效时间 yyyy-MM-dd’T’HH:mm:ss.SSSXXX</td>
<td>string</td>
</tr>
<tr>
<td style="text-align: left;">customizedProperties</td>
<td style="text-align: left;">N</td>
<td style="text-align: left;">扩展属性</td>
<td>map</td>
</tr>
<tr>
<td style="text-align: left;">selectorRule</td>
<td style="text-align: left;">N</td>
<td style="text-align: left;">扩展字段</td>
<td>map</td>
</tr>
<tr>
<td style="text-align: left;">presetOrCustomField</td>
<td style="text-align: left;">N</td>
<td style="text-align: left;">扩展字段</td>
<td>map</td>
</tr>
</tbody>
</table>
<p><strong>customizedProperties：</strong> </p>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">必选</th>
<th style="text-align: left;">说明</th>
<th>类型</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">validyType</td>
<td style="text-align: left;">N</td>
<td style="text-align: left;">有效期类型(RELATIVE：相对时间 ABSOLUTE：绝对时间)</td>
<td>String</td>
</tr>
<tr>
<td style="text-align: left;">usemeetAmount</td>
<td style="text-align: left;">N</td>
<td style="text-align: left;">使用门槛金额</td>
<td>String</td>
</tr>
<tr>
<td style="text-align: left;">configuredCashEffect</td>
<td style="text-align: left;">N</td>
<td style="text-align: left;">满返金额</td>
<td>String</td>
</tr>
<tr>
<td style="text-align: left;">meetAmount</td>
<td style="text-align: left;">N</td>
<td style="text-align: left;">满返门槛金额</td>
<td>String</td>
</tr>
<tr>
<td style="text-align: left;">codeVersion</td>
<td style="text-align: left;">N</td>
<td style="text-align: left;">券码库编号</td>
<td>String</td>
</tr>
<tr>
<td style="text-align: left;">instanceCountLimit</td>
<td style="text-align: left;">N</td>
<td style="text-align: left;">发放总量</td>
<td>String</td>
</tr>
<tr>
<td style="text-align: left;">configuredEffectDays</td>
<td style="text-align: left;">N</td>
<td style="text-align: left;">有效天数</td>
<td>String</td>
</tr>
<tr>
<td style="text-align: left;">validyType</td>
<td style="text-align: left;">N</td>
<td style="text-align: left;">有效期类型(absolutely:绝对时间 , relative:相对时间，monthly：月底)</td>
<td>String</td>
</tr>
<tr>
<td style="text-align: left;">configuredEffectMonths</td>
<td style="text-align: left;">N</td>
<td style="text-align: left;">有效月数</td>
<td>String</td>
</tr>
<tr>
<td style="text-align: left;">configuredExpiredTime</td>
<td style="text-align: left;">N</td>
<td style="text-align: left;">失效时间（ yyyy-MM-ddTHH:mm:ss.SSSXXX）</td>
<td>String</td>
</tr>
<tr>
<td style="text-align: left;">configuredEffectDays</td>
<td style="text-align: left;">N</td>
<td style="text-align: left;">有效天数</td>
<td>String</td>
</tr>
<tr>
<td style="text-align: left;">ruleDescription</td>
<td style="text-align: left;">N</td>
<td style="text-align: left;">规则文案</td>
<td>String</td>
</tr>
<tr>
<td style="text-align: left;">singlePersonInstanceCountLimit</td>
<td style="text-align: left;">N</td>
<td style="text-align: left;">发放次数限制</td>
<td>String</td>
</tr>
<tr>
<td style="text-align: left;">configuredApplyEffectTypeZ</td>
<td style="text-align: left;">N</td>
<td style="text-align: left;">使用效果类型（自定义）DISCOUNT:特惠品代金券，DEDUCT：满返礼券，GIFT：新会员欢迎礼券，CASH：小面值代金券。DUIHUAN：积分兑换代金券。PAIFA：派发代金券</td>
<td>String</td>
</tr>
<tr>
<td style="text-align: left;">giftType</td>
<td style="text-align: left;">N</td>
<td style="text-align: left;">礼品券类型 (xiehou：到店邂逅礼-潜转新 xiehoulzx：到店邂逅礼-流转新 lilin：会员莅临礼—普通会员 lilingold：会员莅临礼—黄金会员 lilindia：会员莅临礼—钻石会员 xinren：新人专宠礼 huigou：回购感谢礼 gold：黄金晋级礼 dia：钻石晋级礼 diajidu：钻石季度礼 birthday：臻享生日礼—普通会员 birgold：臻享生日礼—黄金会员 birdia：臻享生日礼—钻石会员）</td>
<td>String</td>
</tr>
<tr>
<td style="text-align: left;">isOrdernumber</td>
<td style="text-align: left;">N</td>
<td style="text-align: left;">订单次数限制(FIRST:首购 SECOND：二购 THIRD：三购 NULL：无限制)</td>
<td>String</td>
</tr>
<tr>
<td style="text-align: left;">associatedStore</td>
<td style="text-align: left;">N</td>
<td style="text-align: left;">是否关系店可核销（FALSE 否 TURE 是）</td>
<td>String</td>
</tr>
<tr>
<td style="text-align: left;">suitCommodityType</td>
<td style="text-align: left;">N</td>
<td style="text-align: left;">商品限制类型（appoint：适用 unlimit：不限 exclude：排除）</td>
<td>String</td>
</tr>
<tr>
<td style="text-align: left;">meetLevel</td>
<td style="text-align: left;">N</td>
<td style="text-align: left;">使用会员等级限制（GOLD : 黄金会员 DIA : 钻石会员 NULL : 不限制 GOLDDIA : 黄金或钻石会员）</td>
<td>String</td>
</tr>
<tr>
<td style="text-align: left;">suitshopType</td>
<td style="text-align: left;">N</td>
<td style="text-align: left;">门店限制类型（appiont：适用 unlimit：不限 exclude：排除)</td>
<td>String</td>
</tr>
<tr>
<td style="text-align: left;">isGiftshare</td>
<td style="text-align: left;">N</td>
<td style="text-align: left;">是否与买赠礼共享（TRUE：共享 FALSE：不共享)</td>
<td>String</td>
</tr>
<tr>
<td style="text-align: left;">salesProportion</td>
<td style="text-align: left;">N</td>
<td style="text-align: left;">代金券面额最多占销售额比例</td>
<td>String</td>
</tr>
<tr>
<td style="text-align: left;">isBuystore</td>
<td style="text-align: left;">N</td>
<td style="text-align: left;">是否购买店核销(TRUE：是,FALSE：否)</td>
<td>String</td>
</tr>
</tbody>
</table>
<p><strong>selectorRule：</strong></p>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">必选</th>
<th style="text-align: left;">说明</th>
<th>类型</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">suitshopCode</td>
<td style="text-align: left;">N</td>
<td style="text-align: left;">指定活动门店</td>
<td>Enum</td>
</tr>
<tr>
<td style="text-align: left;">unsuitshopCode</td>
<td style="text-align: left;">N</td>
<td style="text-align: left;">排除门店</td>
<td>Enum</td>
</tr>
<tr>
<td style="text-align: left;">suitCommodity</td>
<td style="text-align: left;">N</td>
<td style="text-align: left;">指定商品</td>
<td>Enum</td>
</tr>
<tr>
<td style="text-align: left;">unsuitCommodity</td>
<td style="text-align: left;">N</td>
<td style="text-align: left;">排除商品</td>
<td>Enum</td>
</tr>
</tbody>
</table>
<p><strong>presetOrCustomField：</strong></p>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">必选</th>
<th style="text-align: left;">说明</th>
<th>类型</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">discountAmount</td>
<td style="text-align: left;">N</td>
<td style="text-align: left;">优惠动态金额</td>
<td>String</td>
</tr>
</tbody>
</table>
<p><strong>返回参数说明</strong> </p>
<table>
<thead>
<tr>
<th style="text-align: left;">HTTP Code</th>
<th style="text-align: left;">Description</th>
<th>Schema</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">200</td>
<td style="text-align: left;">查询卡券实例明细信息</td>
<td>卡券实例明细返回</td>
</tr>
<tr>
<td style="text-align: left;">401</td>
<td style="text-align: left;">Unauthorized</td>
<td>No Content</td>
</tr>
<tr>
<td style="text-align: left;">403</td>
<td style="text-align: left;">Forbidden</td>
<td>No Content</td>
</tr>
<tr>
<td style="text-align: left;">404</td>
<td style="text-align: left;">Not Found</td>
<td>No Content</td>
</tr>
</tbody>
</table>
<p><strong>返回结果示例</strong></p>
<pre><code>{
"instanceId": "10001",
"status": "USED",
"memberId": "1fcda1f9eb0f44dca5371f64da199420",
"projectId": "50018",
"couponCode": "23PF7QU3",
"projectName": "欧珀莱测试券",
"validTime": "2021-11-24T18:16:18.579+08:00",
"effectText": "200",
"ruleText": "测试券",
"grantTime": "2021-11-24T17:48:17.237+08:00",
"useTime": "2021-11-25T13:43:54.343+08:00",
"selectorRule": {
"suitshopCode": [
"00100002",
"00100004",
"00100008",
"00100009",
"00100010",
"00100011"
],
"suitCommodity": [
"04722",
"04723",
"04724",
"04727",
"04729",
"04730",
"04732",
"04751",
"04752"
]
},
"customizedProperties": {
"isGiftshare": "FALSE",
"usemeetAmount": "400",
"configuredCashEffect": "200",
"meetAmount": "1000",
"codeVersion": "RNLC_8",
"instanceCountLimit": "100",
"configuredEffectDays": "30",
"associatedStore": "TURE",
"meetLevel": "GOLD",
"suitCommodityType": "appoint",
"validyType": "relative",
"ruleDescription": "测试券",
"singlePersonInstanceCountLimit": "1"
}
}</code></pre>