麒麟云服开放平台

麒麟云服开放平台接口


优惠券配置查询

<h3>接口功能</h3> <p>优惠券配置信息查询。</p> <h3>请求URL</h3> <ul> <li><code>api/kycloud/open/v1.0/coupon/alipay/config/query</code></li> </ul> <h3>请求方式</h3> <ul> <li>POST</li> </ul> <h3>公共请求参数</h3> <table> <thead> <tr> <th>参数名称</th> <th>类型</th> <th>是否必填</th> <th>最大长度</th> <th>参数描述</th> <th>示例值</th> </tr> </thead> <tbody> <tr> <td>companyId</td> <td>数值</td> <td>是</td> <td>11</td> <td>平台分配给企业的ID</td> <td>52984126340489216</td> </tr> <tr> <td>charset</td> <td>字符</td> <td>是</td> <td>10</td> <td>请求使用的编码格式,如utf-8,gbk等</td> <td>utf-8</td> </tr> <tr> <td>signType</td> <td>字符</td> <td>是</td> <td>10</td> <td>企业生成签名字符串所使用的签名算法类型,目前支持RSA和RSA2,推荐使用RSA2</td> <td>RSA2</td> </tr> <tr> <td>bizContent</td> <td>json</td> <td>是</td> <td>不限</td> <td>请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递</td> <td>-</td> </tr> <tr> <td>timestamp</td> <td>字符</td> <td>是</td> <td>19</td> <td>发送请求的时间,格式&quot;yyyy-MM-dd HH:mm:ss&quot;</td> <td>2023-10-01 08:08:08</td> </tr> <tr> <td>sign</td> <td>字符</td> <td>是</td> <td>344</td> <td>企业请求参数的签名串,详见[数据签名](<a href="https://www.showdoc.com.cn/kycloudopen/11199716093743187">https://www.showdoc.com.cn/kycloudopen/11199716093743187</a> &quot;数据签名&quot;)</td> <td>详见示例</td> </tr> </tbody> </table> <h3>业务请求参数</h3> <table> <thead> <tr> <th>参数名称</th> <th>类型</th> <th>是否必填</th> <th>最大长度</th> <th>参数描述</th> <th>示例值</th> </tr> </thead> <tbody> <tr> <td>supplyId</td> <td>数值</td> <td>是</td> <td>11</td> <td>供应商编号开时约定</td> <td>1018</td> </tr> <tr> <td>activityId</td> <td>字符</td> <td>选择必填</td> <td>20</td> <td>支付宝立减金券ID</td> <td>ACTxxxxxxxx</td> </tr> </tbody> </table> <h3>公共响应参数</h3> <table> <thead> <tr> <th>参数名称</th> <th>类型</th> <th>是否必填</th> <th>最大长度</th> <th>参数描述</th> <th>示例值</th> </tr> </thead> <tbody> <tr> <td>code</td> <td>字符</td> <td>否</td> <td>-</td> <td>错误码</td> <td>open_request_expired</td> </tr> <tr> <td>success</td> <td>字符</td> <td>是</td> <td>-</td> <td>请求是否成功,成功true、失败false</td> <td>true</td> </tr> <tr> <td>message</td> <td>字符</td> <td>否</td> <td>-</td> <td>失败描述</td> <td>请求过期,请求重新发起</td> </tr> <tr> <td>object</td> <td>JSON</td> <td>是</td> <td>-</td> <td>配置信息查询返回</td> <td>-</td> </tr> </tbody> </table> <h3>响应参数</h3> <table> <thead> <tr> <th>参数名称</th> <th>类型</th> <th>是否必填</th> <th>最大长度</th> <th>参数描述</th> <th>示例值</th> </tr> </thead> <tbody> <tr> <td>activName</td> <td>字符</td> <td>是</td> <td>-</td> <td>渠道红包活动名称描述</td> <td>招商银行渠道红包</td> </tr> <tr> <td>activityId</td> <td>字符</td> <td>是</td> <td>-</td> <td>活动唯一id</td> <td>ACT358CCV00015283</td> </tr> <tr> <td>activityStatus</td> <td>字符</td> <td>是</td> <td>-</td> <td>CREATED=&quot;已创建&quot;, PUBLISHING=&quot;发布中&quot;,PUBLISHED_FAILED=&quot;发布失败&quot;, GREY=&quot;已发布(白名单验证中)&quot;,GOING=&quot;已发布&quot;,PAUSED=&quot;已暂停&quot;,ENDED=&quot;已结束&quot;</td> <td>GOING</td> </tr> <tr> <td>activChannel</td> <td>数值</td> <td>是</td> <td>-</td> <td>1-支付宝 2-微信</td> <td>1</td> </tr> <tr> <td>couponType</td> <td>数值</td> <td>是</td> <td>-</td> <td>1-支付宝立减</td> <td>1</td> </tr> <tr> <td>supplyId</td> <td>数值</td> <td>是</td> <td>-</td> <td>供应商ID</td> <td>1018</td> </tr> <tr> <td>activBegin</td> <td>字符</td> <td>是</td> <td>-</td> <td>红包发放开始时间</td> <td>2010-11-11 11:11:11</td> </tr> <tr> <td>activEnd</td> <td>字符</td> <td>是</td> <td>-</td> <td>红包发放结束时间</td> <td>2010-11-11 11:11:11</td> </tr> <tr> <td>couponAvailableAmount</td> <td>字符</td> <td>是</td> <td>-</td> <td>剩余预算</td> <td>10.00</td> </tr> <tr> <td>couponReceiveAmount</td> <td>字符</td> <td>是</td> <td>-</td> <td>已领取红包金额</td> <td>10.00</td> </tr> <tr> <td>couponUseAmount</td> <td>字符</td> <td>是</td> <td>-</td> <td>已经核销红包金额</td> <td>10.00</td> </tr> <tr> <td>couponRefundAmount</td> <td>字符</td> <td>是</td> <td>-</td> <td>已经退款金额</td> <td>10.00</td> </tr> <tr> <td>couponReceiveCount</td> <td>数值</td> <td>是</td> <td>-</td> <td>已领取红包数量</td> <td>5</td> </tr> <tr> <td>couponUseCount</td> <td>数值</td> <td>是</td> <td>-</td> <td>已核销红包数量</td> <td>5</td> </tr> <tr> <td>minSendCount</td> <td>数值</td> <td>是</td> <td>-</td> <td>最小发放份数</td> <td>5</td> </tr> <tr> <td>totalBudget</td> <td>字符</td> <td>是</td> <td>-</td> <td>总预算</td> <td>5</td> </tr> <tr> <td>discountThresholdAmt</td> <td>字符</td> <td>是</td> <td>-</td> <td>优惠立减门槛金额</td> <td>5.00</td> </tr> <tr> <td>discountValue</td> <td>字符</td> <td>是</td> <td>-</td> <td>优惠立减值</td> <td>5.00</td> </tr> <tr> <td>discountType</td> <td>字符</td> <td>是</td> <td>-</td> <td>优惠立减类型 立减类型 reduce:满立减(满5元减3元) random:随机立减(满10元随机立减1元到3元</td> <td>reduce</td> </tr> </tbody> </table>

页面列表

ITEM_HTML