【顺丰快递管家】通用接口文档


5.获取订单详情接口

<h3>功能描述</h3> <ul> <li>查询订单全量信息,包含下单信息、状态信息、订单执行信息等,最多支持查20条。</li> <li>注意:图片或视频信息不包含在该接口中,需要通过接口 批量获取订单图片/视频签名地址接口获取。</li> </ul> <h3>接口定义</h3> <table> <thead> <tr> <th style="text-align: center;">服务名称</th> <th style="text-align: center;">批量交易</th> <th style="text-align: center;">接口类型</th> <th style="text-align: center;">接口uri</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;">获取订单详情</td> <td style="text-align: center;">支持(20)</td> <td style="text-align: center;">接入/POST</td> <td style="text-align: center;">/public/vpOrder/queryOrderDetail</td> </tr> </tbody> </table> <h3>元素&lt;请求&gt;</h3> <table> <thead> <tr> <th style="text-align: center;">#</th> <th style="text-align: center;">字段名</th> <th style="text-align: center;">类型(约束)</th> <th style="text-align: center;">必填</th> <th style="text-align: center;">描述</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;">1</td> <td style="text-align: center;">companyId</td> <td style="text-align: center;">String(64)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">分配appId</td> </tr> <tr> <td style="text-align: center;">2</td> <td style="text-align: center;">merchantOrderNos</td> <td style="text-align: center;">List&lt;String&gt;</td> <td style="text-align: center;">是</td> <td style="text-align: center;">订单号</td> </tr> </tbody> </table> <h3>元素&lt;响应&gt;</h3> <table> <thead> <tr> <th style="text-align: center;">#</th> <th style="text-align: center;">字段名</th> <th style="text-align: center;">类型(约束)</th> <th style="text-align: center;">必填</th> <th style="text-align: center;">描述</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;">1</td> <td style="text-align: center;">msg</td> <td style="text-align: center;">String (200)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">提示信息</td> </tr> <tr> <td style="text-align: center;">2</td> <td style="text-align: center;">succ</td> <td style="text-align: center;">String (10)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">状态码,返回成功或失败信息(ok/fail)</td> </tr> <tr> <td style="text-align: center;">3</td> <td style="text-align: center;">result</td> <td style="text-align: center;">List</td> <td style="text-align: center;">是</td> <td style="text-align: center;">数据</td> </tr> <tr> <td style="text-align: center;">-orderType</td> <td style="text-align: center;">String(32)</td> <td style="text-align: center;">订单类型</td> </tr> <tr> <td style="text-align: center;">-monthlyCardNo</td> <td style="text-align: center;">String(32)</td> <td style="text-align: center;">月结卡号</td> </tr> <tr> <td style="text-align: center;">-assignerCode</td> <td style="text-align: center;">String(32)</td> <td style="text-align: center;">接单人工号</td> </tr> <tr> <td style="text-align: center;">-orderBizState</td> <td style="text-align: center;">String(32)</td> <td style="text-align: center;">下单完成子状态</td> </tr> <tr> <td style="text-align: center;">-supportValue</td> <td style="text-align: center;">String(32)</td> <td style="text-align: center;">保价金额</td> </tr> <tr> <td style="text-align: center;">-orderState</td> <td style="text-align: center;">String(32)</td> <td style="text-align: center;">下单完成状态</td> </tr> <tr> <td style="text-align: center;">-ordertime</td> <td style="text-align: center;">String(32)</td> <td style="text-align: center;">下单时间</td> </tr> <tr> <td style="text-align: center;">-payMethod</td> <td style="text-align: center;">String(32)</td> <td style="text-align: center;">付款方式</td> </tr> <tr> <td style="text-align: center;">-destcode</td> <td style="text-align: center;">String(32)</td> <td style="text-align: center;">目的地区域代码</td> </tr> <tr> <td style="text-align: center;">-assignerMobile</td> <td style="text-align: center;">String(32)</td> <td style="text-align: center;">接单人手机号</td> </tr> <tr> <td style="text-align: center;">-merchantCode</td> <td style="text-align: center;">String(32)</td> <td style="text-align: center;">商户编码</td> </tr> <tr> <td style="text-align: center;">-orderNo</td> <td style="text-align: center;">String(32)</td> <td style="text-align: center;">微派订单号</td> </tr> <tr> <td style="text-align: center;">-payLoad</td> <td style="text-align: center;">json</td> <td style="text-align: center;">扩展字段,根据业务的配置响应,按照和微派约定字段取值</td> </tr> <tr> <td style="text-align: center;">--expectEndTime</td> <td style="text-align: center;">String(20)</td> <td style="text-align: center;">预计任务结束时间</td> </tr> <tr> <td style="text-align: center;">--expectStartTime</td> <td style="text-align: center;">String(20)</td> <td style="text-align: center;">预计任开始时间</td> </tr> <tr> <td style="text-align: center;">--cityCode</td> <td style="text-align: center;">String(32)</td> <td style="text-align: center;">城市编码</td> </tr> <tr> <td style="text-align: center;">--processAuditFieldCodes</td> <td style="text-align: center;">json</td> <td style="text-align: center;">【产品配置】需审核取证项编码</td> </tr> <tr> <td style="text-align: center;">-dCompany</td> <td style="text-align: center;">String(255)</td> <td style="text-align: center;">收件公司</td> </tr> <tr> <td style="text-align: center;">-dContact</td> <td style="text-align: center;">String(255)</td> <td style="text-align: center;">收件人</td> </tr> <tr> <td style="text-align: center;">-dTel</td> <td style="text-align: center;">String(64)</td> <td style="text-align: center;">收件电话</td> </tr> <tr> <td style="text-align: center;">-dMobile</td> <td style="text-align: center;">String(64)</td> <td style="text-align: center;">收件手机</td> </tr> <tr> <td style="text-align: center;">-dAddress</td> <td style="text-align: center;">String(1024)</td> <td style="text-align: center;">收件详细地址</td> </tr> <tr> <td style="text-align: center;">-jCompany</td> <td style="text-align: center;">String(255)</td> <td style="text-align: center;">寄件公司</td> </tr> <tr> <td style="text-align: center;">-jContact</td> <td style="text-align: center;">String(255)</td> <td style="text-align: center;">寄件人</td> </tr> <tr> <td style="text-align: center;">-jTel</td> <td style="text-align: center;">String(64)</td> <td style="text-align: center;">寄件电话</td> </tr> <tr> <td style="text-align: center;">-jAddresse</td> <td style="text-align: center;">String(1024)</td> <td style="text-align: center;">寄件详细地址</td> </tr> <tr> <td style="text-align: center;">-depositumInfo</td> <td style="text-align: center;">String(255)</td> <td style="text-align: center;">托寄物内容</td> </tr> <tr> <td style="text-align: center;">-depositumNo</td> <td style="text-align: center;">String(100)</td> <td style="text-align: center;">托寄物数量</td> </tr> <tr> <td style="text-align: center;">-parcelWeighs</td> <td style="text-align: center;">String(8)</td> <td style="text-align: center;">包裹重量(kg)</td> </tr> <tr> <td style="text-align: center;">-status</td> <td style="text-align: center;">String(100)</td> <td style="text-align: center;">微派订单服务状态(详见附录)</td> </tr> <tr> <td style="text-align: center;">-productExtraField</td> <td style="text-align: center;">json</td> <td style="text-align: center;">扩展字段,客户自定义字段展示</td> </tr> <tr> <td style="text-align: center;">--verifyCode</td> <td style="text-align: center;">String(100)</td> <td style="text-align: center;">核销码</td> </tr> <tr> <td style="text-align: center;">-sendStatus</td> <td style="text-align: center;">String(32)</td> <td style="text-align: center;">物流状态</td> </tr> <tr> <td style="text-align: center;">-mailNo</td> <td style="text-align: center;">String(32)</td> <td style="text-align: center;">运单号</td> </tr> <tr> <td style="text-align: center;">-printMsg</td> <td style="text-align: center;">json</td> <td style="text-align: center;">面单打印信息</td> </tr> <tr> <td style="text-align: center;">-productCode</td> <td style="text-align: center;">String(32)</td> <td style="text-align: center;">产品编码</td> </tr> </tbody> </table> <h3>报文范例</h3> <ul> <li> <p><strong>请求报文</strong></p> <pre><code>{     &amp;quot;companyId&amp;quot;:xxx,     &amp;quot;merchantOrderNos&amp;quot;: [         &amp;quot;9413a33bc6dd4759beece59e7d9f6b40&amp;quot;     ] }</code></pre> </li> <li><strong>响应报文</strong> <ul> <li>成功报文 <pre><code>{     &amp;quot;result&amp;quot;: [         {             &amp;quot;orderType&amp;quot;: &amp;quot;仅服务&amp;quot;,             &amp;quot;monthlyCardNo&amp;quot;: &amp;quot;9999999999&amp;quot;,             &amp;quot;assignerCode&amp;quot;: &amp;quot;&amp;quot;,             &amp;quot;orderBizState&amp;quot;: &amp;quot;丰先生下单处理成功&amp;quot;,             &amp;quot;orderState&amp;quot;: &amp;quot;下单成功&amp;quot;,             &amp;quot;modifyTime&amp;quot;: 1713492759000,             &amp;quot;orderTime&amp;quot;: &amp;quot;2024-04-19 10:12:39&amp;quot;,             &amp;quot;price&amp;quot;: &amp;quot;&amp;quot;,             &amp;quot;id&amp;quot;: 1649836,             &amp;quot;isNeedAudit&amp;quot;: 0,             &amp;quot;assignerMobile&amp;quot;: &amp;quot;&amp;quot;,             &amp;quot;merchantCode&amp;quot;: &amp;quot;B2021060004-0001&amp;quot;,             &amp;quot;batchNo&amp;quot;: null,             &amp;quot;orderNo&amp;quot;: &amp;quot;WPU24041918912222&amp;quot;,             &amp;quot;payLoad&amp;quot;: {                 &amp;quot;processAuditFieldCodes&amp;quot;: [                     &amp;quot;takePhotoList_ext1&amp;quot;                 ],                 &amp;quot;verifyCode&amp;quot;: {                     &amp;quot;code&amp;quot;: &amp;quot;verifyCode&amp;quot;,                     &amp;quot;type&amp;quot;: &amp;quot;SCAN_VERIFY&amp;quot;,                     &amp;quot;verifyCodes&amp;quot;: [                         &amp;quot;202404031111&amp;quot;                     ]                 },                 &amp;quot;contactInfo_name&amp;quot;: &amp;quot;测试单&amp;quot;,                 &amp;quot;expectEndTime&amp;quot;: &amp;quot;2024-05-04 10:12:39&amp;quot;,                 &amp;quot;expectStartTime&amp;quot;: &amp;quot;2024-04-19 10:12:39&amp;quot;,                 &amp;quot;cityCode&amp;quot;: &amp;quot;755&amp;quot;,                 &amp;quot;serviceAddress&amp;quot;: {                     &amp;quot;address_county&amp;quot;: &amp;quot;南山区&amp;quot;,                     &amp;quot;address_detail&amp;quot;: &amp;quot;粤海街道海阔天空雅居B栋16B&amp;quot;,                     &amp;quot;address_province&amp;quot;: &amp;quot;广东省&amp;quot;,                     &amp;quot;address_all&amp;quot;: &amp;quot;广东省深圳市南山区粤海街道海阔天空雅居B栋16B&amp;quot;,                     &amp;quot;address_city&amp;quot;: &amp;quot;深圳市&amp;quot;                 },                 &amp;quot;settlementColour&amp;quot;: false,                 &amp;quot;sgsTaskBindFlag&amp;quot;: true,                 &amp;quot;swsChannel&amp;quot;: true,                 &amp;quot;takePhotoItems&amp;quot;: [                     {                         &amp;quot;code&amp;quot;: &amp;quot;takePhotoList_ext1&amp;quot;,                         &amp;quot;name&amp;quot;: &amp;quot;体现重量及全部二维码&amp;quot;                     }                 ],                 &amp;quot;contactInfo_phone&amp;quot;: &amp;quot;18732193913&amp;quot;,                 &amp;quot;sgsTaskType&amp;quot;: &amp;quot;P00&amp;quot;,                 &amp;quot;shivaOmsSendFlag&amp;quot;: true,                 &amp;quot;irAuditFlag&amp;quot;: &amp;quot;NOY_HAVE&amp;quot;,                 &amp;quot;contactInfo_mobile&amp;quot;: &amp;quot;18732193913&amp;quot;,                 &amp;quot;isWesign&amp;quot;: false,                 &amp;quot;exceptionAuditFieldCodes&amp;quot;: [                     &amp;quot;exceptionSubmitLabel&amp;quot;                 ],                 &amp;quot;verifyCode1&amp;quot;: {                     &amp;quot;code&amp;quot;: &amp;quot;verifyCode1&amp;quot;,                     &amp;quot;type&amp;quot;: &amp;quot;SCAN_VERIFY&amp;quot;,                     &amp;quot;verifyCodes&amp;quot;: [                         &amp;quot;32.28&amp;quot;                     ]                 },                 &amp;quot;orderScene&amp;quot;: &amp;quot;8&amp;quot;             },             &amp;quot;jAddress&amp;quot;: null,             &amp;quot;exceptionCheckCount&amp;quot;: &amp;quot;1&amp;quot;,             &amp;quot;completeTime&amp;quot;: null,             &amp;quot;exportCount&amp;quot;: &amp;quot;0&amp;quot;,             &amp;quot;dCompany&amp;quot;: null,             &amp;quot;merchantOrderNo&amp;quot;: &amp;quot;kdgjtest1713492757&amp;quot;,             &amp;quot;raexMonthlyCardNo&amp;quot;: null,             &amp;quot;packagesNo&amp;quot;: 1,             &amp;quot;sequence&amp;quot;: 1,             &amp;quot;creatorUser&amp;quot;: &amp;quot;13988776633&amp;quot;,             &amp;quot;dAddress&amp;quot;: &amp;quot;南山区粤海街道海阔天空雅居B栋16B&amp;quot;,             &amp;quot;orderCheckCount&amp;quot;: &amp;quot;1&amp;quot;,             &amp;quot;dMobile&amp;quot;: &amp;quot;18732193913&amp;quot;,             &amp;quot;isSelfGet&amp;quot;: null,             &amp;quot;dTel&amp;quot;: &amp;quot;18732193913&amp;quot;,             &amp;quot;verifyCode1&amp;quot;: null,             &amp;quot;modifierUser&amp;quot;: &amp;quot;mq消息修改数据&amp;quot;,             &amp;quot;status&amp;quot;: &amp;quot;待接单&amp;quot;,             &amp;quot;statusCode&amp;quot;: &amp;quot;0&amp;quot;,             &amp;quot;assignDeptName&amp;quot;: &amp;quot;&amp;quot;,             &amp;quot;rewardAmt&amp;quot;: 0.0,             &amp;quot;remark&amp;quot;: &amp;quot;测试单&amp;quot;,             &amp;quot;raexTel&amp;quot;: null,             &amp;quot;mailNo&amp;quot;: &amp;quot;SF1030412238580&amp;quot;,             &amp;quot;printCount&amp;quot;: 0,             &amp;quot;productExtraField&amp;quot;: &amp;quot;{\&amp;quot;businessFrom\&amp;quot;:\&amp;quot;快递+快递管家\&amp;quot;,\&amp;quot;orderScene\&amp;quot;:8,\&amp;quot;settlementColour\&amp;quot;:false,\&amp;quot;settlementChannel\&amp;quot;:\&amp;quot;sws\&amp;quot;}&amp;quot;,             &amp;quot;assignDeptCode&amp;quot;: &amp;quot;&amp;quot;,             &amp;quot;messageVersion&amp;quot;: 1,             &amp;quot;jTel&amp;quot;: null,             &amp;quot;assignerName&amp;quot;: &amp;quot;&amp;quot;,             &amp;quot;verifyCode&amp;quot;: null,             &amp;quot;isPunchIn&amp;quot;: 0,             &amp;quot;fxOrderNo&amp;quot;: &amp;quot;FX24041918912237&amp;quot;,             &amp;quot;isPrint&amp;quot;: &amp;quot;0&amp;quot;,             &amp;quot;printMsg&amp;quot;: {                 &amp;quot;modifyTm&amp;quot;: null,                 &amp;quot;proCode&amp;quot;: &amp;quot;&amp;quot;,                 &amp;quot;orderId&amp;quot;: &amp;quot;&amp;quot;,                 &amp;quot;codingMapping&amp;quot;: &amp;quot;&amp;quot;,                 &amp;quot;errMsg&amp;quot;: &amp;quot;&amp;quot;,                 &amp;quot;destRouteLabel&amp;quot;: &amp;quot;&amp;quot;,                 &amp;quot;limitTypeCode&amp;quot;: &amp;quot;&amp;quot;,                 &amp;quot;sourceCityCode&amp;quot;: &amp;quot;&amp;quot;,                 &amp;quot;destPortCode&amp;quot;: &amp;quot;&amp;quot;,                 &amp;quot;destCityCode&amp;quot;: &amp;quot;&amp;quot;,                 &amp;quot;newIcon&amp;quot;: &amp;quot;&amp;quot;,                 &amp;quot;mailNo&amp;quot;: &amp;quot;&amp;quot;,                 &amp;quot;destTeamCode&amp;quot;: &amp;quot;&amp;quot;,                 &amp;quot;modifyTime&amp;quot;: null,                 &amp;quot;createTm&amp;quot;: null,                 &amp;quot;goodsNumber&amp;quot;: &amp;quot;&amp;quot;,                 &amp;quot;codingMappingOut&amp;quot;: &amp;quot;&amp;quot;,                 &amp;quot;printIcon&amp;quot;: &amp;quot;&amp;quot;,                 &amp;quot;id&amp;quot;: 0,                 &amp;quot;proName&amp;quot;: &amp;quot;&amp;quot;,                 &amp;quot;sourceTeamCode&amp;quot;: &amp;quot;&amp;quot;,                 &amp;quot;destDeptCodeMapping&amp;quot;: &amp;quot;&amp;quot;,                 &amp;quot;twoDimensionCode&amp;quot;: &amp;quot;&amp;quot;,                 &amp;quot;abFlag&amp;quot;: &amp;quot;&amp;quot;,                 &amp;quot;printFlag&amp;quot;: &amp;quot;&amp;quot;,                 &amp;quot;currencySymbol&amp;quot;: &amp;quot;&amp;quot;,                 &amp;quot;goodsValueTotal&amp;quot;: &amp;quot;&amp;quot;,                 &amp;quot;sourceDeptCode&amp;quot;: &amp;quot;&amp;quot;,                 &amp;quot;cargoTypeCode&amp;quot;: &amp;quot;&amp;quot;,                 &amp;quot;destCountry&amp;quot;: &amp;quot;&amp;quot;,                 &amp;quot;destDeptCode&amp;quot;: &amp;quot;&amp;quot;,                 &amp;quot;createTime&amp;quot;: null,                 &amp;quot;creatorUser&amp;quot;: &amp;quot;&amp;quot;,                 &amp;quot;sourceTransferCode&amp;quot;: &amp;quot;&amp;quot;,                 &amp;quot;destTransferCode&amp;quot;: &amp;quot;&amp;quot;,                 &amp;quot;destTeamCodeMapping&amp;quot;: &amp;quot;&amp;quot;,                 &amp;quot;expressTypeCode&amp;quot;: &amp;quot;&amp;quot;,                 &amp;quot;xbFlag&amp;quot;: &amp;quot;&amp;quot;,                 &amp;quot;destPostCode&amp;quot;: &amp;quot;&amp;quot;,                 &amp;quot;modifierUser&amp;quot;: &amp;quot;&amp;quot;             },             &amp;quot;raexMobile&amp;quot;: null,             &amp;quot;productCode&amp;quot;: &amp;quot;pre-pickup-01763&amp;quot;,             &amp;quot;createTime&amp;quot;: 1713492758000,             &amp;quot;dContact&amp;quot;: &amp;quot;测试单&amp;quot;,             &amp;quot;sendStatus&amp;quot;: &amp;quot;4&amp;quot;,             &amp;quot;raexAddress&amp;quot;: null,             &amp;quot;orderTip&amp;quot;: null         }     ],     &amp;quot;succ&amp;quot;: &amp;quot;ok&amp;quot;,     &amp;quot;msg&amp;quot;: null,     &amp;quot;extendResult&amp;quot;: null }</code></pre></li> <li>失败报文-范例1 <pre><code>{ &amp;quot;msg&amp;quot;:&amp;quot;订单不存在&amp;quot;, &amp;quot;result&amp;quot;: null, &amp;quot;succ&amp;quot;: &amp;quot;fail&amp;quot; }</code></pre></li> <li>失败报文-范例2 <pre><code>{ &amp;quot;msg&amp;quot;:&amp;quot;微派订单信息不存在&amp;quot;, &amp;quot;result&amp;quot;: null, &amp;quot;succ&amp;quot;: &amp;quot;fail&amp;quot; }</code></pre></li> </ul></li> </ul>

页面列表

ITEM_HTML