文章博客

技术团队文档示例


月饼券API接口文档

<h4>登录接口</h4> <ul> <li> <p>登录:<a href="https://mc1.fashvn.com/vms/api?act=doLogin&userId=ADMIN&password=TEST">https://mc1.fashvn.com/vms/api?act=doLogin&userId=ADMIN&password=TEST</a></p> <pre><code>{ "status": true, "name": "1", "userId": "ADMIN", "accessLevel": "1,2,3", "locationCode": "1", "staffId": "null", "userLevel": "1", "password": "TEST", "lastUpdateDate": "2019-04-09 14:02:15.0", "lastUpdateUser": "ADMIN" }</code></pre> </li> </ul> <p>[========]</p> <h4>用户管理</h4> <ul> <li> <p>查找:<a href="https://mc.fashvn.com/api?act=findUsers&level=X">https://mc.fashvn.com/api?act=findUsers&level=X</a> level : 用户等级</p> <pre><code>成功: { "status": true, "list": [ { "name": "001", "userId": "001", "accessLevel": "1,6,7,33,35,36,37,38,39,4,15,24,16,27,5,20,21", "locationCode": "1", "staffId": "null", "userLevel": "A", "password": "001", "lastUpdateDate": "2019-04-10 10:06:54.0", "lastUpdateUser": "ADMIN" } ] }</code></pre> </li> <li>增加:<a href="https://mc.fashvn.com/api?act=addUser&name=001&staffId=001&password=001&accessLevel=1,6,7,33,35,36,37,38,39,4,15,24,16,27,5,20,21&userId=001&userLevel=A&locationCode=001">https://mc.fashvn.com/api?act=addUser&name=001&staffId=001&password=001&accessLevel=1,6,7,33,35,36,37,38,39,4,15,24,16,27,5,20,21&userId=001&userLevel=A&locationCode=001</a> 错误数据: { &quot;status&quot;: false, &quot;msg&quot;: &quot;null&quot; } 成功返回: { &quot;status&quot;: true }</li> <li> <p>删除:<a href="https://mc.fashvn.com/api?act=delUser&userId=001">https://mc.fashvn.com/api?act=delUser&userId=001</a></p> <pre><code>成功响应数据 { "status": true } 失败响应数据 { "status": false }</code></pre> </li> <li>修改:<a href="https://mc.fashvn.com/api?act=updateUser&name=001&staffId=001&password=001&accessLevel=1,6,7,33,35,36,37,38,39,4,15,24,16,27,5,20,21&userId=001&userLevel=A&locationCode=001">https://mc.fashvn.com/api?act=updateUser&name=001&staffId=001&password=001&accessLevel=1,6,7,33,35,36,37,38,39,4,15,24,16,27,5,20,21&userId=001&userLevel=A&locationCode=001</a> 成功响应数据: { &quot;status&quot;: true } 错误响应数据: { &quot;status&quot;: false }</li> </ul> <p>[========]</p> <h4>产品类型</h4> <ul> <li> <p>查找接口:<a href="https://mc.fashvn.com/api?act=findTypes">https://mc.fashvn.com/api?act=findTypes</a></p> <p>成功响应数据: { &quot;status&quot;: true, &quot;list&quot;: [ { &quot;description&quot;: &quot;444&quot;, &quot;typeCode&quot;: &quot;2&quot;, &quot;totalGeneratedQty&quot;: &quot;60&quot;, &quot;currentGeneratedQty&quot;: &quot;60&quot;, &quot;lastUpdateDate&quot;: &quot;2019-04-09 14:05:11.0&quot;, &quot;lastUpdateUser&quot;: &quot;ADMIN&quot; } ] }</p> </li> <li> <p>增加接口:<a href="https://mc.fashvn.com/api?act=addType&typeCode=001&description=001">https://mc.fashvn.com/api?act=addType&typeCode=001&description=001</a></p> <pre><code>失败响应数据: { "status": false, "msg": "null" } 成功响应数据: { "status": true }</code></pre> </li> <li> <p>删除接口:<a href="https://mc.fashvn.com/api?act=delType&typeCode=001">https://mc.fashvn.com/api?act=delType&typeCode=001</a></p> <pre><code>成功响应数据 { "status": true } 失败响应数据 { "status": false }</code></pre> <p>2019-04-18 10:56:28 星期四</p> </li> <li> <p>修改接口:<a href="https://mc.fashvn.com/api?act=updateType&typeCode=001&description=001">https://mc.fashvn.com/api?act=updateType&typeCode=001&description=001</a></p> <pre><code>成功响应数据 { "status": true } 失败响应数据 { "status": false }</code></pre> <p>[========]</p> </li> </ul> <h4>销售地点</h4> <ul> <li> <p>查找接口:<a href="https://mc.fashvn.com/api?act=findLocations">https://mc.fashvn.com/api?act=findLocations</a></p> <pre><code>成功响应数据 { "status": true, "list": [ { "description": "444", "complimentary": "Y", "locationCode": "1", "lastUpdateDate": "2019-04-09 14:01:46.0", "lastUpdateUser": "ADMIN" }, { "description": "002", "complimentary": "Y", "locationCode": "003", "lastUpdateDate": "2019-04-10 14:21:19.0", "lastUpdateUser": "ADMIN" } ] }</code></pre> </li> <li> <p>增加:<a href="https://mc.fashvn.com/api?act=addLocation&code=001&description=001&complimentary=Y">https://mc.fashvn.com/api?act=addLocation&code=001&description=001&complimentary=Y</a></p> <pre><code>错误数据: { "status": false, "msg": "null" } 成功返回: { "status": true }</code></pre> </li> <li> <p>删除:<a href="https://mc.fashvn.com/api?act=delLocation&code=001">https://mc.fashvn.com/api?act=delLocation&code=001</a></p> <pre><code>成功响应数据 { "status": true } 失败响应数据 { "status": false }</code></pre> <p>2019-04-18 10:57:23 星期四</p> </li> <li> <p>修改:<a href="https://mc.fashvn.com/api?act=updateLocation&code=001&description=001&complimentary=Y">https://mc.fashvn.com/api?act=updateLocation&code=001&description=001&complimentary=Y</a></p> <pre><code>成功响应数据 { "status": true } 失败响应数据 { "status": false }</code></pre> </li> </ul> <p>[========]</p> <h4>生成券号</h4> <ul> <li> <p>生成:<a href="https://mc.fashvn.com/api?act=createCoupon&typeCode=2&qty=1">https://mc.fashvn.com/api?act=createCoupon&typeCode=2&qty=1</a></p> <pre><code>成功响应数据: { "status": true, "data": { "typeCode": "2", "totalqty": "2", "qty": "1" } } 错误响应数据: { "status":false, "msg":"ORA-02291: integrity constraint (MCDB01.VOUCHERS_FK1) violated - parent key not found "}</code></pre> </li> </ul> <h4>下载券码</h4> <ul> <li> <p>下载:<a href="https://mc.fashvn.com/api?act=dowload">https://mc.fashvn.com/api?act=dowload</a></p> <pre><code> 成功返回数据 1900013821,01635499551900013822,0127915086</code></pre> </li> </ul> <h4>确认券号</h4> <ul> <li> <p>确认 : <a href="https://mc.fashvn.com/api?act=confirmCoupons&from=19114982&to">https://mc.fashvn.com/api?act=confirmCoupons&from=19114982&to</a>=''</p> <pre><code> 成功响应数据: { "status": true, "data": { "qty": "0" } } 错误响应数据: { "status":false, "msg":" "}</code></pre> </li> </ul> <h4>分配券号</h4> <ul> <li> <p>分配 : <a href="https://mc.fashvn.com/api?act=dsCoupons&shop=002&complimentary=N&typeCode=001&from=1&to=2">https://mc.fashvn.com/api?act=dsCoupons&shop=002&complimentary=N&typeCode=001&from=1&to=2</a></p> <pre><code> 成功响应数据: { "status": true, "data": { "qty": "0" } } 错误响应数据: { "status":false, "msg":" "}</code></pre> </li> </ul> <h4>激活券号</h4> <ul> <li> <p>激活 : <a href="http://localhost/api?act=activeCoupons&from=1900013821&to=1900013824&loc=ZOFF">http://localhost/api?act=activeCoupons&from=1900013821&to=1900013824&loc=ZOFF</a></p> <pre><code> 成功响应数据: { "status": true, "data": { "qty": "0" } } 错误响应数据: { "status":false, "msg":" "}</code></pre> </li> </ul> <h4>校验券号</h4> <ul> <li> <p>激活 : <a href="http://localhost/api?act=checks&code=19100001">http://localhost/api?act=checks&code=19100001</a></p> <pre><code> 成功响应数据: { "status": true, "data": { "qty": "0" } } 错误响应数据: { "status":false, "data":"null" "}</code></pre> </li> </ul> <h4>调整券号</h4> <ul> <li> <p>调整 : <a href="http://localhost/api?act=adjustments&shop=1&complimentary=N&from=1900013821&to=1900013824&loc=ZOFF">http://localhost/api?act=adjustments&shop=1&complimentary=N&from=1900013821&to=1900013824&loc=ZOFF</a></p> <pre><code> 成功响应数据: { "status": true, "data": { "qty": "0" } } 错误响应数据: { "status":false, "data":"null" "}</code></pre> </li> </ul> <h4>校验券号</h4> <ul> <li>调整 : <a href="http://mc1.fashvn.com/vms/api?act=checkrange&from=19100003&to=19100003&checkLocation=HNGL001&checkStatus=D">http://mc1.fashvn.com/vms/api?act=checkrange&from=19100003&to=19100003&checkLocation=HNGL001&checkStatus=D</a> <pre><code> 成功响应数据: { "status": true, "errorData": [] } 错误响应数据: { "status": true, "errorData": [ { "code": "19100001", "type": "", "status": "A", "price": "0.0", "location": "", "complimentary": "N" } ] }</code></pre></li> </ul> <p>2019-05-31 10:40:17 星期五</p> <h4>销售券号</h4> <ul> <li>调整 : <a href="http://mc1.fashvn.com/vms/api?act=saleCoupons&ranges=1900013821-1900013824,1900013821-1900013824&ptype=1&loc=ZOFF">http://mc1.fashvn.com/vms/api?act=saleCoupons&ranges=1900013821-1900013824,1900013821-1900013824&ptype=1&loc=ZOFF</a> <pre><code> 成功响应数据: { "status": true, "errorData": [] } 错误响应数据: { "status": true, "errorData": [ { "code": "19100001", "type": "", "status": "A", "price": "0.0", "location": "", "complimentary": "N" } ] }</code></pre></li> </ul> <p>2019-05-31 11:59:21 星期五</p> <h4>结算报表</h4> <ul> <li> <p>调整 : <a href="http://mc1.fashvn.com/vms/api?act=daily&location=ZOFF&from=2019-05-31&to=2019-06-30&userId=001">http://mc1.fashvn.com/vms/api?act=daily&location=ZOFF&from=2019-05-31&to=2019-06-30&userId=001</a></p> <p>成功响应数据: { &quot;status&quot;: true, &quot;report&quot;: [ { &quot;description&quot;: &quot;七星伴月&quot;, &quot;code&quot;: &quot;1&quot;, &quot;status&quot;: &quot;R&quot;, &quot;qty&quot;: &quot;2&quot; } ] } 错误响应数据: {</p> <pre><code>}</code></pre> </li> </ul> <h4>券状态( 券号管理列表 )按照地区查询 (不按地区不用传loc)</h4> <ul> <li> <p>调整 : <a href="http://mc1.fashvn.com/vms/api?act=status1&loc=ZOFF">http://mc1.fashvn.com/vms/api?act=status1&loc=ZOFF</a> </p> <pre><code> 成功响应数据: { "status": true, "report": { "qty": "0", "amt": "0.0", "ali": "0.0", "wechat": "0.0", "unipay": "0.0", "cash": "0.0", "credit": "0.0" } } 错误响应数据: { "status" : false }</code></pre> </li> </ul> <h4>操作流程</h4> <ul> <li>调整 : <a href="http://mc1.fashvn.com/vms/api?act=movements&code=19xxx&from=2018-12-12&to=2018-12-12">http://mc1.fashvn.com/vms/api?act=movements&code=19xxx&from=2018-12-12&to=2018-12-12</a></li> </ul> <h4>核销</h4> <ul> <li>核销 : <a href="http://mc1.fashvn.com/vms/api?act=closeCoupons&from=19600004&to=19600004">http://mc1.fashvn.com/vms/api?act=closeCoupons&from=19600004&to=19600004</a></li> </ul> <pre><code class="language-json">{ "status": true, "data": { "qty": "1" } } //失败响应 { "status": true, "data": { "qty": "0" } }</code></pre> <h4>结算报表</h4> <ul> <li><a href="http://mc1.fashvn.com/vms/api?act=daily&location=1&from=2018-12-12&to=2018-12-12">http://mc1.fashvn.com/vms/api?act=daily&location=1&from=2018-12-12&to=2018-12-12</a></li> </ul> <h4>券号状态</h4> <ul> <li>类型 : <a href="http://mc1.fashvn.com/vms/api?act=statusByType">http://mc1.fashvn.com/vms/api?act=statusByType</a></li> <li>店铺 : <a href="http://mc1.fashvn.com/vms/api?act=statusByShop">http://mc1.fashvn.com/vms/api?act=statusByShop</a></li> <li>地区 : <a href="http://mc1.fashvn.com/vms/api?act=statusByDistrict">http://mc1.fashvn.com/vms/api?act=statusByDistrict</a></li> <li>品牌 : <a href="http://mc1.fashvn.com/vms/api?act=statusByBrand">http://mc1.fashvn.com/vms/api?act=statusByBrand</a></li> </ul> <h4>操作流程</h4> <ul> <li><a href="http://mc1.fashvn.com/vms/api?act=movements&code=19900001&from=2019-04-05&to=2019-06-04">http://mc1.fashvn.com/vms/api?act=movements&code=19900001&from=2019-04-05&to=2019-06-04</a></li> </ul> <h4>销售摘要(更新)</h4> <ul> <li>类型 :<a href="http://mc1.fashvn.com/vms/api?act=summaryGroup1&from=2019-06-13&to=2019-06-14">http://mc1.fashvn.com/vms/api?act=summaryGroup1&from=2019-06-13&to=2019-06-14</a></li> <li>地区 / 类型 :<a href="http://mc1.fashvn.com/vms/api?act=summaryGroup2&from=2019-06-13&to=2019-06-14">http://mc1.fashvn.com/vms/api?act=summaryGroup2&from=2019-06-13&to=2019-06-14</a></li> <li>地区 / 品牌 :<a href="http://mc1.fashvn.com/vms/api?act=summaryGroup3&from=2019-06-13&to=2019-06-14">http://mc1.fashvn.com/vms/api?act=summaryGroup3&from=2019-06-13&to=2019-06-14</a></li> <li>地区 / 类型 / 品牌 :<a href="http://mc1.fashvn.com/vms/api?act=summaryGroup4&from=2019-06-13&to=2019-06-14">http://mc1.fashvn.com/vms/api?act=summaryGroup4&from=2019-06-13&to=2019-06-14</a></li> </ul> <h4>销售详情</h4> <ul> <li> <p>销售详情 <del><a href="http://mc1.fashvn.com/vms/api?act=detail&loc=ZOFF&from=2018-12-12&to=2019-06-13">http://mc1.fashvn.com/vms/api?act=detail&loc=ZOFF&from=2018-12-12&to=2019-06-13</a></del></p> <pre><code> https://api-vms.fashvn.com/api?act=saleDetail&amp;location=HDDL01&amp;userId=SYSADMIN</code></pre> </li> </ul> <h4>支付方式接口</h4> <ul> <li>支付方式 <a href="http://mc1.fashvn.com/vms/api?act=getPayments">http://mc1.fashvn.com/vms/api?act=getPayments</a> <h1></h1> <h2>新增库存接口:</h2></li> </ul> <p><strong>简要描述:</strong> </p> <ul> <li>库存详情</li> </ul> <p><strong>请求URL:</strong> </p> <ul> <li><code>http://138.2.16.187:8080/api?act=repertoryDetail&amp;locationCode=HBGL01&amp;typeCode=3</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 style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">act</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>角色</td> </tr> <tr> <td style="text-align: left;">locationCode</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>地点编号</td> </tr> <tr> <td style="text-align: left;">typeCode</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>类型编号</td> </tr> </tbody> </table> <p><strong>返回示例</strong></p> <pre><code> { "report": [ { "locationName": "华北-港丽-北京大悦城店", "onhandQuantity": "6", "typeName": "双黄白莲蓉" } ], "status": true }</code></pre> <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;">locationName</td> <td style="text-align: left;">string</td> <td>地点名称</td> </tr> <tr> <td style="text-align: left;">onhandQuantity</td> <td style="text-align: left;">string</td> <td>庫存數量</td> </tr> <tr> <td style="text-align: left;">typeName</td> <td style="text-align: left;">string</td> <td>类型名称</td> </tr> </tbody> </table> <p><strong>备注</strong> </p> <ul> <li>更多返回错误代码请看首页的错误代码描述</li> </ul> <h3><strong>调整库存</strong></h3> <ul> <li>接口url : <code>http://138.2.16.187:8080/api?act=repertoryAdd&amp;locationCode=HBGL01&amp;typeCode=2&amp;add=1</code> <pre><code>添加成功,返回数据 { "report": [], "status": true }</code></pre></li> </ul> <h3>销售列表 (未销售)</h3> <p>url <a href="https://mc.fashvn.com/vms/api?act=status1&loc=HDGL05">https://mc.fashvn.com/vms/api?act=status1&loc=HDGL05</a> { &quot;description&quot;: &quot;七星伴月&quot;, &quot;code&quot;: &quot;5&quot;, &quot;status&quot;: &quot;S&quot;, &quot;qty&quot;: &quot;90&quot; }</p> <h4>生成支付二维码</h4> <p>url <a href="https://api-vms.fashvn.com/api?act=generateOrder&userId=SYSADMINN&ranges=20200007-20200008,20200009-20200010">https://api-vms.fashvn.com/api?act=generateOrder&userId=SYSADMINN&ranges=20200007-20200008,20200009-20200010</a></p> <h4>获取订单超时时间/设置时间</h4> <p><a href="https://api-vms.fashvn.com/api?act=getSysSetting&userId=SYSADMIN">https://api-vms.fashvn.com/api?act=getSysSetting&userId=SYSADMIN</a></p> <h4>设置超时时间/以秒为单位</h4> <p><a href="https://api-vms.fashvn.com/api?act=setSysSetting&userId=SYSADMIN&orderOutTime=120&orderPayListenTime=1">https://api-vms.fashvn.com/api?act=setSysSetting&userId=SYSADMIN&orderOutTime=120&orderPayListenTime=1</a></p> <h4>订单列表:按照地点查询 不传时间+不传地点</h4> <p><a href="https://api-vms-uat.fashvn.com/api?act=orderByAddr&userId=SYSADMIN&from=2020-06-21&to=2020-06-26&location=HDOF01">https://api-vms-uat.fashvn.com/api?act=orderByAddr&userId=SYSADMIN&from=2020-06-21&to=2020-06-26&location=HDOF01</a></p>

页面列表

ITEM_HTML