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


下单接口

<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;"><a href="https://butler-dev.sit.sf-express.com/public/order/fengchao/placeOrder">https://butler-dev.sit.sf-express.com/public/order/fengchao/placeOrder</a></td> </tr> </tbody> </table> <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;">必填</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</td> <td style="text-align: center;">是</td> <td style="text-align: center;">公司id</td> </tr> <tr> <td style="text-align: center;">2</td> <td style="text-align: center;">expressCompanyType</td> <td style="text-align: center;">String</td> <td style="text-align: center;">是</td> <td style="text-align: center;">快递公司code,SF:顺丰速运</td> </tr> <tr> <td style="text-align: center;">3</td> <td style="text-align: center;">expressProduct</td> <td style="text-align: center;">Integer</td> <td style="text-align: center;">是</td> <td style="text-align: center;">快递产品ID,1001:顺丰特快 1002:顺丰标快 expressTypeo为2 payType为1</td> </tr> <tr> <td style="text-align: center;">4</td> <td style="text-align: center;">receiverProvinceName</td> <td style="text-align: center;">String</td> <td style="text-align: center;">是</td> <td style="text-align: center;">收件人省名</td> </tr> <tr> <td style="text-align: center;">5</td> <td style="text-align: center;">receiverCityName</td> <td style="text-align: center;">String</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;">receiverCountryName</td> <td style="text-align: center;">String</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;">receiverAddressDetail</td> <td style="text-align: center;">String</td> <td style="text-align: center;">是</td> <td style="text-align: center;">收件人详细地址</td> </tr> <tr> <td style="text-align: center;">8</td> <td style="text-align: center;">receiverName</td> <td style="text-align: center;">String</td> <td style="text-align: center;">是</td> <td style="text-align: center;">收件人姓名</td> </tr> <tr> <td style="text-align: center;">9</td> <td style="text-align: center;">receiverContact</td> <td style="text-align: center;">String</td> <td style="text-align: center;">是</td> <td style="text-align: center;">收件人联系方式</td> </tr> <tr> <td style="text-align: center;">10</td> <td style="text-align: center;">senderProvinceName</td> <td style="text-align: center;">String</td> <td style="text-align: center;">是</td> <td style="text-align: center;">寄件人省名</td> </tr> <tr> <td style="text-align: center;">11</td> <td style="text-align: center;">senderCityName</td> <td style="text-align: center;">String</td> <td style="text-align: center;">是</td> <td style="text-align: center;">寄件人市名</td> </tr> <tr> <td style="text-align: center;">12</td> <td style="text-align: center;">senderCountryName</td> <td style="text-align: center;">String</td> <td style="text-align: center;">是</td> <td style="text-align: center;">寄件人区名</td> </tr> <tr> <td style="text-align: center;">13</td> <td style="text-align: center;">senderAddressDetail</td> <td style="text-align: center;">String</td> <td style="text-align: center;">是</td> <td style="text-align: center;">寄件人详细地址</td> </tr> <tr> <td style="text-align: center;">14</td> <td style="text-align: center;">senderName</td> <td style="text-align: center;">String</td> <td style="text-align: center;">是</td> <td style="text-align: center;">寄件人姓名</td> </tr> <tr> <td style="text-align: center;">15</td> <td style="text-align: center;">senderContact</td> <td style="text-align: center;">String</td> <td style="text-align: center;">是</td> <td style="text-align: center;">寄件人联系方式</td> </tr> <tr> <td style="text-align: center;">16</td> <td style="text-align: center;">expressType</td> <td style="text-align: center;">Integer</td> <td style="text-align: center;">是</td> <td style="text-align: center;">快件类型 1:个人件 2:公司件</td> </tr> <tr> <td style="text-align: center;">17</td> <td style="text-align: center;">goodsNum</td> <td style="text-align: center;">Integer</td> <td style="text-align: center;">是</td> <td style="text-align: center;">物品数量</td> </tr> <tr> <td style="text-align: center;">18</td> <td style="text-align: center;">insuredPrice</td> <td style="text-align: center;">Integer</td> <td style="text-align: center;">否</td> <td style="text-align: center;">声明价值 单位为分,整数值</td> </tr> <tr> <td style="text-align: center;">19</td> <td style="text-align: center;">itemType</td> <td style="text-align: center;">String</td> <td style="text-align: center;">是</td> <td style="text-align: center;">物品类型</td> </tr> <tr> <td style="text-align: center;">20</td> <td style="text-align: center;">itemWeight</td> <td style="text-align: center;">Float</td> <td style="text-align: center;">是</td> <td style="text-align: center;">物品重量</td> </tr> <tr> <td style="text-align: center;">21</td> <td style="text-align: center;">payType</td> <td style="text-align: center;">Integer</td> <td style="text-align: center;">是</td> <td style="text-align: center;">付款方式1:寄付月结 2:寄付现结 3:到付</td> </tr> <tr> <td style="text-align: center;">22</td> <td style="text-align: center;">userPhone</td> <td style="text-align: center;">String</td> <td style="text-align: center;">是</td> <td style="text-align: center;">下单人手机号码</td> </tr> <tr> <td style="text-align: center;">23</td> <td style="text-align: center;">thirdOrderId</td> <td style="text-align: center;">String</td> <td style="text-align: center;">是</td> <td style="text-align: center;">第三方系统订单Id</td> </tr> <tr> <td style="text-align: center;">24</td> <td style="text-align: center;">realName</td> <td style="text-align: center;">String</td> <td style="text-align: center;">否</td> <td style="text-align: center;">寄件人真实姓名</td> </tr> <tr> <td style="text-align: center;">25</td> <td style="text-align: center;">cardOfType</td> <td style="text-align: center;">String</td> <td style="text-align: center;">否</td> <td style="text-align: center;">寄件人证件类型</td> </tr> <tr> <td style="text-align: center;">26</td> <td style="text-align: center;">cardNumber</td> <td style="text-align: center;">String</td> <td style="text-align: center;">是</td> <td style="text-align: center;">寄件人证件号码</td> </tr> <tr> <td style="text-align: center;">27</td> <td style="text-align: center;">remark</td> <td style="text-align: center;">String</td> <td style="text-align: center;">否</td> <td style="text-align: center;">用户备注</td> </tr> <tr> <td style="text-align: center;">28</td> <td style="text-align: center;">monthlyCard</td> <td style="text-align: center;">String</td> <td style="text-align: center;">否</td> <td style="text-align: center;">月结卡号</td> </tr> </tbody> </table> <h3>响应</h3> <ul> <li><strong>主体</strong></li> </ul> <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;">succ</td> <td style="text-align: center;">Boolean</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;">msg</td> <td style="text-align: center;">String</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;">result</td> <td style="text-align: center;">Array</td> <td style="text-align: center;">否</td> <td style="text-align: center;">数据</td> </tr> </tbody> </table> <ul> <li><strong>result</strong></li> </ul> <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;">sendCode</td> <td style="text-align: center;">String</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;">sendId</td> <td style="text-align: center;">String</td> <td style="text-align: center;">是</td> <td style="text-align: center;">丰巢订单id</td> </tr> <tr> <td style="text-align: center;">3</td> <td style="text-align: center;">expressCompanyId</td> <td style="text-align: center;">String</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;">expressCompanyName</td> <td style="text-align: center;">String</td> <td style="text-align: center;">是</td> <td style="text-align: center;">快递公司名称</td> </tr> <tr> <td style="text-align: center;">5</td> <td style="text-align: center;">smallboxprice</td> <td style="text-align: center;">Integer</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;">middleboxprice</td> <td style="text-align: center;">Integer</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;">bigboxprice</td> <td style="text-align: center;">Integer</td> <td style="text-align: center;">是</td> <td style="text-align: center;">大格口价格</td> </tr> </tbody> </table> <h3>报文范例</h3> <ul> <li> <p><strong>请求报文</strong></p> <pre><code>{     "expressCompanyType":"SF",     "expressProduct":1001,     "receiverProvinceName":"广东省",     "receiverCityName":"广州",     "receiverCountryName":"天河区",     "receiverAddressDetail":"长平乡三组1号",     "receiverName":"dxd",     "receiverContact":"15811059617",     "senderProvinceName":"广东省",     "senderCityName":"深圳市",     "senderCountryName":"南山区",     "senderAddressDetail":"软件产业基地",     "senderName":"zy",     "senderContact":"18710081087",     "expressType":1,     "goodsNum":2,     "insuredPrice":10000,     "itemType":"电子产品",     "itemWeight":1.5,     "payType":2,     "userPhone":"18710081087",     "thirdOrderId":"202209071959",     "remark":"订单的",     "companyId":201905140011898 }</code></pre> </li> <li> <p><strong>响应报文</strong></p> <ol> <li> <p>成功报文</p> <pre><code>{     "result":{         "bigboxprice":"0",         "expressCompanyId":"SF",         "expressCompanyName":"顺丰速运",         "middleboxprice":"0",         "sendCode":"00271290",         "sendId":"2022090700000329",         "smallboxprice":"0"     },     "succ":"ok",     "msg":null }</code></pre> </li> <li>失败报文 <pre><code>{     "result":null,     "succ":"fail",     "msg":"未获取到客户信息,请检查客户公司ID是否存在" }</code></pre></li> </ol> </li> </ul>

页面列表

ITEM_HTML