丽狮OPEN API

丽狮接口文档


1.1 创建订单

<p><strong>接口描述:</strong> </p> <ul> <li>合作方通过该接口提交订单到丽狮。</li> </ul> <p><strong>请求URL:</strong> </p> <ul> <li><code>/api/Shipment/Create</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> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">msg_type</td> <td style="text-align: left;">string</td> <td style="text-align: left;"></td> <td>是</td> <td>请求类型,固定为“logistics.shipment.create”</td> </tr> <tr> <td style="text-align: left;">logistics_interface</td> <td style="text-align: left;">string</td> <td style="text-align: left;"></td> <td>是</td> <td>接口请求数据Json,由以下参数组成,示例报文中的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>必选</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">logisticsEvent</td> </tr> <tr> <td style="text-align: left;">eventHeader</td> </tr> <tr> <td style="text-align: left;">eventSource</td> <td style="text-align: left;">string</td> <td style="text-align: left;"></td> <td>是</td> <td>合作方ID,平台提供</td> </tr> <tr> <td style="text-align: left;">eventTarget</td> <td style="text-align: left;">string</td> <td style="text-align: left;"></td> <td>是</td> <td>丽狮ID,平台提供</td> </tr> <tr> <td style="text-align: left;">eventTime</td> <td style="text-align: left;">string</td> <td style="text-align: left;"></td> <td>是</td> <td>请求时间</td> </tr> <tr> <td style="text-align: left;">eventType</td> <td style="text-align: left;">string</td> <td style="text-align: left;"></td> <td>是</td> <td>请求类型,固定为“logistics.shipment.create”</td> </tr> <tr> <td style="text-align: left;">eventBody</td> </tr> <tr> <td style="text-align: left;">paymentDetail</td> </tr> <tr> <td style="text-align: left;">payType</td> <td style="text-align: left;">int</td> <td style="text-align: left;"></td> <td>是</td> <td>付款方式:10-现付、20-到付、30-月结</td> </tr> <tr> <td style="text-align: left;">beyongFee</td> <td style="text-align: left;">double</td> <td style="text-align: left;"></td> <td>是</td> <td>超远费</td> </tr> <tr> <td style="text-align: left;">cod</td> <td style="text-align: left;">double</td> <td style="text-align: left;"></td> <td>是</td> <td>代收货款</td> </tr> <tr> <td style="text-align: left;">deliveryFee</td> <td style="text-align: left;">double</td> <td style="text-align: left;"></td> <td>是</td> <td>送货费</td> </tr> <tr> <td style="text-align: left;">otherFee</td> <td style="text-align: left;">double</td> <td style="text-align: left;"></td> <td>是</td> <td>其他费</td> </tr> <tr> <td style="text-align: left;">packingFee</td> <td style="text-align: left;">double</td> <td style="text-align: left;"></td> <td>是</td> <td>包装费</td> </tr> <tr> <td style="text-align: left;">pickFee</td> <td style="text-align: left;">double</td> <td style="text-align: left;"></td> <td>是</td> <td>提货费</td> </tr> <tr> <td style="text-align: left;">shippingFee</td> <td style="text-align: left;">double</td> <td style="text-align: left;"></td> <td>是</td> <td>运费</td> </tr> <tr> <td style="text-align: left;">otherFeeRemark</td> <td style="text-align: left;">double</td> <td style="text-align: left;"></td> <td>否</td> <td>备注</td> </tr> <tr> <td style="text-align: left;">shippingFeeUnit</td> <td style="text-align: left;">double</td> <td style="text-align: left;"></td> <td>否</td> <td>币种</td> </tr> <tr> <td style="text-align: left;">logisticsDetail</td> <td style="text-align: left;">数组</td> </tr> <tr> <td style="text-align: left;">mailNo</td> <td style="text-align: left;">string</td> <td style="text-align: left;"></td> <td>是</td> <td>运单号</td> </tr> <tr> <td style="text-align: left;">occurTime</td> <td style="text-align: left;">string</td> <td style="text-align: left;"></td> <td>是</td> <td>业务日期</td> </tr> <tr> <td style="text-align: left;">shipmentPlaceID</td> <td style="text-align: left;">int</td> <td style="text-align: left;"></td> <td>是</td> <td>发件网点ID</td> </tr> <tr> <td style="text-align: left;">deliveryPlaceID</td> <td style="text-align: left;">int</td> <td style="text-align: left;"></td> <td>是</td> <td>收件网点ID</td> </tr> <tr> <td style="text-align: left;">sender</td> </tr> <tr> <td style="text-align: left;">name</td> <td style="text-align: left;">string</td> <td style="text-align: left;"></td> <td>是</td> <td>发件人姓名</td> </tr> <tr> <td style="text-align: left;">phone</td> <td style="text-align: left;">string</td> <td style="text-align: left;"></td> <td>是</td> <td>发件人手机</td> </tr> <tr> <td style="text-align: left;">mobile</td> <td style="text-align: left;">string</td> <td style="text-align: left;"></td> <td>是</td> <td>发件人电话</td> </tr> <tr> <td style="text-align: left;">province</td> <td style="text-align: left;">string</td> <td style="text-align: left;"></td> <td>是</td> <td>发件人姓省份</td> </tr> <tr> <td style="text-align: left;">city</td> <td style="text-align: left;">string</td> <td style="text-align: left;"></td> <td>是</td> <td>发件人城市</td> </tr> <tr> <td style="text-align: left;">streetAddress</td> <td style="text-align: left;">string</td> <td style="text-align: left;"></td> <td>是</td> <td>发件人地址</td> </tr> <tr> <td style="text-align: left;">zipCode</td> <td style="text-align: left;">string</td> <td style="text-align: left;"></td> <td>是</td> <td>发件人邮编</td> </tr> <tr> <td style="text-align: left;">receiver</td> </tr> <tr> <td style="text-align: left;">name</td> <td style="text-align: left;">string</td> <td style="text-align: left;"></td> <td>是</td> <td>收件人姓名</td> </tr> <tr> <td style="text-align: left;">phone</td> <td style="text-align: left;">string</td> <td style="text-align: left;"></td> <td>是</td> <td>收件人手机</td> </tr> <tr> <td style="text-align: left;">mobile</td> <td style="text-align: left;">string</td> <td style="text-align: left;"></td> <td>是</td> <td>收件人电话</td> </tr> <tr> <td style="text-align: left;">province</td> <td style="text-align: left;">string</td> <td style="text-align: left;"></td> <td>是</td> <td>收件人姓省份</td> </tr> <tr> <td style="text-align: left;">city</td> <td style="text-align: left;">string</td> <td style="text-align: left;"></td> <td>是</td> <td>收件人城市</td> </tr> <tr> <td style="text-align: left;">streetAddress</td> <td style="text-align: left;">string</td> <td style="text-align: left;"></td> <td>是</td> <td>收件人地址</td> </tr> <tr> <td style="text-align: left;">zipCode</td> <td style="text-align: left;">string</td> <td style="text-align: left;"></td> <td>是</td> <td>收件人邮编</td> </tr> <tr> <td style="text-align: left;">itemDetail</td> <td style="text-align: left;">数组</td> </tr> <tr> <td style="text-align: left;">SKU</td> <td style="text-align: left;">string</td> <td style="text-align: left;"></td> <td>是</td> <td>货物子标签</td> </tr> </tbody> </table> <p><strong>请求示例</strong></p> <pre><code>{     &amp;quot;logisticsEvent&amp;quot;: {         &amp;quot;eventHeader&amp;quot;: {             &amp;quot;eventSource&amp;quot;: &amp;quot;16349&amp;quot;,             &amp;quot;eventTarget&amp;quot;: &amp;quot;16348&amp;quot;,             &amp;quot;eventTime&amp;quot;: &amp;quot;2024/7/5 8:58:38&amp;quot;,             &amp;quot;eventType&amp;quot;: &amp;quot;logistics.shipment.create&amp;quot;         },         &amp;quot;eventBody&amp;quot;: {             &amp;quot;paymentDetail&amp;quot;: {                 &amp;quot;payType&amp;quot;: 20,                 &amp;quot;beyongFee&amp;quot;: 0,                 &amp;quot;cod&amp;quot;: 0,                 &amp;quot;deliveryFee&amp;quot;: 0,                 &amp;quot;otherFee&amp;quot;: 0,                 &amp;quot;otherFeeRemark&amp;quot;: &amp;quot;&amp;quot;,                 &amp;quot;packingFee&amp;quot;: 0,                 &amp;quot;pickFee&amp;quot;: 0,                 &amp;quot;shippingFee&amp;quot;: 20,                 &amp;quot;shippingFeeUnit&amp;quot;: &amp;quot;CNY&amp;quot;             },             &amp;quot;logisticsDetail&amp;quot;: [                 {                     &amp;quot;mailNo&amp;quot;: &amp;quot;240704503080&amp;quot;,                     &amp;quot;occurTime&amp;quot;: &amp;quot;2024-07-05 08:57:53&amp;quot;,                     &amp;quot;shipmentPlaceID&amp;quot;: 420101,                     &amp;quot;deliveryPlaceID&amp;quot;: 310000,                     &amp;quot;sender&amp;quot;: {                         &amp;quot;name&amp;quot;: &amp;quot;百和&amp;quot;,                         &amp;quot;phone&amp;quot;: &amp;quot;&amp;quot;,                         &amp;quot;mobile&amp;quot;: &amp;quot;&amp;quot;,                         &amp;quot;province&amp;quot;: &amp;quot;&amp;quot;,                         &amp;quot;city&amp;quot;: &amp;quot;420101&amp;quot;,                         &amp;quot;streetAddress&amp;quot;: &amp;quot;&amp;quot;,                         &amp;quot;zipCode&amp;quot;: &amp;quot;000000&amp;quot;                     },                     &amp;quot;receiver&amp;quot;: {                         &amp;quot;name&amp;quot;: &amp;quot;上海福磊&amp;quot;,                         &amp;quot;phone&amp;quot;: &amp;quot;&amp;quot;,                         &amp;quot;mobile&amp;quot;: &amp;quot;02134682085&amp;quot;,                         &amp;quot;province&amp;quot;: &amp;quot;&amp;quot;,                         &amp;quot;city&amp;quot;: &amp;quot;310000&amp;quot;,                         &amp;quot;streetAddress&amp;quot;: &amp;quot;&amp;quot;,                         &amp;quot;zipCode&amp;quot;: &amp;quot;000000&amp;quot;                     },                     &amp;quot;itemDetail&amp;quot;: [                         {                             &amp;quot;SKU&amp;quot;: &amp;quot;NJ-240704503080-1-1&amp;quot;                         }                     ]                 }             ]         }     } }</code></pre> <p><strong>返回结果</strong></p> <pre><code>{ &amp;quot;isSuccess&amp;quot;: true, &amp;quot;message&amp;quot;: null, &amp;quot;errorCode&amp;quot;: null, &amp;quot;responseCode&amp;quot;: null, &amp;quot;result&amp;quot;: false } { &amp;quot;isSuccess&amp;quot;: false, &amp;quot;message&amp;quot;: &amp;quot;将截断字符串或二进制数据。\r\n语句已终止。&amp;quot;, &amp;quot;errorCode&amp;quot;: null, &amp;quot;responseCode&amp;quot;: null, &amp;quot;result&amp;quot;: false }</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;">isSuccess</td> <td style="text-align: left;">bool</td> <td>接口调用是否成功</td> </tr> <tr> <td style="text-align: left;">errorCode</td> <td style="text-align: left;">string</td> <td>异常代码</td> </tr> <tr> <td style="text-align: left;">message</td> <td style="text-align: left;">string</td> <td>异常消息说明</td> </tr> <tr> <td style="text-align: left;">responseCode</td> <td style="text-align: left;">string</td> <td>响应代码</td> </tr> <tr> <td style="text-align: left;">result</td> <td style="text-align: left;">object</td> <td>该字段用于查询类接口返回数据所用</td> </tr> </tbody> </table> <p><strong>备注</strong> </p> <ul> <li>更多返回错误代码请看首页的错误代码描述</li> </ul>

页面列表

ITEM_HTML