快递时效查询
<p>[TOC]</p>
<h3>简介</h3>
<ul>
<li>买家浏览商品-下单前,根据买家默认地址--商家发货地址计算预计到达时间,减少沟通成本。</li>
<li>购买商品后,在轨迹信息更新中动态显示预计送达时间,减少买家信息差,提升服务体验。注意:历史/已签收单号请勿通过此接口请求。</li>
<li>支持物流:德邦、邮政、京东、极兔速递、顺丰、顺心捷达、申通、韵达、圆通、中通、菜鸟速递(丹鸟)</li>
</ul>
<h3>接口调用说明</h3>
<h4>请求方式</h4>
<p>如接口没有单独说明,所有接口均为:<strong>POST</strong></p>
<p><a name="公共请求参数"></a></p>
<h5>公共请求参数</h5>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>必须</th>
<th><div style="width:420px;">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>appId</td>
<td>String</td>
<td>是</td>
<td>服务商分配的唯一标识</td>
</tr>
<tr>
<td>timestamp</td>
<td>Long</td>
<td>是</td>
<td>当前时间戳(毫秒)</td>
</tr>
<tr>
<td>sign</td>
<td>String</td>
<td>是</td>
<td>签名,详见签名算法说明</td>
</tr>
</tbody>
</table>
<h5>签名算法说明</h5>
<pre><code>sign = sha256(appId + appSecret + timestamp)</code></pre>
<p>用服务商分配的 <strong>appId</strong>、服务商分配的 <strong>appSecret</strong>,当前时间戳(毫秒) <strong>timestamp</strong>,按上述顺序拼接成字符串,再进行 <strong>sha256</strong> 哈希得到。如下:</p>
<pre><code class="language-java">String appId = &quot;xyzxy2121zxyz&quot;;
String timestamp = &quot;1555378976238&quot;;
String appSecret = &quot;efcefcef1121cefcefc1212121&quot;;
String str = appId + appSecret + timestamp;
String sign = sha256(str);</code></pre>
<h4>返回说明</h4>
<h5>公共返回字段说明</h5>
<p>所有接口均返回以下公共字段:</p>
<table>
<thead>
<tr>
<th>字段名</th>
<th><div style="width:430px">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>code</td>
<td>返回码,详见:code返回码说明</td>
</tr>
<tr>
<td>msg</td>
<td>code对应的描述</td>
</tr>
<tr>
<td>charge</td>
<td>计费标志 true为计费,false为不计费</td>
</tr>
<tr>
<td>taskNo</td>
<td>本次请求号</td>
</tr>
<tr>
<td>data</td>
<td>返回具体结果,object类型,详见data返回字段描述</td>
</tr>
</tbody>
</table>
<p><a name="code返回码说明"></a></p>
<table>
<thead>
<tr>
<th>code</th>
<th><div style="width:430px;">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>200</td>
<td>成功</td>
</tr>
<tr>
<td>400</td>
<td>参数错误</td>
</tr>
<tr>
<td>404</td>
<td>接口地址不正确</td>
</tr>
<tr>
<td>500</td>
<td>系统维护,请稍候再试</td>
</tr>
<tr>
<td>601</td>
<td>接口未开通</td>
</tr>
<tr>
<td>602</td>
<td>账号停用</td>
</tr>
<tr>
<td>604</td>
<td>接口停用</td>
</tr>
<tr>
<td>606</td>
<td>调用超限,请稍候再试</td>
</tr>
<tr>
<td>607</td>
<td>ip不在白名单</td>
</tr>
<tr>
<td>609</td>
<td>请求过于频繁,请稍候再试</td>
</tr>
<tr>
<td>610</td>
<td>请求超时</td>
</tr>
<tr>
<td>999</td>
<td>其他,以实际返回为准</td>
</tr>
</tbody>
</table>
<hr />
<h3>发货前查询</h3>
<h4>请求地址</h4>
<p><code>https://api.jumdata.com/express-estimated-delivery/before-transport</code></p>
<h4>请求格式</h4>
<ul>
<li>x-www-form-urlencoded</li>
</ul>
<h4>业务参数</h4>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>必须</th>
<th><div style="width:420px;">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>shipperCode</td>
<td>String</td>
<td>是</td>
<td>快递公司编码,详见快递公司编码</td>
</tr>
<tr>
<td>sendProvince</td>
<td>String</td>
<td>是</td>
<td>始发省</td>
</tr>
<tr>
<td>sendCity</td>
<td>String</td>
<td>是</td>
<td>始发市</td>
</tr>
<tr>
<td>sendArea</td>
<td>String</td>
<td>是</td>
<td>始发区县</td>
</tr>
<tr>
<td>sendAddress</td>
<td>String</td>
<td>否</td>
<td>始发详细地址</td>
</tr>
<tr>
<td>receiveProvince</td>
<td>String</td>
<td>是</td>
<td>目的省</td>
</tr>
<tr>
<td>receiveCity</td>
<td>String</td>
<td>是</td>
<td>目的市</td>
</tr>
<tr>
<td>receiveArea</td>
<td>String</td>
<td>是</td>
<td>目的区县</td>
</tr>
<tr>
<td>receiveAddress</td>
<td>String</td>
<td>否</td>
<td>目的详细地址</td>
</tr>
<tr>
<td>catchTime</td>
<td>String</td>
<td>否</td>
<td>揽收时间,如不传,默认当前时间为揽收时间</td>
</tr>
</tbody>
</table>
<h4>成功返回样例</h4>
<pre><code class="language-json">{
&quot;code&quot;: 200,//返回码,详见返回码说明
&quot;msg&quot;: &quot;成功&quot;,//返回码对应描述
&quot;charge&quot;: true,//计费标志
&quot;taskNo&quot;: &quot;310595155210053618722987&quot;,//本次请求号
&quot;data&quot;: {
&quot;SendProvince&quot;: &quot;浙江省&quot;,//始发省
&quot;ReceiveProvince&quot;: &quot;江苏省&quot;,//目的省
&quot;ShipperCode&quot;: &quot;STO&quot;,//快递公司编码
&quot;Hour&quot;: &quot;24h&quot;,//预计时效
&quot;DeliveryDate&quot;: &quot;2024-11-14&quot;,//预计送达时间
&quot;ReceiveCity&quot;: &quot;南京市&quot;,//目的市
&quot;DeliveryTime&quot;: &quot;11月14日下午可达&quot;,//预计送达时间
&quot;ReceiveArea&quot;: &quot;建邺区&quot;,//目的区县
&quot;ReceiveAddress&quot;: &quot;&quot;,//目的详细地址
&quot;PredictPath&quot;: &quot;浙江杭州转运中心-&gt;江苏南京转运中心&quot;,//预估行驶线路
&quot;SendArea&quot;: &quot;余杭区&quot;,//始发区县
&quot;SendAddress&quot;: &quot;&quot;,//始发详细地址
&quot;SendCity&quot;: &quot;杭州市&quot; //始发市
}
}
</code></pre>
<h4>失败返回样例</h4>
<pre><code class="language-json">{
&quot;code&quot;: 400,
&quot;charge&quot;: false,
&quot;msg&quot;: &quot;快递公司编号不能为空&quot;
}</code></pre>
<hr />
<h3>发货后查询</h3>
<h4>请求地址</h4>
<p><code>https://api.jumdata.com/express-estimated-delivery/after-transport</code></p>
<h4>业务参数</h4>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>必须</th>
<th><div style="width:420px;">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>shipperCode</td>
<td>String</td>
<td>是</td>
<td>快递公司编码,详见快递公司编码</td>
</tr>
<tr>
<td>logisticCode</td>
<td>String</td>
<td>是</td>
<td>快递单号</td>
</tr>
<tr>
<td>sendProvince</td>
<td>String</td>
<td>否</td>
<td>始发省</td>
</tr>
<tr>
<td>sendCity</td>
<td>String</td>
<td>否</td>
<td>始发市</td>
</tr>
<tr>
<td>sendArea</td>
<td>String</td>
<td>否</td>
<td>始发区县</td>
</tr>
<tr>
<td>sendAddress</td>
<td>String</td>
<td>否</td>
<td>始发详细地址</td>
</tr>
<tr>
<td>receiveProvince</td>
<td>String</td>
<td>是</td>
<td>目的省</td>
</tr>
<tr>
<td>receiveCity</td>
<td>String</td>
<td>是</td>
<td>目的市</td>
</tr>
<tr>
<td>receiveArea</td>
<td>String</td>
<td>是</td>
<td>目的区县</td>
</tr>
<tr>
<td>receiveAddress</td>
<td>String</td>
<td>否</td>
<td>目的详细地址</td>
</tr>
<tr>
<td>catchTime</td>
<td>String</td>
<td>否</td>
<td>揽收时间,如不传,默认当前时间为揽收时间</td>
</tr>
<tr>
<td>senderPhone</td>
<td>String</td>
<td>否</td>
<td>寄件人后四位手机尾号,当快递公司为顺丰时,senderPhone、receivePhone必须传一个</td>
</tr>
<tr>
<td>receivePhone</td>
<td>String</td>
<td>否</td>
<td>收件人后四位手机尾号,当快递公司为顺丰时,senderPhone、receivePhone必须传一个</td>
</tr>
</tbody>
</table>
<h4>请求格式</h4>
<ul>
<li>x-www-form-urlencoded</li>
</ul>
<h4>成功返回样例</h4>
<pre><code class="language-json">{
&quot;code&quot;: 200,//返回码,详见返回码说明
&quot;msg&quot;: &quot;成功&quot;,//返回码对应描述
&quot;charge&quot;: true,//计费标志
&quot;taskNo&quot;: &quot;310595155210053618712345&quot;,//本次请求号
&quot;data&quot;: {
&quot;DeliveryMemo&quot;: &quot;预测发起时间:2024-11-13 14:45:45&quot;,//备注
&quot;LogisticCode&quot;: &quot;78854085582018&quot;,//快递单号
&quot;SendProvince&quot;: &quot;浙江省&quot;,//始发省
&quot;ReceiveProvince&quot;: &quot;江苏省&quot;,//目的省
&quot;ShipperCode&quot;: &quot;STO&quot;,//快递公司编码
&quot;Hour&quot;: &quot;24h&quot;,//预计时效
&quot;DeliveryDate&quot;: &quot;2024-11-14&quot;,//预计送达时间
&quot;ReceiveCity&quot;: &quot;南京市&quot;,//目的市
&quot;DeliveryTime&quot;: &quot;11月14日下午可达&quot;,//预计送达时间
&quot;ReceiveArea&quot;: &quot;建邺区&quot;,//目的区县
&quot;ReceiveAddress&quot;: &quot;&quot;,//目的详细地址
&quot;PredictPath&quot;: &quot;浙江杭州转运中心-&gt;江苏南京转运中心&quot;,//预估行驶线路
&quot;SendArea&quot;: &quot;余杭区&quot;,//始发区县
&quot;SendAddress&quot;: &quot;&quot;,//始发详细地址
&quot;SendCity&quot;: &quot;杭州市&quot;, //始发市
&quot;LatestStation&quot;: &quot;xx转运中心&quot;,//最新轨迹发生的站点
&quot;LatestProvince&quot;: &quot;&quot;,//最新所在省份
&quot;LatestCity&quot;: &quot;&quot;,//最新所在城市
&quot;LatestArea&quot;: &quot;&quot;//最新所在区县
}
}
</code></pre>
<h4>失败返回样例</h4>
<pre><code class="language-json">{
&quot;code&quot;: 400,
&quot;msg&quot;: &quot;快递单号不能为空&quot;,
&quot;charge&quot;: false
}</code></pre>
<h3>附录</h3>
<h4>快递公司编号</h4>
<table>
<thead>
<tr>
<th>快递公司</th>
<th>编码</th>
</tr>
</thead>
<tbody>
<tr>
<td>DBL</td>
<td>德邦</td>
</tr>
<tr>
<td>EMS</td>
<td>邮政</td>
</tr>
<tr>
<td>JD</td>
<td>京东</td>
</tr>
<tr>
<td>JTSD</td>
<td>极兔速递</td>
</tr>
<tr>
<td>SF</td>
<td>顺丰</td>
</tr>
<tr>
<td>SX</td>
<td>顺心捷达</td>
</tr>
<tr>
<td>STO</td>
<td>申通</td>
</tr>
<tr>
<td>YD</td>
<td>韵达</td>
</tr>
<tr>
<td>YTO</td>
<td>圆通</td>
</tr>
<tr>
<td>ZTO</td>
<td>中通</td>
</tr>
<tr>
<td>CNSD</td>
<td>菜鸟速递(丹鸟)</td>
</tr>
</tbody>
</table>