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


30.员工优惠寄件查询接口

<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/order/v2/employeeDiscountsOrderQuery</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(50)</td> <td style="text-align: center;">是</td> <td style="text-align: center;"></td> <td style="text-align: left;">公司id</td> </tr> <tr> <td style="text-align: center;">2</td> <td style="text-align: center;">startTime</td> <td style="text-align: center;">String(50)</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;">endTime</td> <td style="text-align: center;">String(100)</td> <td style="text-align: center;">是</td> <td style="text-align: center;"></td> <td style="text-align: left;">结束时间</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: left;">说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;">1</td> <td style="text-align: center;">result</td> <td style="text-align: center;">String(200)</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(50)</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;">msg</td> <td style="text-align: center;">String(50)</td> <td style="text-align: center;">是</td> <td style="text-align: left;">结果信息提示</td> </tr> </tbody> </table> <h4>响应参数 result</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> </tr> </thead> <tbody> <tr> <td style="text-align: center;">1</td> <td style="text-align: center;">orderCount</td> <td style="text-align: center;">Integer(9)</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;">totalFeeMoney</td> <td style="text-align: center;">BigDecimal</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;">totalDiscountMoney</td> <td style="text-align: center;">BigDecimal</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;:201905140011021,     &amp;quot;startTime&amp;quot;:&amp;quot;2023-03-17 00:00:00&amp;quot;,     &amp;quot;endTime&amp;quot;:&amp;quot;2023-07-21 00:00:00&amp;quot; }</code></pre> </li> <li><strong>响应返回报文 </strong> <ul> <li>成功报文 <pre><code>{     &amp;quot;result&amp;quot;: {         &amp;quot;orderCount&amp;quot;: 1,         &amp;quot;totalFeeMoney&amp;quot;: 10.00,         &amp;quot;totalDiscountMoney&amp;quot;: 1.11     },     &amp;quot;succ&amp;quot;: &amp;quot;ok&amp;quot;,     &amp;quot;msg&amp;quot;: null }</code></pre></li> <li>失败报文 <pre><code>{     &amp;quot;result&amp;quot;: null,     &amp;quot;succ&amp;quot;: &amp;quot;fail&amp;quot;,     &amp;quot;msg&amp;quot;: &amp;quot;feign服务请求超时&amp;quot; }</code></pre></li> </ul></li> </ul>

页面列表

ITEM_HTML