7.订单确认/取消接口-确认接口
<h3>功能描述</h3>
<ul>
<li>该接口用于：客户在下单后，快递员上门揽收前，如需修改部分下单内容（如收件人信息等），可使用此接口进行修改；如不需要修改下单内容，则无需对接此接口。</li>
</ul>
<p><code>注：该接口只能在未揽收前生效；</code></p>
<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/v2/cancelOrder</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>
<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;">orderId</td>
<td style="text-align: center;">String(64)</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;">waybillNoInfoList</td>
<td style="text-align: center;">List<WaybillNoInfoJson></td>
<td style="text-align: center;">条件</td>
<td style="text-align: center;">顺丰运单号列表(如果dealtype=1，母单号必填)，参考目录中共用参数</td>
</tr>
<tr>
<td style="text-align: center;">4</td>
<td style="text-align: center;">dealType</td>
<td style="text-align: center;">String(1)</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">2</td>
<td style="text-align: left;">客户订单操作标识。1：确认；2：取消；3：丰巢柜寄件取消</td>
</tr>
<tr>
<td style="text-align: center;">5</td>
<td style="text-align: center;">customsBatchs</td>
<td style="text-align: center;">String(20)</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;">agentNo</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;">7</td>
<td style="text-align: center;">sourceZoneCode</td>
<td style="text-align: center;">String(10)</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;">inProcessWaybillNo</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;">9</td>
<td style="text-align: center;">isConfirmNew</td>
<td style="text-align: center;">String(1)</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">改单类型，默认为0。0：旧订单确认；1：新订单确认类型(支持修改收件方信息，含筛单+产品月结校验)</td>
</tr>
<tr>
<td style="text-align: center;">10</td>
<td style="text-align: center;">weight</td>
<td style="text-align: center;">String(10)</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">订单货物总重量，包含子母件，单位千克，精确到小数点后2位，如果提供此值，必须>0。</td>
</tr>
<tr>
<td style="text-align: center;">11</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;">货物的总体积（值为长，宽，高），包含子母件，以半角逗号分隔，单位厘米，精确到小数点后2位，会用于计抛（是否计抛具体商务沟通中双方约定）。</td>
</tr>
<tr>
<td style="text-align: center;">12</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;">快件产品类别，详见《附录-2.快件产品类别表》，只有在商务上与顺丰约定的类别方可使用。如果此字段为空，则以下单时的为准。</td>
</tr>
<tr>
<td style="text-align: center;">13</td>
<td style="text-align: center;">bigHousehold</td>
<td style="text-align: center;">String</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">增值服务:大件入户（IN98）</td>
</tr>
<tr>
<td style="text-align: center;">14</td>
<td style="text-align: center;">superLongOverweight</td>
<td style="text-align: center;">String</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">增值服务：超长超重（IN23）</td>
</tr>
<tr>
<td style="text-align: center;">15</td>
<td style="text-align: center;">province</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;">16</td>
<td style="text-align: center;">city</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;">17</td>
<td style="text-align: center;">county</td>
<td style="text-align: center;">String(64)</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;">address</td>
<td style="text-align: center;">String(64)</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;">company</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;">20</td>
<td style="text-align: center;">contact</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;">21</td>
<td style="text-align: center;">tel</td>
<td style="text-align: center;">String(20)</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">收件方-联系电话</td>
</tr>
<tr>
<td style="text-align: center;">22</td>
<td style="text-align: center;">mobile</td>
<td style="text-align: center;">String(20)</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;">extra1</td>
<td style="text-align: center;">String(200)</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">自定义字段1</td>
</tr>
<tr>
<td style="text-align: center;">24</td>
<td style="text-align: center;">extra2</td>
<td style="text-align: center;">String(200)</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">自定义字段2</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>
<th style="text-align: left;">描述</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: center;">1</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;">2</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;">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;">orderid</td>
<td style="text-align: center;">String(64)</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;">mailno</td>
<td style="text-align: center;">String(20)</td>
<td style="text-align: center;">条件</td>
<td style="text-align: center;">顺丰母运单号</td>
<td style="text-align: left;">如果dealtype=1，必填</td>
</tr>
<tr>
<td style="text-align: center;">6</td>
<td style="text-align: center;">code</td>
<td style="text-align: center;">Number(1)</td>
<td style="text-align: center;">是</td>
<td style="text-align: center;">响应状态码</td>
<td style="text-align: left;">1：客户订单号与顺丰运单不匹配；2 ：操作成功</td>
</tr>
<tr>
<td style="text-align: center;">7</td>
<td style="text-align: center;">waybillNoInfoList</td>
<td style="text-align: center;">List<WaybillNoInfoJson></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;">extraInfoList</td>
<td style="text-align: center;">List<OrderUpdateExtraInfoJson></td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">扩展字段</td>
</tr>
</tbody>
</table>
<h3>元素<OrderUpdateExtraInfoJson></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;">attrName</td>
<td style="text-align: center;">String(256)</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;">attrVal</td>
<td style="text-align: center;">String(1024)</td>
<td style="text-align: center;">否</td>
<td style="text-align: center;">扩展字段值</td>
</tr>
</tbody>
</table>
<h3>扩展字段备注</h3>
<table>
<thead>
<tr>
<th>attrName</th>
<th>attrVal</th>
</tr>
</thead>
<tbody>
<tr>
<td>attr001</td>
<td></td>
</tr>
<tr>
<td>attr002</td>
<td></td>
</tr>
<tr>
<td>subsidySource</td>
<td>国补标识，dy为抖音；sn为苏宁；tb为淘天；pdd为拼多多；ks为快手；wph为唯品会；dw为得物；xhs为小红书；sph为视频号；merchant为商家自营国补; cancel为取消标识；</td>
</tr>
<tr>
<td>wpMerchantCode</td>
<td>微派商户编码，微派会给每个接入客户提供一个唯一编码</td>
</tr>
<tr>
<td>wpServiceCode</td>
<td>微派任务编码，类型为手机，传ProXXXXX，类型为平板，传ProXXXXX，需与微派申请任务编码</td>
</tr>
<tr>
<td>wpExtJson</td>
<td>“{“sn”:“123456”,“imei”:“123456”}” —sn为sn编码，只支持一个，imei为手机/平板emei号，只支持一个</td>
</tr>
</tbody>
</table>
<h3>报文范例</h3>
<ul>
<li>
<p><strong>请求报文</strong></p>
<pre><code>{
&quot;companyId&quot;: xxx,
&quot;orderId&quot;: &quot;312b95e8af6c43ba99a4a21280e2501e&quot;,
&quot;dealType&quot;: 1,
&quot;isConfirmNew&quot;: 1,
&quot;weight&quot;: 3.56,
&quot;volume&quot;: &quot;33&quot;,
&quot;bigHousehold&quot;: 2300,
&quot;province&quot;: &quot;广东省&quot;,
&quot;city&quot;: &quot;深圳市&quot;,
&quot;county&quot;: &quot;罗湖区&quot;,
&quot;address&quot;: &quot;宝安北路2051号&quot;,
&quot;expressType&quot;: 2,
&quot;waybillNoInfoList&quot;: [
{
&quot;waybillType&quot;: 1,
&quot;waybillNo&quot;: &quot;SF1324481443217&quot;,
&quot;boxNo&quot;: &quot;xianghao1&quot;,
&quot;length&quot;: 1.1,
&quot;width&quot;: 1.2,
&quot;height&quot;: 1.3,
&quot;weight&quot;: 1.4,
&quot;volume&quot;: 1.5
}
]
}</code></pre>
</li>
<li><strong>响应报文</strong>
<ul>
<li>成功报文
<pre><code>{
&quot;result&quot;: {
&quot;mailno&quot;: &quot;SF1011812161001&quot;,
&quot;extraInfoList&quot;: &quot;null&quot;,
&quot;waybillNoInfoList&quot;: &quot;[{\&quot;boxNo\&quot;:\&quot;xianghao1\&quot;,\&quot;height\&quot;:1.3,\&quot;length\&quot;:1.1,\&quot;volume\&quot;:1.5,\&quot;waybillNo\&quot;:\&quot;SF1011812161001\&quot;,\&quot;waybillType\&quot;:1,\&quot;weight\&quot;:1.4,\&quot;width\&quot;:1.2}]&quot;,
&quot;code&quot;: &quot;2&quot;,
&quot;orderid&quot;: &quot;8a9a379c71a34e26bf2548a6786c5269&quot;
},
&quot;succ&quot;: &quot;ok&quot;,
&quot;msg&quot;: null
}</code></pre></li>
<li>失败报文-范例1
<pre><code>{
&quot;result&quot;: null,
&quot;succ&quot;: &quot;fail&quot;,
&quot;msg&quot;: &quot;订单已确认&quot;
}</code></pre></li>
</ul></li>
</ul>