预约上门取件
<h5>简要描述</h5>
<ul>
<li>必须是先调用了“<a href="https://www.showdoc.com.cn/1673998693694655/7911432640428291">创建运单</a>”接口，才能使用本接口</li>
</ul>
<h5>请求URL</h5>
<ul>
<li><code>https://www.37-express.com/qyfr/api/parcel/v2/</code></li>
</ul>
<h5>请求方式</h5>
<ul>
<li>POST</li>
</ul>
<h5>设置头部(HEADER)</h5>
<ul>
<li>Content-Type: application/json</li>
</ul>
<h5>参数</h5>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">必选</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><strong>account</strong></td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">object</td>
<td>账号信息</td>
</tr>
<tr>
<td style="text-align: left;">account/email</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>用户名</td>
</tr>
<tr>
<td style="text-align: left;">account/password</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>密码</td>
</tr>
<tr>
<td style="text-align: left;"></td>
<td style="text-align: left;"></td>
<td style="text-align: left;"></td>
<td></td>
</tr>
<tr>
<td style="text-align: left;"><strong>appointmentPickup</strong></td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">object</td>
<td>正文数据</td>
</tr>
<tr>
<td style="text-align: left;">appointmentPickup/incrementId</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>接口“<a href="https://www.showdoc.com.cn/1673998693694655/7911432640428291">创建运单</a>”返回的唯一运单编号</td>
</tr>
<tr>
<td style="text-align: left;"></td>
<td style="text-align: left;"></td>
<td style="text-align: left;"></td>
<td></td>
</tr>
<tr>
<td style="text-align: left;"><strong>appointmentPickup/appointment</strong></td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">object</td>
<td>预约上门信息。注意：如果你并不想更换之前的地址或者预约时间，则不需要</td>
</tr>
<tr>
<td style="text-align: left;">appointmentPickup/appointment/pickupDate</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">date</td>
<td>预约上门取件日期，格式必须是：YYYY-MM-DD</td>
</tr>
<tr>
<td style="text-align: left;">appointmentPickup/appointment/company</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>您的公司名</td>
</tr>
<tr>
<td style="text-align: left;">appointmentPickup/appointment/name</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>联系人</td>
</tr>
<tr>
<td style="text-align: left;">appointmentPickup/appointment/countryCode</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>国家，目前只允许FR</td>
</tr>
<tr>
<td style="text-align: left;">appointmentPickup/appointment/city</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>上门城市</td>
</tr>
<tr>
<td style="text-align: left;">appointmentPickup/appointment/street</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>上门街道地址</td>
</tr>
<tr>
<td style="text-align: left;">appointmentPickup/appointment/room</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>门牌号</td>
</tr>
<tr>
<td style="text-align: left;">appointmentPickup/appointment/floor</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>楼层</td>
</tr>
<tr>
<td style="text-align: left;">appointmentPickup/appointment/postalCode</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>上门地址的邮编</td>
</tr>
<tr>
<td style="text-align: left;">appointmentPickup/appointment/phoneNumber</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>联系电话</td>
</tr>
<tr>
<td style="text-align: left;">appointmentPickup/appointment/isHome</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>是否家庭地址。是用Y，否用N</td>
</tr>
<tr>
<td style="text-align: left;">appointmentPickup/appointment/remarks</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>其它特别说明</td>
</tr>
</tbody>
</table>
<h5>请求示例</h5>
<pre><code>{
&quot;account&quot;: {
&quot;email&quot;: &quot;test@test.com&quot;,
&quot;password&quot;: &quot;test_test_test_test&quot;
},
&quot;appointmentPickup&quot;: {
&quot;incrementId&quot;:&quot;78284091&quot;
}
}</code></pre>
<h5>返回示例</h5>
<pre><code>{
&quot;success&quot;: true,
&quot;appointmentPickup&quot;:{
&quot;status&quot;:3
}
}</code></pre>
<h5>返回参数说明</h5>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">status</td>
<td style="text-align: left;">int</td>
<td>1: 等待提交申请，<br />2: 等待审核，<br />3: 提交成功，等待上门</td>
</tr>
</tbody>
</table>
<h5>出错返回示例</h5>
<pre><code>{
&quot;success&quot;: false,
&quot;message&quot;: &quot;Invalid login or password.&quot;
}</code></pre>