龙收银开放平台标准API接口文档

openapi


下单创建订单

<p><strong>简要描述:</strong> </p> <ul> <li>下单创建订单</li> </ul> <p><strong>请求URL:</strong> </p> <ul> <li><code>http://192.168.12.67/s1/openapi/openapi/base/order/create</code></li> </ul> <p><strong>请求方式:</strong></p> <ul> <li>POST </li> </ul> <p><strong>请求类型:</strong></p> <ul> <li>application/json </li> </ul> <p><strong>加密类型:</strong></p> <ul> <li> <p>RSA </p> <p><strong>请求示例</strong></p> </li> </ul> <pre><code> { &amp;quot;ispInfoId&amp;quot;: 10001, &amp;quot;data&amp;quot;: &amp;quot;EZuaEYHl9CmijAsMmODB9lKY++8hXrIYMAknd5B8rhJuTu2ASvt2LoW8eBvko0hPv+fY9r3KCrELcyAuZsupFtbN+3J1j7nApomGeMq9IEk+BLzHhxZfdvCNTaVv/4tCv0jzEYEXe3hJsv/wzJS5Q6+EkcH81PI2yhHkcey4cTErhR/wmMs7LKl8kiG045c2E5yAoA+4Apm198Sayke+MP9+GuhhZeAZuDmxjyuS6ThnUXYCqH1vBzRBrrQdCeeAjVc3EX19P5/Z6u4YvEsOkHfIupbHJZ0BBk60j8md+lpPIvDmyXwYQGd/RUAx4umcGD1WwQYr5spTsD/Rpb8DzITMPm9PhiAfPBvR0yLItFgCpDOKlVqoNVOTRvA2lPKcKnCgk/fNxxZKS9DyQxqWDs1fIrCJnlrzmQZRNqjOF31QuoGH2JpLH7HZO5tXjopfVZw7s3WDznYXVi20EJ9OMYekIh9I2DSFd88HXK7CeKvLL5RebmT7ji1wPecoE08IereB59PU7OvDfdn3hTczxqMAmPprjDS2rmRrR5sCIzKH0QTICyprQmxf/3DVrn3elQqdRo4cKYe95mGmSmmxjS9UDpqBGfd0yfxueIf3SAv2Xmx+uhVy4sT/aubu/rcq7tCTkkudl6EfaDfbgh2wbQ36YjDGj7Pkba8jVIwCh4k=&amp;quot; }</code></pre> <p><strong>data</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;">ispInfoName</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>服务商名称</td> </tr> <tr> <td style="text-align: left;">printType</td> <td style="text-align: left;">是</td> <td style="text-align: left;">Integer</td> <td>打印类型 0:外卖单 1:堂食单</td> </tr> <tr> <td style="text-align: left;">thirdSerialNo</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>第三方流水号(请求微信/支付宝支付)</td> </tr> <tr> <td style="text-align: left;">orderType</td> <td style="text-align: left;">是</td> <td style="text-align: left;">Integer</td> <td>订单类型 1:下单 2:退单 3:部分退 此处为1</td> </tr> <tr> <td style="text-align: left;">thirdTransactionId</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>第三方交易ID</td> </tr> <tr> <td style="text-align: left;">createShopId</td> <td style="text-align: left;">是</td> <td style="text-align: left;">Integer</td> <td>店铺ID</td> </tr> <tr> <td style="text-align: left;">origTotal</td> <td style="text-align: left;">是</td> <td style="text-align: left;">Integer</td> <td>总原价(分)</td> </tr> <tr> <td style="text-align: left;">lastTotal</td> <td style="text-align: left;">是</td> <td style="text-align: left;">Integer</td> <td>实收(分)</td> </tr> <tr> <td style="text-align: left;">totalDiscount</td> <td style="text-align: left;">是</td> <td style="text-align: left;">Integer</td> <td>总优惠</td> </tr> <tr> <td style="text-align: left;">createTime</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>订单创建时间 yyyy-MM-dd HH:mm:ss</td> </tr> <tr> <td style="text-align: left;">settleStatus</td> <td style="text-align: left;">是</td> <td style="text-align: left;">Integer</td> <td>订单状态(0:未支付 1:已支付)</td> </tr> <tr> <td style="text-align: left;">settleInfo</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>第三方订单牌号信息</td> </tr> <tr> <td style="text-align: left;">remark</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>整单备注</td> </tr> <tr> <td style="text-align: left;">takeMoney</td> <td style="text-align: left;">是</td> <td style="text-align: left;">Integer</td> <td>收款额</td> </tr> <tr> <td style="text-align: left;">giveChange</td> <td style="text-align: left;">是</td> <td style="text-align: left;">Integer</td> <td>找零</td> </tr> <tr> <td style="text-align: left;">itemInfoList</td> <td style="text-align: left;">是</td> <td style="text-align: left;">List&lt;ThirdOrderItemCnd&gt;</td> <td>品项信息列表</td> </tr> <tr> <td style="text-align: left;">paywayInfoList</td> <td style="text-align: left;">是</td> <td style="text-align: left;">List&lt;ThirdOrderPaywayCnd&gt;</td> <td>支付方式信息列表</td> </tr> <tr> <td style="text-align: left;">ticketInfoList</td> <td style="text-align: left;">否</td> <td style="text-align: left;">List&lt;ThirdOrderTicketCnd&gt;</td> <td>券信息列表</td> </tr> <tr> <td style="text-align: left;">crmTickList</td> <td style="text-align: left;">否</td> <td style="text-align: left;">List&lt;ThirdOrderCrmTickCnd&gt;</td> <td>消费券信息列表</td> </tr> <tr> <td style="text-align: left;">thirdOrderUserCnd</td> <td style="text-align: left;">否</td> <td style="text-align: left;">ThirdOrderUserCnd</td> <td>用户信息</td> </tr> <tr> <td style="text-align: left;">thirdOrderMembersCnd</td> <td style="text-align: left;">否</td> <td style="text-align: left;">ThirdOrderMembersCnd</td> <td>会员信息</td> </tr> <tr> <td style="text-align: left;">activityList</td> <td style="text-align: left;">否</td> <td style="text-align: left;">List&lt;ThirdSettlementActivity&gt;</td> <td>活动列表</td> </tr> </tbody> </table> <p><strong>ThirdOrderItemCnd</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th>类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">id</td> <td style="text-align: left;">是</td> <td>Long</td> <td>商品ID</td> </tr> <tr> <td style="text-align: left;">name</td> <td style="text-align: left;">是</td> <td>String</td> <td>菜品名称</td> </tr> <tr> <td style="text-align: left;">unitId</td> <td style="text-align: left;">是</td> <td>Long</td> <td>单位id</td> </tr> <tr> <td style="text-align: left;">itemClassId</td> <td style="text-align: left;">是</td> <td>Long</td> <td>分类ID</td> </tr> <tr> <td style="text-align: left;">origPrice</td> <td style="text-align: left;">是</td> <td>Integer</td> <td>原价(分)</td> </tr> <tr> <td style="text-align: left;">lastPrice</td> <td style="text-align: left;">是</td> <td>Integer</td> <td>实收(分)</td> </tr> <tr> <td style="text-align: left;">costPrice</td> <td style="text-align: left;">是</td> <td>Integer</td> <td>成本价 (分)</td> </tr> <tr> <td style="text-align: left;">qty</td> <td style="text-align: left;">是</td> <td>number</td> <td>数量</td> </tr> <tr> <td style="text-align: left;">itemType</td> <td style="text-align: left;">是</td> <td>Integer</td> <td>菜品类型(0、菜品;1、套餐;2、打包盒)</td> </tr> <tr> <td style="text-align: left;">pkgList</td> <td style="text-align: left;">否</td> <td>List&lt;ThirdOrderPkgCnd&gt;</td> <td>套餐明细</td> </tr> <tr> <td style="text-align: left;">methodVoList</td> <td style="text-align: left;">否</td> <td>List&lt;SettlementItemMethodVo&gt;</td> <td>做法列表</td> </tr> </tbody> </table> <p><strong>SettlementItemMethodVo</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;">id</td> <td style="text-align: left;">是</td> <td style="text-align: left;">Long</td> <td>品项制作方法ID</td> </tr> <tr> <td style="text-align: left;">type</td> <td style="text-align: left;">是</td> <td style="text-align: left;">Integer</td> <td>制作方法类型:1、共有做法;2、私有做法;3、自定义</td> </tr> <tr> <td style="text-align: left;">methodName</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>做法名称</td> </tr> <tr> <td style="text-align: left;">remark</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>做法描述(type = 3时传入)</td> </tr> <tr> <td style="text-align: left;">price</td> <td style="text-align: left;">是</td> <td style="text-align: left;">Integer</td> <td>制作方法价格 (分)</td> </tr> <tr> <td style="text-align: left;">addPri</td> <td style="text-align: left;">是</td> <td style="text-align: left;">Integer</td> <td>做法加价 (分)</td> </tr> <tr> <td style="text-align: left;">methodQty</td> <td style="text-align: left;">是</td> <td style="text-align: left;">Integer</td> <td>做法数量,入参使用</td> </tr> </tbody> </table> <p><strong>ThirdOrderPkgCnd</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th>类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">id</td> <td style="text-align: left;">是</td> <td>Long</td> <td>商品ID</td> </tr> <tr> <td style="text-align: left;">name</td> <td style="text-align: left;">是</td> <td>String</td> <td>菜品名称</td> </tr> <tr> <td style="text-align: left;">unitId</td> <td style="text-align: left;">是</td> <td>Long</td> <td>单位id</td> </tr> <tr> <td style="text-align: left;">itemClassId</td> <td style="text-align: left;">是</td> <td>Long</td> <td>分类ID</td> </tr> <tr> <td style="text-align: left;">origPrice</td> <td style="text-align: left;">是</td> <td>Integer</td> <td>原价(分)</td> </tr> <tr> <td style="text-align: left;">lastPrice</td> <td style="text-align: left;">是</td> <td>Integer</td> <td>实收(分)</td> </tr> <tr> <td style="text-align: left;">costPrice</td> <td style="text-align: left;">是</td> <td>Integer</td> <td>成本价 (分)</td> </tr> <tr> <td style="text-align: left;">qty</td> <td style="text-align: left;">是</td> <td>number</td> <td>数量</td> </tr> <tr> <td style="text-align: left;">itemType</td> <td style="text-align: left;">是</td> <td>Integer</td> <td>菜品类型(0、菜品;1、套餐;2、打包盒)</td> </tr> <tr> <td style="text-align: left;">raisePrice</td> <td style="text-align: left;">否</td> <td>Integer</td> <td>套餐加价</td> </tr> <tr> <td style="text-align: left;">methodVoList</td> <td style="text-align: left;">否</td> <td>List&lt;SettlementItemMethodVo&gt;</td> <td>套餐做法列表</td> </tr> </tbody> </table> <p><strong>ThirdOrderPaywayCnd</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th>类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">paywayId</td> <td style="text-align: left;">是</td> <td>Long</td> <td>支付方式ID(1、现金; 2、银行卡; 4、微信;5、支付宝; 8、会员(储值); 9、会员(积分); 10、会员(券))</td> </tr> <tr> <td style="text-align: left;">payMoney</td> <td style="text-align: left;">是</td> <td>Integer</td> <td>支付金额(分)</td> </tr> </tbody> </table> <p><strong>ThirdOrderTicketCnd</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th>类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">id</td> <td style="text-align: left;">是</td> <td>Long</td> <td>劵id</td> </tr> <tr> <td style="text-align: left;">ticketName</td> <td style="text-align: left;">是</td> <td>String</td> <td>劵的名称</td> </tr> <tr> <td style="text-align: left;">fullMoney</td> <td style="text-align: left;">是</td> <td>Integer</td> <td>劵满足多少钱可以使用(分)</td> </tr> <tr> <td style="text-align: left;">offMoney</td> <td style="text-align: left;">是</td> <td>Integer</td> <td>劵减免金额(分)</td> </tr> <tr> <td style="text-align: left;">ticketCount</td> <td style="text-align: left;">是</td> <td>Integer</td> <td>用劵张数</td> </tr> <tr> <td style="text-align: left;">isRecordIncome</td> <td style="text-align: left;">是</td> <td>Boolean</td> <td>是否计入收入</td> </tr> <tr> <td style="text-align: left;">ratio</td> <td style="text-align: left;">是</td> <td>number</td> <td>劵抵扣率</td> <td></td> </tr> </tbody> </table> <p><strong>ThirdOrderCrmTickCnd</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th>类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">couponType</td> <td style="text-align: left;">是</td> <td>Integer</td> <td>券类型</td> </tr> <tr> <td style="text-align: left;">couponCode</td> <td style="text-align: left;">是</td> <td>String</td> <td>券code</td> </tr> <tr> <td style="text-align: left;">couponUseMoney</td> <td style="text-align: left;">是</td> <td>Integer</td> <td>券实际抵扣金额(分)</td> </tr> <tr> <td style="text-align: left;">couponTrueMoney</td> <td style="text-align: left;">是</td> <td>Integer</td> <td>券的实际金额(面值)(分)</td> </tr> <tr> <td style="text-align: left;">couponDiscMoney</td> <td style="text-align: left;">否</td> <td>Integer</td> <td>券优惠金额 (分)</td> </tr> <tr> <td style="text-align: left;">couponName</td> <td style="text-align: left;">否</td> <td>String</td> <td>券名称</td> </tr> <tr> <td style="text-align: left;">couponBuyMoney</td> <td style="text-align: left;">否</td> <td>Integer</td> <td>券购买金额 (分)</td> </tr> </tbody> </table> <p><strong>ThirdOrderMembersCnd</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th>类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">cardNo</td> <td style="text-align: left;">是</td> <td>Long</td> <td>卡号</td> </tr> <tr> <td style="text-align: left;">cardAllMoney</td> <td style="text-align: left;">是</td> <td>Integer</td> <td>会员卡消费总金额(分)</td> </tr> <tr> <td style="text-align: left;">consumeMoney</td> <td style="text-align: left;">是</td> <td>Integer</td> <td>会员卡消费金额 (分)</td> </tr> <tr> <td style="text-align: left;">scoreConverMoney</td> <td style="text-align: left;">是</td> <td>Integer</td> <td>会员卡积分转消费金额(分)</td> </tr> <tr> <td style="text-align: left;">couponUseMoney</td> <td style="text-align: left;">是</td> <td>Integer</td> <td>券的抵用金额(分)</td> </tr> <tr> <td style="text-align: left;">cardType</td> <td style="text-align: left;">否</td> <td>String</td> <td>卡型</td> </tr> <tr> <td style="text-align: left;">cardMoney</td> <td style="text-align: left;">否</td> <td>Integer</td> <td>本次当前的余额(分)</td> </tr> <tr> <td style="text-align: left;">cardScore</td> <td style="text-align: left;">否</td> <td>Integer</td> <td>本次当前的积分 10积分就传10</td> </tr> <tr> <td style="text-align: left;">freeMoney</td> <td style="text-align: left;">否</td> <td>Integer</td> <td>本次赠送金额(分)</td> </tr> <tr> <td style="text-align: left;">mobile</td> <td style="text-align: left;">否</td> <td>String</td> <td>会员电话号</td> </tr> <tr> <td style="text-align: left;">addScore</td> <td style="text-align: left;">否</td> <td>Integer</td> <td>本次产生的积分 10积分就传10</td> </tr> <tr> <td style="text-align: left;">consumeIntegralMoney</td> <td style="text-align: left;">否</td> <td>Integer</td> <td>积分抵扣金额(分)</td> </tr> </tbody> </table> <p><strong>ThirdOrderUserCnd</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th>类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">mobile</td> <td style="text-align: left;">否</td> <td>String</td> <td>用户电话号(非会员)</td> </tr> </tbody> </table> <p><strong>ThirdSettlementActivity</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th>类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">planType</td> <td style="text-align: left;">是</td> <td>Integer</td> <td>优惠活动类型:-2:定额优惠;</td> </tr> <tr> <td style="text-align: left;">discMoney</td> <td style="text-align: left;">否</td> <td>Integer</td> <td>优惠金额 (没有金额时传零)</td> </tr> </tbody> </table> <p><strong>返回示例</strong></p> <pre><code> { &amp;quot;result&amp;quot;: 0, &amp;quot;msg&amp;quot;: &amp;quot;请求成功&amp;quot;, &amp;quot;code&amp;quot;: &amp;quot;0&amp;quot;, &amp;quot;errorMsg&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;data&amp;quot;: &amp;quot;QSdQsLNAUSYthYwEhLzBNSK29kjrpoK7GtA/08Did8LoP2zRsuqM1rv4Glq+RalembMkWWTMFJdoQvyJNtNJ9rixHkTlKUVKfLbp8Q+61Sf1n/goJiHRrCIz6up8kxGIYMYsjGXTcNfao1hxFDh2b924m49jxkvl+r5KdmLAV28=&amp;quot; }</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;">result</td> <td style="text-align: left;">int</td> <td>状态(0-成功,-1-失败)</td> </tr> <tr> <td style="text-align: left;">msg</td> <td style="text-align: left;">String</td> <td>调用成功返回信息)</td> </tr> <tr> <td style="text-align: left;">code</td> <td style="text-align: left;">String</td> <td>调用结果Code</td> </tr> <tr> <td style="text-align: left;">errorMsg</td> <td style="text-align: left;">String</td> <td>错误信息</td> </tr> </tbody> </table> <p><strong>data返回示例</strong></p> <pre><code>{ &amp;quot;result&amp;quot;: 0, &amp;quot;data&amp;quot;: { &amp;quot;bsCode&amp;quot;: &amp;quot;YY15500-9998-210527-0005&amp;quot;, &amp;quot;bsId&amp;quot;: &amp;quot;604718245256507392&amp;quot;, &amp;quot;tsCode&amp;quot;: &amp;quot;JS15500-9998-210527-0005&amp;quot;, &amp;quot;shopId&amp;quot;: 15500, &amp;quot;tsId&amp;quot;: &amp;quot;604718245554302976&amp;quot; } }</code></pre> <p><strong>data失败示例</strong></p> <pre><code>{ &amp;quot;result&amp;quot;: -1, &amp;quot;errorMsg&amp;quot;: &amp;quot;店铺[155,000]不存在,请检查店铺号是否正确,如果店铺号确认无误,请联系管理员!&amp;quot; }</code></pre> <p><strong>返回data说明</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;">result</td> <td style="text-align: left;">int</td> <td>状态(0-成功,-1-失败)</td> </tr> <tr> <td style="text-align: left;">bsCode</td> <td style="text-align: left;">String</td> <td>YY号</td> </tr> <tr> <td style="text-align: left;">bsId</td> <td style="text-align: left;">Long</td> <td>营业流水ID</td> </tr> <tr> <td style="text-align: left;">tsCode</td> <td style="text-align: left;">String</td> <td>JS号</td> </tr> <tr> <td style="text-align: left;">tsId</td> <td style="text-align: left;">Long</td> <td>结算流水ID</td> </tr> <tr> <td style="text-align: left;">shopId</td> <td style="text-align: left;">Integer</td> <td>门店号</td> </tr> <tr> <td style="text-align: left;">errorMsg</td> <td style="text-align: left;">String</td> <td>错误信息</td> </tr> </tbody> </table> <p><strong>备注</strong> </p> <ul> <li>更多返回错误代码请看首页的错误代码描述</li> </ul>

页面列表

ITEM_HTML