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


4.订单运费估算接口

<h3>功能描述</h3> <ul> <li>该接口用于:客户查询运费估算信息。</li> </ul> <h3>代码参考</h3> <ul> <li><a href="https://www.showdoc.com.cn/server/api/attachment/visitFile?sign=ce4b5f66bbb85d797f777d8c2ece0a32" title="[【Java版】路由查询&订单运费估算demo v1.0.zip">【Java版】路由查询&amp;订单运费估算demo v1.0.zip</a></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/getFreight</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;">String(20)</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;">jProvince</td> <td style="text-align: center;">String(30)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">原寄地所在省份。字段填写要求:必须是标准的省名称称谓 如:广东省,如果是直辖市,请直接传北京、上海等。</td> </tr> <tr> <td style="text-align: center;">3</td> <td style="text-align: center;">jCity</td> <td style="text-align: center;">String(100)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">原寄地所在城市。必须是标准的城市称谓 如:深圳市。</td> </tr> <tr> <td style="text-align: center;">4</td> <td style="text-align: center;">jAddress</td> <td style="text-align: center;">String(450)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">原寄地详细地址。此详细地址需包含省市信息,以提高地址识别的成功率,示例:“广东省深圳市福田区新洲十一街万基商务大厦10楼”。</td> </tr> <tr> <td style="text-align: center;">5</td> <td style="text-align: center;">dProvince</td> <td style="text-align: center;">String(30)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">目的地所在省份。字段填写要求:必须是标准的省名称称谓 如:广东省,如果是直辖市,请直接传北京、上海等。</td> </tr> <tr> <td style="text-align: center;">6</td> <td style="text-align: center;">dCity</td> <td style="text-align: center;">String(100)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">目的地所在城市。必须是标准的城市称谓 如:深圳市。</td> </tr> <tr> <td style="text-align: center;">7</td> <td style="text-align: center;">dAddress</td> <td style="text-align: center;">String(450)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">目的地详细地址。此详细地址需包含省市信息,以提高地址识别的成功率,示例:“广东省深圳市福田区新洲十一街万基商务大厦10楼”。</td> </tr> <tr> <td style="text-align: center;">8</td> <td style="text-align: center;">expressType</td> <td style="text-align: center;">String(5)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">业务类型产品编码。如1,2,154等,详见《附录-2.快件产品类列表》。</td> </tr> <tr> <td style="text-align: center;">9</td> <td style="text-align: center;">parcelWeighs</td> <td style="text-align: center;">Number(16,2)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">货物总重量。包含子母件,单位千克,精确到小数点后2位,如果提供此值,必须&gt;0。</td> </tr> <tr> <td style="text-align: center;">10</td> <td style="text-align: center;">volume</td> <td style="text-align: center;">String(100)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">货物的总体积。单位CM,精确到小数点后2位,包含子母件。</td> </tr> <tr> <td style="text-align: center;">11</td> <td style="text-align: center;">consignedTime</td> <td style="text-align: center;">String(30)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">当前请求时间</td> <td style="text-align: left;">寄件时间。格式:YYYY-MM-DD HH24:MM:SS,示例:2013-12-27 17:54:20。</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;">deliverTime</td> <td style="text-align: center;">String(100)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">时效</td> <td style="text-align: left;">预计派送时间或预计派送时间段,返回时间段时2个时间逗号分隔,时间段格式:YYYY-MM-DD HH24:MM:SS,YYYY-MM-DD HH24:MM:SS。示例:2013-12-27 12:00:00,2013-12-27 15:00:00,表示2013年12月27日12点到15点之间到达。</td> </tr> <tr> <td style="text-align: center;">5</td> <td style="text-align: center;">price</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;">估算值,非真实运费</td> </tr> </tbody> </table> <h3>报文范例</h3> <ul> <li> <p><strong>请求报文</strong></p> <pre><code>{ "companyId": "201905140011321", "jProvince": "河南省", "jCity": "郑州市", "jAddress": "河南省郑州市新郑机场", "dProvince": "北京", "dCity": "北京市", "dAddress": "北京市朝阳区花家地金兴路1号院5号楼1单元202", "expressType": "1", "parcelWeighs": "2.00", "volume": "10", "consignedTime":"2021-03-20 15:38:54" }</code></pre> </li> <li><strong>响应报文</strong> <ul> <li>成功报文 <pre><code>{ "msg": "", "succ": "ok", "result": { "deliverTime": "2020-12-14 22:00:00,2020-12-14 22:00:00", "price": "124元" } }</code></pre></li> <li>失败报文-范例1 <pre><code>{ "msg":"系统发生数据错误或运行时异常", "result": null, "succ": "fail" }</code></pre></li> <li>失败报文-范例2 <pre><code>{ "msg":"运费估算失败", "result": null, "succ": "fail" }</code></pre></li> <li>失败报文-范例3(错误编码请见《附录-1.原因代码表》) <pre><code>{ "msg":"错误编码:8040。错误信息:SrcAddress is illegal", "result": null, "succ": "fail" }</code></pre></li> </ul></li> </ul>

页面列表

ITEM_HTML