乐收赢-营销接口

银飞营销接口


优惠券凭证核销准备

<p><strong>接口描述:</strong> </p> <ul> <li>优惠券凭证核销准备</li> </ul> <p><strong>接口URL:</strong> </p> <ul> <li><code>https://open.gdyfsk.com/yfpay/coupon/prepareuse</code></li> </ul> <p><strong>请求方式:</strong></p> <ul> <li>POST </li> </ul> <p><strong>请求头部:</strong></p> <table> <thead> <tr> <th style="text-align: left;">标签</th> <th style="text-align: left;">必填</th> <th>内容</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">Content-Type</td> <td style="text-align: left;">是</td> <td>application/json</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 style="text-align: left;">说明</th> <th>参数示例</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">inst_no</td> <td style="text-align: left;">string(8)</td> <td style="text-align: left;">是</td> <td style="text-align: left;">机构号</td> <td>900024</td> </tr> <tr> <td style="text-align: left;">merchant_no</td> <td style="text-align: left;">string(32)</td> <td style="text-align: left;">是</td> <td style="text-align: left;">商户号</td> <td>851811130002</td> </tr> <tr> <td style="text-align: left;">shop_no</td> <td style="text-align: left;">string(32)</td> <td style="text-align: left;">是</td> <td style="text-align: left;">门店号</td> <td>862010110001</td> </tr> <tr> <td style="text-align: left;">ts</td> <td style="text-align: left;">string(14)</td> <td style="text-align: left;">是</td> <td style="text-align: left;">时间戳</td> <td>1709617787754</td> </tr> <tr> <td style="text-align: left;">coupon_code</td> <td style="text-align: left;">string(16)</td> <td style="text-align: left;">是</td> <td style="text-align: left;">优惠券码</td> <td>000275357242</td> </tr> <tr> <td style="text-align: left;">channel_type</td> <td style="text-align: left;">string(5)</td> <td style="text-align: left;">否</td> <td style="text-align: left;">通道类型</td> <td>10014.支付宝本地生活</td> </tr> <tr> <td style="text-align: left;">sign</td> <td style="text-align: left;">string(32)</td> <td style="text-align: left;">是</td> <td style="text-align: left;">签名</td> <td>51c7d68424e5492199cf7f4734a2b977</td> </tr> </tbody> </table> <p><strong>请求示例:</strong></p> <ul> <li>未使用的优惠券 凭证核销准备</li> </ul> <pre><code class="language-json">{   &amp;quot;merchant_no&amp;quot;:&amp;quot;852310170003&amp;quot;,   &amp;quot;coupon_code&amp;quot;:&amp;quot;000275357242&amp;quot;,   &amp;quot;inst_no&amp;quot;:&amp;quot;900080&amp;quot;,   &amp;quot;sign&amp;quot;:&amp;quot;9964a81907ced24262b60183d86d7efa&amp;quot;,   &amp;quot;channel_type&amp;quot;:&amp;quot;&amp;quot;,   &amp;quot;shop_no&amp;quot;:&amp;quot;S62310170001&amp;quot;,   &amp;quot;ts&amp;quot;:&amp;quot;20231222170112&amp;quot; }</code></pre> <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 style="text-align: left;">说明</th> <th>参数示例</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">return_code</td> <td style="text-align: left;">string(32)</td> <td style="text-align: left;">是</td> <td style="text-align: left;">响应码:SUCCESS成功,FAIL失败,响应码仅代表通信或参数</td> <td>SUCCESS</td> </tr> <tr> <td style="text-align: left;">return_msg</td> <td style="text-align: left;">string(128)</td> <td style="text-align: left;">是</td> <td style="text-align: left;">返回信息提示,“操作成功”,“参数不合法” 等</td> <td>操作成功</td> </tr> <tr> <td style="text-align: left;">result_code</td> <td style="text-align: left;">string(32)</td> <td style="text-align: left;">是</td> <td style="text-align: left;">业务结果:SUCCESS ,FAIL,只有在return_code为SUCCESS时才会返回</td> <td>SUCCESS</td> </tr> <tr> <td style="text-align: left;">order_id</td> <td style="text-align: left;">string(128)</td> <td style="text-align: left;">是</td> <td style="text-align: left;">订单id:购买商品的订单id,核销接口使用</td> <td>2023122201502300000002440035116446</td> </tr> <tr> <td style="text-align: left;">user_id</td> <td style="text-align: left;">string(128)</td> <td style="text-align: left;">是</td> <td style="text-align: left;">支付宝用户id:凭证归属支付宝用户id,核销接口使用</td> <td>2088122288832244</td> </tr> <tr> <td style="text-align: left;">sign</td> <td style="text-align: left;">string</td> <td style="text-align: left;">是</td> <td style="text-align: left;">签名</td> <td>778e1fb75c06d9efe2a91e7912641f3d</td> </tr> <tr> <td style="text-align: left;">certificate_prepare_info_list</td> <td style="text-align: left;">object</td> <td style="text-align: left;">是</td> <td style="text-align: left;">凭证信息列表,JSON格式的数组</td> </tr> <tr> <td style="text-align: left;">--certificate_id</td> <td style="text-align: left;">string(32)</td> <td style="text-align: left;">是</td> <td style="text-align: left;">凭证id</td> <td>2021042322001426261436764012</td> </tr> <tr> <td style="text-align: left;">--encrypted_code</td> <td style="text-align: left;">string(128)</td> <td style="text-align: left;">是</td> <td style="text-align: left;">加密券码:加密券码,核销接口使用</td> <td>Q2Wk85Y1N0eHpRUFpMMmZwNTdFM2NKeWlFN</td> </tr> <tr> <td style="text-align: left;">--order_id</td> <td style="text-align: left;">string(64)</td> <td style="text-align: left;">是</td> <td style="text-align: left;">购买商品的订单id</td> <td>1997081101502300000001290055702988</td> </tr> <tr> <td style="text-align: left;">--valid_begin_time</td> <td style="text-align: left;">date(19)</td> <td style="text-align: left;">是</td> <td style="text-align: left;">券的有效期开始时间</td> <td>1703234101000</td> </tr> <tr> <td style="text-align: left;">--valid_end_time</td> <td style="text-align: left;">date(19)</td> <td style="text-align: left;">是</td> <td style="text-align: left;">券的有效期结束时间</td> <td>1705852800000</td> </tr> <tr> <td style="text-align: left;">--amount_info</td> <td style="text-align: left;">object</td> <td style="text-align: left;">否</td> <td style="text-align: left;">凭证金额信息,JSON格式的数组</td> <td></td> </tr> <tr> <td style="text-align: left;">----original_price</td> <td style="text-align: left;">price(11)</td> <td style="text-align: left;">否</td> <td style="text-align: left;">商品原价:商品标注的原价,单位为元</td> <td>25.00</td> </tr> <tr> <td style="text-align: left;">----sale_price</td> <td style="text-align: left;">price(11)</td> <td style="text-align: left;">否</td> <td style="text-align: left;">商品售价:商品售卖的价格,单位为元</td> <td>20.00</td> </tr> <tr> <td style="text-align: left;">----receipt_amount</td> <td style="text-align: left;">price(11)</td> <td style="text-align: left;">否</td> <td style="text-align: left;">商家实收金额:商品售价去除商家订单优惠后的商家实收,未计算收单费率等,单位为元</td> <td>20.00</td> </tr> <tr> <td style="text-align: left;">--sku_info</td> <td style="text-align: left;">object</td> <td style="text-align: left;">否</td> <td style="text-align: left;">商品信息,JSON格式的数组</td> <td></td> </tr> <tr> <td style="text-align: left;">----sku_id</td> <td style="text-align: left;">string(128)</td> <td style="text-align: left;">否</td> <td style="text-align: left;">支付宝平台侧skuID</td> <td>2023122023000857102402</td> </tr> <tr> <td style="text-align: left;">----out_sku_id</td> <td style="text-align: left;">string(128)</td> <td style="text-align: left;">否</td> <td style="text-align: left;">商家侧skuID</td> <td>cs123</td> </tr> <tr> <td style="text-align: left;">----item_id</td> <td style="text-align: left;">string(128)</td> <td style="text-align: left;">否</td> <td style="text-align: left;">支付宝平台侧商品ID</td> <td>2023122022000407269413</td> </tr> <tr> <td style="text-align: left;">----out_item_id</td> <td style="text-align: left;">string(128)</td> <td style="text-align: left;">否</td> <td style="text-align: left;">商家侧商品ID</td> <td>cs123</td> </tr> <tr> <td style="text-align: left;">----title</td> <td style="text-align: left;">string(128)</td> <td style="text-align: left;">否</td> <td style="text-align: left;">商品名称</td> <td>【利口福】20代25元代金券</td> </tr> <tr> <td style="text-align: left;">----item_type</td> <td style="text-align: left;">string(2)</td> <td style="text-align: left;">否</td> <td style="text-align: left;">商品模版类型:1. 团购套餐、2. 代金券</td> <td>2</td> </tr> <tr> <td style="text-align: left;">--times_card_info</td> <td style="text-align: left;">object</td> <td style="text-align: left;">否</td> <td style="text-align: left;">次卡详情,商品类型为次卡时该值必填,JSON格式的数组</td> <td></td> </tr> <tr> <td style="text-align: left;">----total_count</td> <td style="text-align: left;">number(32)</td> <td style="text-align: left;">是</td> <td style="text-align: left;">次卡总次数</td> <td>10</td> </tr> <tr> <td style="text-align: left;">----used_count</td> <td style="text-align: left;">number(32)</td> <td style="text-align: left;">是</td> <td style="text-align: left;">已使用次数</td> <td>10</td> </tr> <tr> <td style="text-align: left;">----serial_info_list</td> <td style="text-align: left;">object</td> <td style="text-align: left;">是</td> <td style="text-align: left;">次卡次序号信息,JSON格式的数组</td> <td></td> </tr> <tr> <td style="text-align: left;">------serial_no</td> <td style="text-align: left;">string(32)</td> <td style="text-align: left;">是</td> <td style="text-align: left;">次序号</td> <td>2023122200445016243234414188</td> </tr> <tr> <td style="text-align: left;">------status</td> <td style="text-align: left;">string(2)</td> <td style="text-align: left;">否</td> <td style="text-align: left;">状态</td> <td></td> </tr> <tr> <td style="text-align: left;">------amount_info</td> <td style="text-align: left;">object</td> <td style="text-align: left;">是</td> <td style="text-align: left;">次序号的金额信息,JSON格式的数组</td> <td></td> </tr> <tr> <td style="text-align: left;">--------original_price</td> <td style="text-align: left;">price(11)</td> <td style="text-align: left;">否</td> <td style="text-align: left;">商品原价</td> <td>25.00</td> </tr> <tr> <td style="text-align: left;">--------sale_price</td> <td style="text-align: left;">price(11)</td> <td style="text-align: left;">否</td> <td style="text-align: left;">商品售价</td> <td>20.00</td> </tr> <tr> <td style="text-align: left;">--------receipt_amount</td> <td style="text-align: left;">price(11)</td> <td style="text-align: left;">否</td> <td style="text-align: left;">商家实收金额</td> <td>20.00</td> </tr> </tbody> </table> <p><strong>返回示例:</strong> </p> <ul> <li>成功返回结果:</li> </ul> <pre><code class="language-json">{     &amp;quot;certificatePrepareInfoList&amp;quot;: [         {             &amp;quot;amountInfo&amp;quot;: {                 &amp;quot;originalPrice&amp;quot;: &amp;quot;25.00&amp;quot;,                 &amp;quot;receiptAmount&amp;quot;: &amp;quot;20.00&amp;quot;,                 &amp;quot;salePrice&amp;quot;: &amp;quot;20.00&amp;quot;             },             &amp;quot;certificateId&amp;quot;: &amp;quot;2023122200445005243236195549&amp;quot;,             &amp;quot;encryptedCode&amp;quot;: &amp;quot;R5rzuqv4iMd6KT8B/aUbqarCN/Lp1ELsrsXXr7n98j2etlt6/n1aFde02jUACZoQiGIxVXcZ7rrz3wzUwSOeVlCr4McmbFOpScWw5e5Oq+4=&amp;quot;,             &amp;quot;orderId&amp;quot;: &amp;quot;2023122201502300000002440035116446&amp;quot;,             &amp;quot;skuInfo&amp;quot;: {                 &amp;quot;itemId&amp;quot;: &amp;quot;2023122022000407269413&amp;quot;,                 &amp;quot;itemType&amp;quot;: &amp;quot;2&amp;quot;,                 &amp;quot;outItemId&amp;quot;: &amp;quot;cs123&amp;quot;,                 &amp;quot;outSkuId&amp;quot;: &amp;quot;cs123&amp;quot;,                 &amp;quot;skuId&amp;quot;: &amp;quot;2023122023000857102402&amp;quot;,                 &amp;quot;title&amp;quot;: &amp;quot;【利口福】20代25元代金券&amp;quot;             },             &amp;quot;timesCardInfo&amp;quot;: {                 &amp;quot;serialInfoList&amp;quot;: [                     {                         &amp;quot;amountInfo&amp;quot;: {                             &amp;quot;originalPrice&amp;quot;: &amp;quot;25.00&amp;quot;,                             &amp;quot;receiptAmount&amp;quot;: &amp;quot;20.00&amp;quot;,                             &amp;quot;salePrice&amp;quot;: &amp;quot;20.00&amp;quot;                         },                         &amp;quot;serialNo&amp;quot;: &amp;quot;2023122200445016243234414188&amp;quot;,                         &amp;quot;status&amp;quot;: null                     }                 ],                 &amp;quot;totalCount&amp;quot;: 1,                 &amp;quot;usedCount&amp;quot;: 0             },             &amp;quot;validBeginTime&amp;quot;: 1703234101000,             &amp;quot;validEndTime&amp;quot;: 1705852800000         }     ],     &amp;quot;orderId&amp;quot;: &amp;quot;2023122201502300000002440035116446&amp;quot;,     &amp;quot;userId&amp;quot;: &amp;quot;2088122288832244&amp;quot;,     &amp;quot;return_code&amp;quot;: &amp;quot;SUCCESS&amp;quot;,     &amp;quot;return_msg&amp;quot;: &amp;quot;凭证核销准备调用成功&amp;quot;,     &amp;quot;result_code&amp;quot;: &amp;quot;SUCCESS&amp;quot;,     &amp;quot;sign&amp;quot;: &amp;quot;778e1fb75c06d9efe2a91e7912641f3d&amp;quot; } </code></pre>

页面列表

ITEM_HTML