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


1.批量获取订单图片/视频签名地址接口

<h3>功能描述</h3> <ul> <li>该接口用于: 通过订单号获取微派图片/视频的访问地址,有30分钟时效限制,失效后需要重新请求接口获取新的地址</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/pubBatchResourceUrl</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> <h4>元素&lt;vpBatchResourceUrlRequestDTO&gt;</h4> <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;">用户订单号,与merchantMailno必填其一</td> </tr> <tr> <td style="text-align: center;">2</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;">用户运单号,与merchantOrderNo必填其一</td> </tr> <tr> <td style="text-align: center;">3</td> <td style="text-align: center;">resourcePaths</td> <td style="text-align: center;">List&lt;String&gt;</td> <td style="text-align: center;">否</td> <td style="text-align: center;">图片/视频路径列表&lt;会校验是否与订单的数据匹配,如果为空则返回该订单所有资源的访问地址&gt;</td> </tr> <tr> <td style="text-align: center;">4</td> <td style="text-align: center;">resourceType</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;">图片导出格式:1-jpg格式;2-pdf格式;9-所有格式。默认1;</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;">code</td> <td style="text-align: center;">String</td> <td style="text-align: center;">取证项编码</td> </tr> <tr> <td style="text-align: center;">5</td> <td style="text-align: center;">resourceUrls</td> <td style="text-align: center;">List&lt;Url&gt;</td> <td style="text-align: center;">否</td> <td style="text-align: center;">取证项对应的资源访问地址列表,Url为资源格式,暂暂且只增加图片pdf格式</td> </tr> </tbody> </table> <h3>元素&lt;Url&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;">jpgUrl</td> <td style="text-align: center;">String</td> <td style="text-align: center;">可选</td> <td style="text-align: center;">jpg格式url</td> </tr> <tr> <td style="text-align: center;">2</td> <td style="text-align: center;">pdfUrl</td> <td style="text-align: center;">String</td> <td style="text-align: center;">可选</td> <td style="text-align: center;">pdf格式url</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;5d7c1a54c5824a7ebdabd03d9418a103&amp;quot;, &amp;quot;resourcePaths&amp;quot;:[], &amp;quot;resourceType&amp;quot;:&amp;quot;&amp;quot; } }</code></pre> </li> <li><strong>响应报文</strong> <ul> <li>成功报文 <pre><code>{ &amp;quot;result&amp;quot;: [ { &amp;quot;code&amp;quot;: &amp;quot;takePhotoList_ext1&amp;quot;, &amp;quot;resourceUrls&amp;quot;: [ { &amp;quot;jpgUrl&amp;quot;: &amp;quot;https://fxs-sit-1252000277.cos.ap-guangzhou.myqcloud.com/B2021060004-0001/FX21070803949369/9A75BBDD-4287-4B92-8C9B-D33A379278A8.jpg?sign=q-sign-algorithm%3Dsha1%26q-ak%3DAKIDpYVo0DzZ9qOGA1KDRbSY_IfsuDBPA9hxu-2s2sMLipSqvHesqyf5Z8vTO6_U53-1%26q-sign-time%3D1625739439%3B1625746638%26q-key-time%3D1625739439%3B1625746638%26q-header-list%3D%26q-url-param-list%3D%26q-signature%3De32a037ec23548ec2fbf53b9358ace5a3afc9fbc&amp;amp;x-cos-security-token=odSQBhyeG3y6QuBG3obtuVM1vwHoi6na5e5df2eab1a4cd8f9989b429b65932bfRmgs-dKOjOSFEmYEvbnu5xlJSlDIrX2yXte58hxlxR-srAe75ZzLBnDst0Muq3jJUVQ2JMbAmAmI43VoTjph2RTRYW57ICP7Ke3XzfS05kB4Epwq7FZj3tmNc-HvEv6N-H1_-2sxxZAgISfFL3h53MLfJ37IDRB1YRIl91x9lslPlwLMWAxreTpzvMNlyxQlHUI6u2ICXxMuVlYbVl9RN0BSZxG85Lr7CPFYaXEzPERmS2QgwOspDry0Vp47CHUlsVAg8fBweF3QatBu8-NbB0eHv2V5Sg4JmeCNJapCk9hCB3DaruFhusdfFzTZj45xck9gN3xxbDwOPeuBvayPpJ77EzmwjSYSBo0ZuA0GGYDFmJLNliOtUtVVgL1Wvb0wGOJHWkMLHonK1ub-Ys4TJpL3LJmUpwbG56VgdtiGdSL3he2fc_KjetJZaeMmNZMWfK5uKMWUIbycaoUK5OCq-IlZQefZyqXGZ_rUCHaebfj0upm5Cr0nWct-54gSOU3OUiJmhuNDPGLD68WKb-LdPCkfhgedsQexZuamDlnhN36txMPuQMzLEVQfwnhnc6pwTJo5HsDys_gRKCErJ3jhELVtRK3jhaUyW_wAwBqML5KClwWnhSL8Y4h40E0duRGdXd0CBcM2lGL2V5QmNv3pBuCJVJOSZNf4LhRcTFPSWqcFx7jVR7JE_QDNYOneFHWIazTLjKcu_Q86oA8sdSgtrcMghK-9UJJ8vWBL-G2Bj98G_8qM0WlrOyBN979KebWn&amp;amp;&amp;quot;, &amp;quot;pdfUrl&amp;quot;: &amp;quot;&amp;quot; }, { &amp;quot;jpgUrl&amp;quot;: &amp;quot;https://fxs-sit-1252000277.cos.ap-guangzhou.myqcloud.com/B2021060004-0001/FX21070803949369/7118CF9F-CFAD-4E66-B553-869FE9E23512.jpg?sign=q-sign-algorithm%3Dsha1%26q-ak%3DAKIDpYVo0DzZ9qOGA1KDRbSY_IfsuDBPA9hxu-2s2sMLipSqvHesqyf5Z8vTO6_U53-1%26q-sign-time%3D1625739439%3B1625746638%26q-key-time%3D1625739439%3B1625746638%26q-header-list%3D%26q-url-param-list%3D%26q-signature%3Ddd500231c085c70cff382220372ab3070e261a36&amp;amp;x-cos-security-token=odSQBhyeG3y6QuBG3obtuVM1vwHoi6na5e5df2eab1a4cd8f9989b429b65932bfRmgs-dKOjOSFEmYEvbnu5xlJSlDIrX2yXte58hxlxR-srAe75ZzLBnDst0Muq3jJUVQ2JMbAmAmI43VoTjph2RTRYW57ICP7Ke3XzfS05kB4Epwq7FZj3tmNc-HvEv6N-H1_-2sxxZAgISfFL3h53MLfJ37IDRB1YRIl91x9lslPlwLMWAxreTpzvMNlyxQlHUI6u2ICXxMuVlYbVl9RN0BSZxG85Lr7CPFYaXEzPERmS2QgwOspDry0Vp47CHUlsVAg8fBweF3QatBu8-NbB0eHv2V5Sg4JmeCNJapCk9hCB3DaruFhusdfFzTZj45xck9gN3xxbDwOPeuBvayPpJ77EzmwjSYSBo0ZuA0GGYDFmJLNliOtUtVVgL1Wvb0wGOJHWkMLHonK1ub-Ys4TJpL3LJmUpwbG56VgdtiGdSL3he2fc_KjetJZaeMmNZMWfK5uKMWUIbycaoUK5OCq-IlZQefZyqXGZ_rUCHaebfj0upm5Cr0nWct-54gSOU3OUiJmhuNDPGLD68WKb-LdPCkfhgedsQexZuamDlnhN36txMPuQMzLEVQfwnhnc6pwTJo5HsDys_gRKCErJ3jhELVtRK3jhaUyW_wAwBqML5KClwWnhSL8Y4h40E0duRGdXd0CBcM2lGL2V5QmNv3pBuCJVJOSZNf4LhRcTFPSWqcFx7jVR7JE_QDNYOneFHWIazTLjKcu_Q86oA8sdSgtrcMghK-9UJJ8vWBL-G2Bj98G_8qM0WlrOyBN979KebWn&amp;amp;&amp;quot;, &amp;quot;pdfUrl&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