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


查询附近柜机

<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/queryCabinet">https://butler-dev.sit.sf-express.com/public/order/fengchao/queryCabinet</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;">provinceName</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;">cityName</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;">countryName</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;">addressDetail</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;">longitude</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;">latitude</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;">queryAll</td> <td style="text-align: center;">Boolean</td> <td style="text-align: center;">是</td> <td style="text-align: center;">查询所有柜机种类,true为查询所有柜机种类</td> </tr> <tr> <td style="text-align: center;">9</td> <td style="text-align: center;">maxDistance</td> <td style="text-align: center;">Long</td> <td style="text-align: center;">否</td> <td style="text-align: center;">最大距离单位米,最大5km</td> </tr> <tr> <td style="text-align: center;">10</td> <td style="text-align: center;">companyList</td> <td style="text-align: center;">List<String></td> <td style="text-align: center;">否</td> <td style="text-align: center;">返回支持该列表中任意一个快递公司的附近柜机,SF,ZTO,YTO,STO,YD,EMS</td> </tr> <tr> <td style="text-align: center;">11</td> <td style="text-align: center;">pageNo</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;">12</td> <td style="text-align: center;">pageSize</td> <td style="text-align: center;">Integer</td> <td style="text-align: center;">是</td> <td style="text-align: center;">每页大小,默认10,最大50</td> </tr> <tr> <td style="text-align: center;">13</td> <td style="text-align: center;">coordType</td> <td style="text-align: center;">String</td> <td style="text-align: center;">是</td> <td style="text-align: center;">坐标类型,wgs84 --(最基础的坐标) gcj02 -- (国测局加密坐标) bd09ll -- (百度经纬度坐标)</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;">cabinetCode</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;">province</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;">city</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;">cityCode</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;">district</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;">throwAddress</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;">cabinetCode</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;">wholeThrowaddress</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;">throwBuildingLocation</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;">longitude</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;">latitude</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;">bigCellCountLeft</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;">13</td> <td style="text-align: center;">middleCellCountLeft</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;">14</td> <td style="text-align: center;">smallCellCountLeft</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;">15</td> <td style="text-align: center;">belongOrg</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;">16</td> <td style="text-align: center;">supportExpressCompany4Send</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;">17</td> <td style="text-align: center;">distance</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;">canPayPrefix</td> <td style="text-align: center;">Boolean</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>{     "provinceName":"湖北省",     "cityName":"武汉市",     "countryName":"南山区",     "addressDetail":"高新大道南50米",     "longitude":"114.554845",     "latitude":"30.471435",     "queryAll":false,     "pageNo":"1",     "pageSize":"10",     "maxDistance":1020,     "companyList":[         "SF"     ],     "coordType":"wgs84",     "companyId":201905140011898 }</code></pre> </li> <li> <p><strong>响应报文</strong></p> <ol> <li> <p>成功报文</p> <pre><code>{     "result":[         {             "cabinetCode":"FC75525507",             "province":"湖北省",             "city":"武汉市",             "cityCode":"027",             "district":"江夏区",             "throwAddress":"高新大道南50米",             "wholeThrowaddress":"湖北省武汉市江夏区高新大道南50米",             "throwBuildingLocation":"彭彭测试丰巢柜",             "longitude":"114.554639",             "latitude":"30.489257",             "bigCellCountLeft":"3",             "middleCellCountLeft":"14",             "smallCellCountLeft":"16",             "belongOrg":"7",             "supportExpressCompany4Send":"SF",             "distance":1011,             "canPayPrefix":true         }     ],     "succ":"ok",     "msg":null }</code></pre> </li> <li>失败报文 <pre><code>{     "result":null,     "succ":"fail",     "msg":"未获取到客户信息,请检查客户公司ID是否存在" }</code></pre></li> </ol> </li> </ul>

页面列表

ITEM_HTML