快递上门取件
<p>[TOC]</p>
<h3>简介</h3>
<ul>
<li>寄送快递时，通过接口预约快递员取件，或者取消取件预约。</li>
</ul>
<h3>接口调用说明</h3>
<h4>请求方式</h4>
<p>如接口没有单独说明，所有接口均为：<strong>POST</strong></p>
<h4>请求格式</h4>
<p>如接口没有单独说明，所有接口均为：<strong>application/form-data</strong></p>
<h4>请求参数</h4>
<p>请求参数包括公共参数和业务参数（业务参数见具体接口说明）
如果请求格式为application/x-www-form-urlencoded的，需要把<strong>公共参数</strong>和<strong>业务参数</strong>一并放在<strong>请求参数</strong>中提交
如果请求格式为application/json的，需要把<strong>公共参数</strong>放在<strong>请求Header</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:420px">说明</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:420px;">说明</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>
<ul>
<li>提供收件人信息、寄件人信息、商品信息等，预约快递员上门取件。</li>
</ul>
<h4>请求地址</h4>
<p><code>https://api.jumdata.com/express-order/send</code></p>
<h4>请求格式</h4>
<ul>
<li>application/json</li>
</ul>
<h4>业务参数</h4>
<ul>
<li>样例</li>
</ul>
<pre><code class="language-json">{
&quot;shipperCode&quot;: &quot;快递公司编码&quot;,
&quot;payType&quot;: 3,
&quot;commodity&quot;: [
{
&quot;goodsPrice&quot;: 49.0,
&quot;goodsPicUrl&quot;: &quot;https://xxx.jpg&quot;,
&quot;goodsQuantity&quot;: 1,
&quot;goodsCode&quot;: &quot;ABC&quot;,
&quot;goodsName&quot;: &quot;男鞋&quot;,
&quot;goodsWeight&quot;: 1.0
}
],
&quot;quantity&quot;: 1,
&quot;receiver&quot;: {
&quot;address&quot;: &quot;仓前街道爱力中心1幢307A室&quot;,
&quot;cityName&quot;: &quot;杭州市&quot;,
&quot;expAreaName&quot;: &quot;余杭区&quot;,
&quot;mobile&quot;: &quot;15126xxxxxx&quot;,
&quot;name&quot;: &quot;李四&quot;,
&quot;provinceName&quot;: &quot;浙江省&quot;
},
&quot;weight&quot;: 1.0,
&quot;insureAmount&quot;: 3000.00,
&quot;remark&quot;: &quot;贵重物品，轻拿轻放&quot;,
&quot;startDate&quot;: &quot;2023-02-09 09:00:00&quot;,
&quot;endDate&quot;: &quot;2023-02-09 11:00:00&quot;,
&quot;actualPaymentAmount&quot;: 55.0,
&quot;sender&quot;: {
&quot;address&quot;: &quot;滨河西路中天府6栋503&quot;,
&quot;cityName&quot;: &quot;杭州市&quot;,
&quot;expAreaName&quot;: &quot;临安区&quot;,
&quot;mobile&quot;: &quot;18126xxxxxx&quot;,
&quot;name&quot;: &quot;张三&quot;,
&quot;provinceName&quot;: &quot;浙江省&quot;
}
}
</code></pre>
<p>参数说明</p>
<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>快递公司编码，可选值：<br/>顺丰速运 - SF<br/>京东物流 - JD<br/>中通快递 - ZTO<br/>圆通速递 - YTO<br/>韵达速递 - YD<br/>德邦快递 - DBL<br/>申通快递 - STO<br/>极兔速递 - JTSD<br/>丹鸟 - DNWL<br/>邮政速递 - EMS<br/>菜鸟速递 - CNSD<br/>菜鸟裹裹 - CAINIAO<br/></td>
</tr>
<tr>
<td>payType</td>
<td>String</td>
<td>是</td>
<td>运费支付方式：3 - 月结</td>
</tr>
<tr>
<td>receiver.company</td>
<td>String</td>
<td>否</td>
<td>收件人公司</td>
</tr>
<tr>
<td>receiver.name</td>
<td>String</td>
<td>是</td>
<td>收件人</td>
</tr>
<tr>
<td>receiver.tel</td>
<td>String</td>
<td>否</td>
<td>电话，电话与手机必填一个</td>
</tr>
<tr>
<td>receiver.mobile</td>
<td>String</td>
<td>否</td>
<td>手机，电话与手机必填一个</td>
</tr>
<tr>
<td>receiver.provinceName</td>
<td>String</td>
<td>是</td>
<td>收件省(如广东省，不要缺少“省”；如是直辖市，请直接传北京、上海等；如是自治区，请直接传广西壮族自治区等)</td>
</tr>
<tr>
<td>receiver.cityName</td>
<td>String</td>
<td>是</td>
<td>收件市(如深圳市，不要缺少“市；如是市辖区，请直接传北京市、上海市等”)</td>
</tr>
<tr>
<td>receiver.expAreaName</td>
<td>String</td>
<td>是</td>
<td>收件区/县(如福田区，不要缺少“区”或“县”)</td>
</tr>
<tr>
<td>receiver.address</td>
<td>String</td>
<td>是</td>
<td>收件人详细地址(不用传省市区)</td>
</tr>
<tr>
<td>sender.company</td>
<td>String</td>
<td>否</td>
<td>发件人公司</td>
</tr>
<tr>
<td>sender.name</td>
<td>String</td>
<td>是</td>
<td>发件人</td>
</tr>
<tr>
<td>sender.tel</td>
<td>String</td>
<td>否</td>
<td>电话，电话与手机必填一个</td>
</tr>
<tr>
<td>sender.mobile</td>
<td>String</td>
<td>否</td>
<td>手机，电话与手机必填一个</td>
</tr>
<tr>
<td>sender.provinceName</td>
<td>String</td>
<td>是</td>
<td>发件省(如广东省，不要缺少“省”；如是直辖市，请直接传北京、上海等；如是自治区，请直接传广西壮族自治区等)</td>
</tr>
<tr>
<td>sender.cityName</td>
<td>String</td>
<td>是</td>
<td>发件市(如深圳市，不要缺少“市；如是市辖区，请直接传北京市、上海市等”)</td>
</tr>
<tr>
<td>sender.expAreaName</td>
<td>String</td>
<td>是</td>
<td>发件区/县(如福田区，不要缺少“区”或“县”)</td>
</tr>
<tr>
<td>sender.address</td>
<td>String</td>
<td>是</td>
<td>发件人详细地址(不用传省市区)</td>
</tr>
<tr>
<td>startDate</td>
<td>String</td>
<td>否</td>
<td>预约开始时间，格式：2023-01-01 17:00:00，如不传则系统默认分配最近时间上门取件</td>
</tr>
<tr>
<td>endDate</td>
<td>String</td>
<td>否</td>
<td>预约结束时间，格式：2023-01-01 18:00:00，如不传则系统默认分配最近时间上门取件</td>
</tr>
<tr>
<td>weight</td>
<td>String</td>
<td>否</td>
<td>包裹总重量kg</br/>德邦：0-60kg，峰值可达300kg</br/>顺丰：0-60kg，峰值可达300kg</br/>京东：0-30kg圆通：0-60kg</br/>申通：30kg韵达：50kg</br/>中通：50kg极兔：30kg</td>
</tr>
<tr>
<td>quantity</td>
<td>String</td>
<td>否</td>
<td>包裹数，固定传1</td>
</tr>
<tr>
<td>volume</td>
<td>String</td>
<td>否</td>
<td>包裹总体积cm3</td>
</tr>
<tr>
<td>remark</td>
<td>String</td>
<td>否</td>
<td>备注</td>
</tr>
<tr>
<td>commodity.goodsName</td>
<td>String</td>
<td>是</td>
<td>商品名称</td>
</tr>
<tr>
<td>commodity.goodsCode</td>
<td>String</td>
<td>否</td>
<td>商品编码</td>
</tr>
<tr>
<td>commodity.goodsQuantity</td>
<td>String</td>
<td>是</td>
<td>商品件数</td>
</tr>
<tr>
<td>commodity.goodsPrice</td>
<td>String</td>
<td>是</td>
<td>商品价格</td>
</tr>
<tr>
<td>commodity.goodsWeight</td>
<td>String</td>
<td>否</td>
<td>商品重量kg</td>
</tr>
<tr>
<td>commodity.goodsPicUrl</td>
<td>String</td>
<td>否</td>
<td>图片URL地址</td>
</tr>
<tr>
<td>actualPaymentAmount</td>
<td>String</td>
<td>否</td>
<td>退换货实际付款金额</td>
</tr>
<tr>
<td>insureAmount</td>
<td>String</td>
<td>否</td>
<td>声明价值(正整数)，不可大于3000，根据传入的声明价值计算保费</td>
</tr>
</tbody>
</table>
<h4>成功返回样例</h4>
<pre><code class="language-json">{
&quot;code&quot;: 200,// 返回码，详见返回码说明
&quot;msg&quot;: &quot;成功&quot;,// 返回码对应描述
&quot;taskNo&quot;: &quot;043439882226367117195632&quot;,// 本次请求号
&quot;charge&quot;: true, // 计费标志
&quot;data&quot;: {
&quot;orderCode&quot;: &quot;012657018199&quot;, //订单编号
&quot;startDate&quot;: &quot;2023-08-08 13:00:00&quot;, //预约开始时间，格式：YYYY-MM-DD HH:MM:SS
&quot;endDate&quot;: &quot;2023-08-08 13:00:00&quot; //快递单号，预约结束时间，格式：YYYY-MM-DD HH:MM:SS
}
}</code></pre>
<h4>失败返回样例</h4>
<pre><code class="language-json">{
&quot;code&quot;: 400,// 返回码，详见返回码说明
&quot;taskNo&quot;: &quot;255033697205413852131601&quot;,// 本次请求号
&quot;charge&quot;: false,// 计费标志
&quot;msg&quot;: &quot;快递公司编号不能为空&quot;// 返回码对应描述
}</code></pre>
<hr />
<h3>寄件取消</h3>
<h4>请求地址</h4>
<p><code>https://api.jumdata.com/express-order/cancel</code></p>
<h4>业务参数</h4>
<p>参数说明</p>
<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>orderCode</td>
<td>String</td>
<td>是</td>
<td>订单编号</td>
</tr>
<tr>
<td>cancelType</td>
<td>String</td>
<td>否</td>
<td>取消类型：<br/>1 - 预约信息有误<br/>2 - 快递员无法取件<br/>3 - 上门太慢<br/>4 - 运费太贵<br/>7 - 联系不上快递员<br/>8 - 快递员要求取消<br/>9 - 超时未接单<br/>11 - 其他(请传值具体取消原因)</td>
</tr>
<tr>
<td>cancelMsg</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;taskNo&quot;: &quot;448290834186092138576138&quot;,// 本次请求号
&quot;charge&quot;: false, //计费标志，寄件取消接口不计费
&quot;data&quot;: {}
}
</code></pre>
<h4>失败返回样例</h4>
<pre><code class="language-json">{
&quot;code&quot;: 400,// 返回码，详见返回码说明
&quot;msg&quot;: &quot;订单编号不能为空&quot;, // 返回码对应描述
&quot;taskNo&quot;: &quot;255033697205413852131601&quot;,// 本次请求号
&quot;charge&quot;: false, //计费标志
}</code></pre>