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


25.查询订单状态接口

<h3>功能描述</h3> <ul> <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;">不支持</td> <td style="text-align: center;">接入/POST</td> <td style="text-align: center;">/public/order/v1/state/list</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> <th style="text-align: left;">描述</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;">1</td> <td style="text-align: center;">companyId</td> <td style="text-align: center;">Long</td> <td style="text-align: center;">是</td> <td style="text-align: center;">分配客户sendAppId</td> </tr> <tr> <td style="text-align: center;">2</td> <td style="text-align: center;">orderNo</td> <td style="text-align: center;">String</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> <th style="text-align: left;">描述</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> <td style="text-align: left;">提示信息</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;">状态码</td> <td style="text-align: left;">返回成功或失败信息(ok/fail)</td> </tr> <tr> <td style="text-align: center;">3</td> <td style="text-align: center;">result</td> <td style="text-align: center;">String(/)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">数据</td> <td style="text-align: left;">数据</td> </tr> <tr> <td style="text-align: center;">4</td> <td style="text-align: center;">orderStateDesc</td> <td style="text-align: center;">String</td> <td style="text-align: center;">是</td> <td style="text-align: center;">值</td> <td style="text-align: left;">订单状态描述</td> </tr> <tr> <td style="text-align: center;">5</td> <td style="text-align: center;">empCode</td> <td style="text-align: center;">String</td> <td style="text-align: center;">是</td> <td style="text-align: center;">值</td> <td style="text-align: left;">收件员工工号</td> </tr> <tr> <td style="text-align: center;">6</td> <td style="text-align: center;">empCode</td> <td style="text-align: center;">String</td> <td style="text-align: center;">是</td> <td style="text-align: center;">值</td> <td style="text-align: left;">收派员电话</td> </tr> <tr> <td style="text-align: center;">7</td> <td style="text-align: center;">stateCreateTime</td> <td style="text-align: center;">String</td> <td style="text-align: center;">是</td> <td style="text-align: center;">值</td> <td style="text-align: left;">状态创建时间</td> </tr> </tbody> </table> <h3>报文范例</h3> <ul> <li> <p><strong>请求报文</strong></p> <pre><code>{ &amp;quot;companyId&amp;quot;: 201905140011021,      &amp;quot;orderNo&amp;quot;: &amp;quot;d0a830a936d440a3b948d2167f84f8ef&amp;quot; }</code></pre> </li> <li><strong>响应报文</strong> <ul> <li>成功报文 <pre><code>{      &amp;quot;result&amp;quot;: [          {              &amp;quot;orderStateDesc&amp;quot;: &amp;quot;调度成功,收派员信息&amp;quot;,              &amp;quot;empCode&amp;quot;: &amp;quot;845215&amp;quot;,              &amp;quot;empPhone&amp;quot;: &amp;quot;&amp;quot;,              &amp;quot;stateCreateTime&amp;quot;: &amp;quot;2018-04-17 15:23:24&amp;quot;          },          {              &amp;quot;orderStateDesc&amp;quot;: &amp;quot;调度成功,收派员信息&amp;quot;,              &amp;quot;empCode&amp;quot;: &amp;quot;845215&amp;quot;,              &amp;quot;empPhone&amp;quot;: &amp;quot;&amp;quot;,              &amp;quot;stateCreateTime&amp;quot;: &amp;quot;2018-04-17 15:23:24&amp;quot;          },          {              &amp;quot;orderStateDesc&amp;quot;: &amp;quot;调度成功,收派员信息&amp;quot;,              &amp;quot;empCode&amp;quot;: &amp;quot;845215&amp;quot;,              &amp;quot;empPhone&amp;quot;: &amp;quot;&amp;quot;,              &amp;quot;stateCreateTime&amp;quot;: &amp;quot;2018-04-17 15:23:24&amp;quot;          },          {              &amp;quot;orderStateDesc&amp;quot;: &amp;quot;调度成功,收派员信息&amp;quot;,              &amp;quot;empCode&amp;quot;: &amp;quot;845215&amp;quot;,              &amp;quot;empPhone&amp;quot;: &amp;quot;&amp;quot;,              &amp;quot;stateCreateTime&amp;quot;: &amp;quot;2018-04-17 15:23:24&amp;quot;          },          {              &amp;quot;orderStateDesc&amp;quot;: &amp;quot;调度成功,收派员信息&amp;quot;,              &amp;quot;empCode&amp;quot;: &amp;quot;845215&amp;quot;,              &amp;quot;empPhone&amp;quot;: &amp;quot;&amp;quot;,              &amp;quot;stateCreateTime&amp;quot;: &amp;quot;2018-04-17 15:23:24&amp;quot;          },          {              &amp;quot;orderStateDesc&amp;quot;: &amp;quot;调度成功,收派员信息&amp;quot;,              &amp;quot;empCode&amp;quot;: &amp;quot;845215&amp;quot;,              &amp;quot;empPhone&amp;quot;: &amp;quot;&amp;quot;,              &amp;quot;stateCreateTime&amp;quot;: &amp;quot;2018-04-17 15:23:24&amp;quot;          }      ],      &amp;quot;succ&amp;quot;: &amp;quot;ok&amp;quot;,      &amp;quot;msg&amp;quot;: null }</code></pre></li> <li>失败报文-范例 <pre><code>{ &amp;quot;result&amp;quot;: null, &amp;quot;succ&amp;quot;: &amp;quot;fail&amp;quot;, &amp;quot;msg&amp;quot;: &amp;quot;请求失败,请重试&amp;quot; }</code></pre></li> </ul></li> </ul>

页面列表

ITEM_HTML