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


3.获取订单签署文件地址接口

<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;">/public/vpOrder/downloadElectronicOrderSigningUrl</td> </tr> </tbody> </table> <h3>元素&lt;请求&gt;</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(64)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">分配appId</td> </tr> <tr> <td style="text-align: center;">2</td> <td style="text-align: center;">merchantCode</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;">vpBatchResourceUrlRequestDTO</td> <td style="text-align: center;">Object</td> <td style="text-align: center;">是</td> <td style="text-align: center;">详细字段</td> </tr> </tbody> </table> <ul> <li>vpBatchResourceUrlRequestDTO</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> <th style="text-align: left;">描述</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;">1</td> <td style="text-align: center;">merchantOrderNo</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;">1</td> <td style="text-align: center;">merchantMailno</td> <td style="text-align: center;">String(64)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">用户运单号</td> </tr> </tbody> </table> <h3>元素&lt;响应&gt;</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;">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;">2</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;">3</td> <td style="text-align: center;">result</td> <td style="text-align: center;">List</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;">contractTemplateName</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;">urls</td> <td style="text-align: center;">List&lt;Url&gt;</td> <td style="text-align: center;">否</td> <td style="text-align: center;">文档地址, 有效时间1小时;该链接建议只用于下载,不要直接预览</td> </tr> <tr> <td style="text-align: center;">6</td> <td style="text-align: center;">signStatus</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> <p><strong>请求报文</strong></p> <pre><code>{ &amp;quot;companyId&amp;quot;:xxx, &amp;quot;merchantCode&amp;quot;:&amp;quot;B2021060004-0001&amp;quot;, &amp;quot;vpBatchResourceUrlRequestDTO&amp;quot;:{ &amp;quot;merchantOrderNo&amp;quot;:&amp;quot;e6f37d77daf649d6b1f257946e72b999&amp;quot; } }</code></pre> </li> <li><strong>响应报文</strong> <ul> <li>成功报文 <pre><code>{     &amp;quot;result&amp;quot;: {         &amp;quot;contractTemplateName&amp;quot;: &amp;quot;快递管家电子签署&amp;quot;,         &amp;quot;urls&amp;quot;: [             &amp;quot;https://wesign-sit-1256483133.cos.ap-guangzhou.myqcloud.com/wesign/contact/2022/05/30/WPU220530000209/24fe6b4dbb264449bd8fd7bc59ca0ab7.pdf?sign=q-sign-algorithm%3Dsha1%26q-ak%3DAKIDsmxzRKebthMN7Mk9fHfcbMvGDTEmwGx7-gmKrbclLuOdT2F1h41262a6n4D8i8UU%26q-sign-time%3D1654738480%3B1654745680%26q-key-time%3D1654738480%3B1654745680%26q-header-list%3Dhost%26q-url-param-list%3D%26q-signature%3Deadc188a6e7e4be3f1db8bacb0ed349ea7702227&amp;amp;x-cos-security-token=EwgPMaKqZDZS1wej5BcTHYhXeR5iqa6a37fdfb4cc1cb93368abc4b9b363ea8760J1_Za0fVlbo2V_kpuoR-vwpFec2Z_IXnJxnL7vTX5KGiwqjYHdcJYy3IPKerfjvK7kYw1TSBEg60yHdnUXNS1mVAhWB5dxR6cI3M1Qm7ZudX8WXeXxopCXgyoNg3HXMU6C3qehje2mMsGMLrYux7CXxV3A5XSY6JN_Z53BtSXLyD0_Mzp6nJ2W_ZDecX1Q94eJUT4pbwPlxqUW_ss2hDy0cfdU2-Rv6xnu_3kgTD2kjgVRrIDV9sao5MulPxCpvUZz260RSn5lU4pQyNhPHc0F7-gR8iLanW4xoIMZS5vs&amp;quot;         ],         &amp;quot;signStatus&amp;quot;: &amp;quot;已完成签署&amp;quot;     },     &amp;quot;succ&amp;quot;: &amp;quot;ok&amp;quot;,     &amp;quot;msg&amp;quot;: null }</code></pre></li> <li>失败报文-范例1 <pre><code>{ &amp;quot;msg&amp;quot;:&amp;quot;系统发生数据错误或运行时异常&amp;quot;, &amp;quot;result&amp;quot;: null, &amp;quot;succ&amp;quot;: &amp;quot;fail&amp;quot; }</code></pre></li> <li>失败报文-范例2 <pre><code>{ &amp;quot;msg&amp;quot;:&amp;quot;商户编码必填&amp;quot;, &amp;quot;result&amp;quot;: null, &amp;quot;succ&amp;quot;: &amp;quot;fail&amp;quot; }</code></pre></li> </ul></li> </ul>

页面列表

ITEM_HTML