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


创建同城订单

<p>&lt;br/&gt;</p> <p>&gt; 创建同城订单</p> <p>请求接口:/public/pub/tcOrder/createOrder</p> <p>请求方法:POST</p> <p>请求类型:JSON</p> <p>请求参数:</p> <table> <thead> <tr> <th style="text-align: left;">参数名称</th> <th style="text-align: left;">参数类型</th> <th style="text-align: left;">是否必填</th> <th>默认值</th> <th style="text-align: left;">描述</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">settlementType</td> <td style="text-align: left;">Integer</td> <td style="text-align: left;">是</td> <td>结算方式,1同城月结 3大网月结 4余额支付</td> </tr> <tr> <td style="text-align: left;">cityName</td> <td style="text-align: left;">String</td> <td style="text-align: left;">是</td> <td>发单城市</td> </tr> <tr> <td style="text-align: left;">orderSequence</td> <td style="text-align: left;">String</td> <td style="text-align: left;">否</td> <td>&quot;&quot;</td> <td style="text-align: left;">取货号,示例:美团22号</td> </tr> <tr> <td style="text-align: left;">customerCode</td> <td style="text-align: left;">String</td> <td style="text-align: left;">否</td> <td>&quot;&quot;</td> <td style="text-align: left;">大网月结卡号</td> </tr> <tr> <td style="text-align: left;">senderName</td> <td style="text-align: left;">String</td> <td style="text-align: left;">是</td> <td>发件人姓名</td> </tr> <tr> <td style="text-align: left;">senderPhone</td> <td style="text-align: left;">String</td> <td style="text-align: left;">是</td> <td>发件人电话</td> </tr> <tr> <td style="text-align: left;">senderProvince</td> <td style="text-align: left;">String</td> <td style="text-align: left;">是</td> <td>发件人省</td> </tr> <tr> <td style="text-align: left;">senderCity</td> <td style="text-align: left;">String</td> <td style="text-align: left;">是</td> <td>发件人市</td> </tr> <tr> <td style="text-align: left;">senderCounty</td> <td style="text-align: left;">String</td> <td style="text-align: left;">是</td> <td>发件人区</td> </tr> <tr> <td style="text-align: left;">senderAddress</td> <td style="text-align: left;">String</td> <td style="text-align: left;">是</td> <td>发件人地址</td> </tr> <tr> <td style="text-align: left;">receiverName</td> <td style="text-align: left;">String</td> <td style="text-align: left;">是</td> <td>收件人姓名</td> </tr> <tr> <td style="text-align: left;">receiverPhone</td> <td style="text-align: left;">String</td> <td style="text-align: left;">是</td> <td>收件人电话</td> </tr> <tr> <td style="text-align: left;">receiverProvince</td> <td style="text-align: left;">String</td> <td style="text-align: left;">是</td> <td>收件人省</td> </tr> <tr> <td style="text-align: left;">receiverCity</td> <td style="text-align: left;">String</td> <td style="text-align: left;">是</td> <td>收件人市</td> </tr> <tr> <td style="text-align: left;">receiverCounty</td> <td style="text-align: left;">String</td> <td style="text-align: left;">是</td> <td>收件人区</td> </tr> <tr> <td style="text-align: left;">receiverAddress</td> <td style="text-align: left;">String</td> <td style="text-align: left;">是</td> <td>收件人地址</td> </tr> <tr> <td style="text-align: left;">userOrderId</td> <td style="text-align: left;">String</td> <td style="text-align: left;">是</td> <td>商家订单号</td> </tr> <tr> <td style="text-align: left;">productType</td> <td style="text-align: left;">Integer</td> <td style="text-align: left;">是</td> <td>物品类型,枚举值见下面定义</td> </tr> <tr> <td style="text-align: left;">weightGram</td> <td style="text-align: left;">String</td> <td style="text-align: left;">否</td> <td>0</td> <td style="text-align: left;">物品重量,单位:千克</td> </tr> <tr> <td style="text-align: left;">isInsured</td> <td style="text-align: left;">Integer</td> <td style="text-align: left;">是</td> <td>是否保价,0:非保价;1:保价</td> </tr> <tr> <td style="text-align: left;">declaredValue</td> <td style="text-align: left;">String</td> <td style="text-align: left;">否</td> <td>0</td> <td style="text-align: left;">保价金额,单位:元</td> </tr> <tr> <td style="text-align: left;">totalPrice</td> <td style="text-align: left;">String</td> <td style="text-align: left;">是</td> <td>商品总金额,单位:元</td> </tr> <tr> <td style="text-align: left;">isAppoint</td> <td style="text-align: left;">Integer</td> <td style="text-align: left;">是</td> <td>是否预约,0:非预约单;1:预约单</td> </tr> <tr> <td style="text-align: left;">appointType</td> <td style="text-align: left;">Integer</td> <td style="text-align: left;">否</td> <td>0</td> <td style="text-align: left;">预约单类型,预约单的时候传入,1:预约单送达单;2:预约单上门单</td> </tr> <tr> <td style="text-align: left;">isPersonDirect</td> <td style="text-align: left;">Integer</td> <td style="text-align: left;">否</td> <td>0</td> <td style="text-align: left;">是否是专人直送订单,0:否;1:是</td> </tr> <tr> <td style="text-align: left;">expectTime</td> <td style="text-align: left;">String</td> <td style="text-align: left;">否</td> <td>&quot;&quot;</td> <td style="text-align: left;">用户期望送达时间,若传入自此段且时间大于配送时效,则按照预约送达单处理,时间小于配送时效按照立即单处理;appoint_type=1时需必传,格式:yyyy-MM-dd HH:mm:ss</td> </tr> <tr> <td style="text-align: left;">expectPickupTime</td> <td style="text-align: left;">String</td> <td style="text-align: left;">否</td> <td>&quot;&quot;</td> <td style="text-align: left;">用户期望上门时间,appoint_type=2时需必传,格式:yyyy-MM-dd HH:mm:ss</td> </tr> <tr> <td style="text-align: left;">remark</td> <td style="text-align: left;">String</td> <td style="text-align: left;">否</td> <td>&quot;&quot;</td> <td style="text-align: left;">订单备注</td> </tr> <tr> <td style="text-align: left;">verifyCodeType</td> <td style="text-align: left;">Integer</td> <td style="text-align: left;">否</td> <td>0</td> <td style="text-align: left;">是否发送取件码或收件码,0不生成,1发送取件码,2发送收件码,3二者都发送</td> </tr> </tbody> </table> <p>请求示例:</p> <pre><code class="language-json">{ &amp;quot;settlementType&amp;quot;: 1, &amp;quot;cityName&amp;quot;: &amp;quot;北京市&amp;quot;, &amp;quot;orderSequence&amp;quot;: &amp;quot;ORDER-20240122-001&amp;quot;, &amp;quot;customerCode&amp;quot;: &amp;quot;CUST001&amp;quot;, &amp;quot;senderName&amp;quot;: &amp;quot;张三&amp;quot;, &amp;quot;senderPhone&amp;quot;: &amp;quot;13900139000&amp;quot;, &amp;quot;senderProvince&amp;quot;: &amp;quot;北京市&amp;quot;, &amp;quot;senderCity&amp;quot;: &amp;quot;北京市&amp;quot;, &amp;quot;senderCounty&amp;quot;: &amp;quot;顺义区&amp;quot;, &amp;quot;senderAddress&amp;quot;: &amp;quot;北京市顺义区南法信顺捷大厦&amp;quot;, &amp;quot;receiverName&amp;quot;: &amp;quot;李四&amp;quot;, &amp;quot;receiverPhone&amp;quot;: &amp;quot;13700137000&amp;quot;, &amp;quot;receiverProvince&amp;quot;: &amp;quot;北京市&amp;quot;, &amp;quot;receiverCity&amp;quot;: &amp;quot;北京市&amp;quot;, &amp;quot;receiverCounty&amp;quot;: &amp;quot;顺义区&amp;quot;, &amp;quot;receiverAddress&amp;quot;: &amp;quot;北京市顺义区南法信顺捷大厦&amp;quot;, &amp;quot;userOrderId&amp;quot;: &amp;quot;MERCHANT-ORDER-001&amp;quot;, &amp;quot;productType&amp;quot;: 1, &amp;quot;weightGram&amp;quot;: &amp;quot;20&amp;quot;, &amp;quot;isInsured&amp;quot;: 1, &amp;quot;declaredValue&amp;quot;: &amp;quot;500&amp;quot;, &amp;quot;totalPrice&amp;quot;: &amp;quot;800&amp;quot;, &amp;quot;isAppoint&amp;quot;: 1, &amp;quot;appointType&amp;quot;: 2, &amp;quot;isPersonDirect&amp;quot;: 1, &amp;quot;expectTime&amp;quot;: &amp;quot;2024-01-22 14:00:00&amp;quot;, &amp;quot;expectPickupTime&amp;quot;: &amp;quot;2024-01-22 10:00:00&amp;quot;, &amp;quot;remark&amp;quot;: &amp;quot;特殊备注信息&amp;quot;, &amp;quot;verifyCodeType&amp;quot;: 3 }</code></pre> <p>响应参数:</p> <table> <thead> <tr> <th style="text-align: left;">参数名称</th> <th style="text-align: left;">参数类型</th> <th style="text-align: left;">描述</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">sfOrderId</td> <td style="text-align: left;">String</td> <td style="text-align: left;">顺丰订单号</td> </tr> <tr> <td style="text-align: left;">userOrderId</td> <td style="text-align: left;">String</td> <td style="text-align: left;">商家订单号</td> </tr> <tr> <td style="text-align: left;">pushTime</td> <td style="text-align: left;">String</td> <td style="text-align: left;">推送时间,格式:yyyy-MM-dd HH:mm:ss</td> </tr> <tr> <td style="text-align: left;">promiseDeliveryTime</td> <td style="text-align: left;">Integer</td> <td style="text-align: left;">预计配送时间,单位:分钟</td> </tr> <tr> <td style="text-align: left;">settlementType</td> <td style="text-align: left;">Integer</td> <td style="text-align: left;">结算方式</td> </tr> <tr> <td style="text-align: left;">deliveryDistanceMeter</td> <td style="text-align: left;">Integer</td> <td style="text-align: left;">配送距离,单位:米</td> </tr> <tr> <td style="text-align: left;">expectTime</td> <td style="text-align: left;">String</td> <td style="text-align: left;">期望送达时间,格式:yyyy-MM-dd HH:mm:ss</td> </tr> <tr> <td style="text-align: left;">totalPayMoney</td> <td style="text-align: left;">BigDecimal</td> <td style="text-align: left;">支付费用,单位:元</td> </tr> <tr> <td style="text-align: left;">realPayMoney</td> <td style="text-align: left;">BigDecimal</td> <td style="text-align: left;">实际支付金额,单位:元</td> </tr> <tr> <td style="text-align: left;">couponsTotalFee</td> <td style="text-align: left;">BigDecimal</td> <td style="text-align: left;">优惠券总金额,单位:元</td> </tr> <tr> <td style="text-align: left;">overflowFee</td> <td style="text-align: left;">BigDecimal</td> <td style="text-align: left;">爆单费,单位:元</td> </tr> <tr> <td style="text-align: left;">pickupCode</td> <td style="text-align: left;">Integer</td> <td style="text-align: left;">取件码</td> </tr> <tr> <td style="text-align: left;">completeCode</td> <td style="text-align: left;">Integer</td> <td style="text-align: left;">收件码</td> </tr> <tr> <td style="text-align: left;">payAmount</td> <td style="text-align: left;">BigDecimal</td> <td style="text-align: left;">企业充值账户扣款金额,单位:元</td> </tr> <tr> <td style="text-align: left;">grantAmount</td> <td style="text-align: left;">BigDecimal</td> <td style="text-align: left;">企业返现账户扣款金额,单位:元</td> </tr> </tbody> </table> <p>响应示例:</p> <pre><code class="language-json">// 响应成功示例 { &amp;quot;result&amp;quot;: { &amp;quot;completeCode&amp;quot;: 8564, &amp;quot;couponsTotalFee&amp;quot;: 0, &amp;quot;deliveryDistanceMeter&amp;quot;: 7296, &amp;quot;expectTime&amp;quot;: &amp;quot;2024-01-25 15:30:57&amp;quot;, &amp;quot;grantAmount&amp;quot;: 0, &amp;quot;overflowFee&amp;quot;: 0, &amp;quot;payAmount&amp;quot;: 0, &amp;quot;pickupCode&amp;quot;: 5511, &amp;quot;promiseDeliveryTime&amp;quot;: 1, &amp;quot;pushTime&amp;quot;: &amp;quot;2024-01-25 15:29:58&amp;quot;, &amp;quot;realPayMoney&amp;quot;: 1, &amp;quot;settlementType&amp;quot;: 3, &amp;quot;sfOrderId&amp;quot;: &amp;quot;JS4154836256960&amp;quot;, &amp;quot;totalPayMoney&amp;quot;: 1, &amp;quot;userOrderId&amp;quot;: &amp;quot;MERCHANT-ORDER-001&amp;quot; }, &amp;quot;succ&amp;quot;: &amp;quot;ok&amp;quot;, &amp;quot;msg&amp;quot;: null }</code></pre> <p>物品类型代码:</p> <table> <thead> <tr> <th>枚举值</th> <th>物品类型</th> </tr> </thead> <tbody> <tr> <td>1</td> <td>快餐</td> </tr> <tr> <td>2</td> <td>药品</td> </tr> <tr> <td>3</td> <td>百货</td> </tr> <tr> <td>4</td> <td>脏衣服收</td> </tr> <tr> <td>5</td> <td>干净衣服派</td> </tr> <tr> <td>6</td> <td>生鲜</td> </tr> <tr> <td>8</td> <td>高端饮品</td> </tr> <tr> <td>10</td> <td>快递</td> </tr> <tr> <td>12</td> <td>文件</td> </tr> <tr> <td>13</td> <td>蛋糕</td> </tr> <tr> <td>14</td> <td>鲜花</td> </tr> <tr> <td>15</td> <td>数码</td> </tr> <tr> <td>16</td> <td>服装</td> </tr> <tr> <td>17</td> <td>汽配</td> </tr> <tr> <td>18</td> <td>珠宝</td> </tr> <tr> <td>20</td> <td>披萨</td> </tr> <tr> <td>21</td> <td>中餐</td> </tr> <tr> <td>22</td> <td>水产</td> </tr> <tr> <td>32</td> <td>中端饮品</td> </tr> <tr> <td>33</td> <td>便利店</td> </tr> <tr> <td>34</td> <td>面包糕点</td> </tr> <tr> <td>35</td> <td>火锅</td> </tr> <tr> <td>36</td> <td>证照</td> </tr> <tr> <td>41</td> <td>外部落地配</td> </tr> <tr> <td>44</td> <td>年夜饭</td> </tr> <tr> <td>48</td> <td>成人用品</td> </tr> <tr> <td>55</td> <td>宠物用品</td> </tr> <tr> <td>56</td> <td>母婴用品</td> </tr> <tr> <td>57</td> <td>美妆用品</td> </tr> <tr> <td>58</td> <td>家居建材</td> </tr> <tr> <td>59</td> <td>眼镜行</td> </tr> <tr> <td>60</td> <td>图文广告</td> </tr> </tbody> </table>

页面列表

ITEM_HTML