订单列表
<p>[TOC]</p>
<h5>简要描述</h5>
<ul>
<li>采用游标分页方式获取订单列表</li>
<li>订单列表按订单创建时间倒序排列</li>
</ul>
<p>[游标分页请求代码示例](<a href="https://www.showdoc.com.cn/gatewaypartnerv1/10914997007617396">https://www.showdoc.com.cn/gatewaypartnerv1/10914997007617396</a> "游标分页请求代码示例")</p>
<h5>请求URL</h5>
<ul>
<li><code>/order/list</code></li>
</ul>
<h5>请求方式</h5>
<ul>
<li>GET</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 style="text-align: left;">说明&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; </th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">appId </td>
<td style="text-align: left;">否 </td>
<td style="text-align: left;">Long </td>
<td style="text-align: left;">应用 ID </td>
</tr>
<tr>
<td style="text-align: left;">beginDate</td>
<td style="text-align: left;">否 </td>
<td style="text-align: left;">String </td>
<td style="text-align: left;">订单创建开始时间，<br/>格式“yyyy-MM-dd HH:mm:ss”，</br>例如：“2023-09-04 19:11:56”<br/>或者“yyyy-MM-dd”，</br>例如：“2023-09-04”，<br/><strong>注意包含开始时间</strong> </td>
</tr>
<tr>
<td style="text-align: left;">endDate </td>
<td style="text-align: left;">否 </td>
<td style="text-align: left;">String </td>
<td style="text-align: left;">订单创建结束时间，<br/>格式“yyyy-MM-dd HH:mm:ss”，</br>例如：“2023-09-04 19:11:56”<br/>或者“yyyy-MM-dd”，</br>例如：“2023-09-04”，<br/><strong>注意不包含结束时间</strong></td>
</tr>
<tr>
<td style="text-align: left;">payState </td>
<td style="text-align: left;">否 </td>
<td style="text-align: left;">Integer</td>
<td style="text-align: left;">订单支付状态：<br/>0-未支付；<br/>1-支付成功；<br/>2-支付失败；<br/>3-已关闭/已取消；<br/>4-支付中。</td>
</tr>
<tr>
<td style="text-align: left;">refundState</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">Integer</td>
<td style="text-align: left;">订单退款状态：<br/>0-未退款；<br/>1-退款中；<br/>2-退款成功；<br/>3-退款失败。</td>
</tr>
<tr>
<td style="text-align: left;">cursor </td>
<td style="text-align: left;">否 </td>
<td style="text-align: left;">String </td>
<td style="text-align: left;">游标，初始为 null，后续请求附带上次翻页的游标 </td>
</tr>
<tr>
<td style="text-align: left;">size </td>
<td style="text-align: left;">是 </td>
<td style="text-align: left;">Integer</td>
<td style="text-align: left;">页大小范围：[1,100]，可设置一次调用最多返回100条 </td>
</tr>
</tbody>
</table>
<h5>返回示例</h5>
<pre><code>{
&quot;code&quot;: 0,
&quot;data&quot;: {
&quot;cursor&quot;: &quot;16928242851135488&quot;,
&quot;isLast&quot;: false,
&quot;list&quot;: [
{
&quot;adId&quot;: &quot;&quot;,
&quot;adverId&quot;: &quot;&quot;,
&quot;appAdChannelType&quot;: 0,
&quot;appId&quot;: 1000,
&quot;appType&quot;: 2,
&quot;appVersion&quot;: &quot;1.0&quot;,
&quot;callback&quot;: &quot;&quot;,
&quot;contentChapterId&quot;: 0,
&quot;chapterName&quot;: &quot;第x集&quot;,
&quot;contentId&quot;: 0,
&quot;contentName&quot;: &quot;xxxxxx&quot;,
&quot;contentType&quot;: 0,
&quot;createDateTime&quot;: &quot;2023-07-31 17:03:56&quot;,
&quot;creativeId&quot;: &quot;&quot;,
&quot;firstVisitPromotionTime&quot;: &quot;2023-07-26 17:03:00&quot;,
&quot;id&quot;: 16927522118713344,
&quot;membeCreateDate&quot;: &quot;2023-07-26 17:52:41&quot;,
&quot;memberId&quot;: 15127853466124288,
&quot;memberIp&quot;: &quot;127.0.0.1&quot;,
&quot;orderAmount&quot;: 1,
&quot;orderProductResList&quot;: [
{
&quot;coinsBonus&quot;: 1,
&quot;coinsBuy&quot;: 1,
&quot;daysSubscribe&quot;: 0,
&quot;id&quot;: 16927522286485504,
&quot;orderId&quot;: 16927522118713344,
&quot;originalPrice&quot;: 0,
&quot;productId&quot;: 8552586793975808,
&quot;productName&quot;: &quot;昌宇专属哇卡&quot;,
&quot;productPrice&quot;: 1,
&quot;productType&quot;: 1
}
],
&quot;outTradeNo&quot;: &quot;&quot;,
&quot;partnerManagerId&quot;: 11134977371013120,
&quot;partnerPrimaryId&quot;: 1000001,
&quot;partnerSubId&quot;: 10703379290656768,
&quot;payAppId&quot;: &quot;&quot;,
&quot;payDate&quot;: null,
&quot;payState&quot;: 0,
&quot;payType&quot;: 1,
&quot;promotionId&quot;: 0,
&quot;promotionName&quot;: &quot;xxx&quot;,
&quot;promotionKeywords&quot;: &quot;xxx&quot;,
&quot;refundAmount&quot;: 0,
&quot;refundDate&quot;: null,
&quot;refundState&quot;: 0,
&quot;userAgent&quot;: &quot;&quot;,
&quot;memberRechargeNumber&quot;:0,
&quot;memberRechargeAmount&quot;:0,
&quot;memberMobileBrand&quot;:&quot;vivo&quot;
},
{
&quot;adId&quot;: &quot;&quot;,
&quot;adverId&quot;: &quot;&quot;,
&quot;appAdChannelType&quot;: 0,
&quot;appId&quot;: 1000,
&quot;appType&quot;: 2,
&quot;appVersion&quot;: &quot;1.0&quot;,
&quot;callback&quot;: &quot;&quot;,
&quot;contentChapterId&quot;: 0,
&quot;chapterName&quot;: &quot;第x集&quot;,
&quot;contentId&quot;: 0,
&quot;contentName&quot;: &quot;xxxxxx&quot;,
&quot;contentType&quot;: 0,
&quot;createDateTime&quot;: &quot;2023-07-31 17:06:48&quot;,
&quot;creativeId&quot;: &quot;&quot;,
&quot;firstVisitPromotionTime&quot;: &quot;2023-07-26 17:03:35&quot;,
&quot;id&quot;: 16928242851135488,
&quot;membeCreateDate&quot;: &quot;2023-07-26 17:52:41&quot;,
&quot;memberId&quot;: 15127853466124288,
&quot;memberIp&quot;: &quot;127.0.0.1&quot;,
&quot;orderAmount&quot;: 1,
&quot;orderProductResList&quot;: [
{
&quot;coinsBonus&quot;: 1,
&quot;coinsBuy&quot;: 1,
&quot;daysSubscribe&quot;: 0,
&quot;id&quot;: 16928243065044992,
&quot;orderId&quot;: 16928242851135488,
&quot;originalPrice&quot;: 0,
&quot;productId&quot;: 8552586793975808,
&quot;productName&quot;: &quot;昌宇专属哇卡&quot;,
&quot;productPrice&quot;: 1,
&quot;productType&quot;: 1
}
],
&quot;outTradeNo&quot;: &quot;&quot;,
&quot;partnerManagerId&quot;: 11134977371013120,
&quot;partnerPrimaryId&quot;: 1000001,
&quot;partnerSubId&quot;: 10703379290656768,
&quot;payAppId&quot;: &quot;&quot;,
&quot;payDate&quot;: null,
&quot;payState&quot;: 0,
&quot;payType&quot;: 1,
&quot;promotionId&quot;: 0,
&quot;promotionName&quot;: &quot;xxx&quot;,
&quot;promotionKeywords&quot;: &quot;xxx&quot;,
&quot;refundAmount&quot;: 0,
&quot;refundDate&quot;: null,
&quot;refundState&quot;: 0,
&quot;userAgent&quot;: &quot;&quot;,
&quot;memberRechargeNumber&quot;:0,
&quot;memberRechargeAmount&quot;:0,
&quot;memberMobileBrand&quot;:&quot;vivo&quot;
}
]
},
&quot;msg&quot;: &quot;OK&quot;,
&quot;traceId&quot;: &quot;5313d142-288f-41c3-a6bc-c001a5afa8c2&quot;
}</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;">code </td>
<td style="text-align: left;">Integer </td>
<td>返回码 </td>
</tr>
<tr>
<td style="text-align: left;">msg </td>
<td style="text-align: left;">String </td>
<td>返回消息 </td>
</tr>
<tr>
<td style="text-align: left;">traceId </td>
<td style="text-align: left;">String </td>
<td>链路追踪 ID </td>
</tr>
<tr>
<td style="text-align: left;">data </td>
<td style="text-align: left;">Object </td>
<td>游标分页返回数据列表响应 </td>
</tr>
</tbody>
</table>
<h6>游标分页返回数据列表响应结构</h6>
<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;">cursor </td>
<td style="text-align: left;">String </td>
<td>游标（下次翻页带上该参数）</td>
</tr>
<tr>
<td style="text-align: left;">isLast </td>
<td style="text-align: left;">Boolean </td>
<td>是否最后一页 </td>
</tr>
<tr>
<td style="text-align: left;">list </td>
<td style="text-align: left;">List </td>
<td>数据列表 </td>
</tr>
</tbody>
</table>
<h6>数据列表项响应结构</h6>
<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;">id </td>
<td style="text-align: left;">Long </td>
<td>订单 ID </td>
</tr>
<tr>
<td style="text-align: left;">partnerPrimaryId </td>
<td style="text-align: left;">Long </td>
<td>所属一级分销商 ID </td>
</tr>
<tr>
<td style="text-align: left;">partnerManagerId </td>
<td style="text-align: left;">Long </td>
<td>所属主管分销商 ID </td>
</tr>
<tr>
<td style="text-align: left;">partnerSubId </td>
<td style="text-align: left;">Long </td>
<td>所属子分销商 ID </td>
</tr>
<tr>
<td style="text-align: left;">appId </td>
<td style="text-align: left;">Long </td>
<td>应用 ID </td>
</tr>
<tr>
<td style="text-align: left;">appType </td>
<td style="text-align: left;">Integer </td>
<td>应用类型 </td>
</tr>
<tr>
<td style="text-align: left;">promotionId </td>
<td style="text-align: left;">Long </td>
<td>推广链接 ID </td>
</tr>
<tr>
<td style="text-align: left;">promotionName</td>
<td style="text-align: left;">String</td>
<td>推广链接名称</td>
</tr>
<tr>
<td style="text-align: left;">promotionKeywords</td>
<td style="text-align: left;">String</td>
<td>推广链接口令</td>
</tr>
<tr>
<td style="text-align: left;">appVersion </td>
<td style="text-align: left;">String </td>
<td>App 版本号 </td>
</tr>
<tr>
<td style="text-align: left;">appAdChannelType </td>
<td style="text-align: left;">Integer </td>
<td>广告媒体渠道类型：</br>1-巨量；</br>2-腾讯MP；</br>3-腾讯ADQ；</br>4-快手；</br>5-百度；</br>6-其它；</br>7-UC；</br>8-VIVO；</br>9-OPPO；</br>10-HUAWEI；</br>11-HONOR；</br>12-小米</td>
</tr>
<tr>
<td style="text-align: left;">memberId </td>
<td style="text-align: left;">Long </td>
<td>下单用户 ID </td>
</tr>
<tr>
<td style="text-align: left;">membeCreateDate </td>
<td style="text-align: left;">DateTime</td>
<td>下单人的创建时间 </td>
</tr>
<tr>
<td style="text-align: left;">orderAmount </td>
<td style="text-align: left;">Integer </td>
<td>订单金额 </td>
</tr>
<tr>
<td style="text-align: left;">payState </td>
<td style="text-align: left;">Integer </td>
<td>订单的支付状态 </td>
</tr>
<tr>
<td style="text-align: left;">payAppId </td>
<td style="text-align: left;">String </td>
<td>支付的应用 ID </td>
</tr>
<tr>
<td style="text-align: left;">payMemberOpenid</td>
<td style="text-align: left;">String</td>
<td>实际支付的用户 openId</td>
</tr>
<tr>
<td style="text-align: left;">payDate </td>
<td style="text-align: left;">DateTime</td>
<td>支付时间 </td>
</tr>
<tr>
<td style="text-align: left;">payType </td>
<td style="text-align: left;">Integer </td>
<td>支付类型，由下单的时候决定 </td>
</tr>
<tr>
<td style="text-align: left;">contentId </td>
<td style="text-align: left;">Long </td>
<td>内容 ID </td>
</tr>
<tr>
<td style="text-align: left;">contentName</td>
<td style="text-align: left;">String</td>
<td>内容名称</td>
</tr>
<tr>
<td style="text-align: left;">contentType </td>
<td style="text-align: left;">Integer </td>
<td>内容类型 </td>
</tr>
<tr>
<td style="text-align: left;">contentChapterId </td>
<td style="text-align: left;">Long </td>
<td>内容的章节 ID </td>
</tr>
<tr>
<td style="text-align: left;">chapterName</td>
<td style="text-align: left;">String</td>
<td>内容的章节名称</td>
</tr>
<tr>
<td style="text-align: left;">activityId</td>
<td style="text-align: left;">Long</td>
<td>活动 ID</td>
</tr>
<tr>
<td style="text-align: left;">memberIp </td>
<td style="text-align: left;">String </td>
<td>下单用户 IP </td>
</tr>
<tr>
<td style="text-align: left;">adverId </td>
<td style="text-align: left;">String </td>
<td>投放的广告主 ID </td>
</tr>
<tr>
<td style="text-align: left;">adId </td>
<td style="text-align: left;">String </td>
<td>投放的广告计划 ID </td>
</tr>
<tr>
<td style="text-align: left;">callback </td>
<td style="text-align: left;">String </td>
<td>上报信息 </td>
</tr>
<tr>
<td style="text-align: left;">creativeId </td>
<td style="text-align: left;">String </td>
<td>创意 ID </td>
</tr>
<tr>
<td style="text-align: left;">outTradeNo </td>
<td style="text-align: left;">Stirng </td>
<td>第三方的订单号 </td>
</tr>
<tr>
<td style="text-align: left;">createDateTime </td>
<td style="text-align: left;">DateTime</td>
<td>订单创建时间 </td>
</tr>
<tr>
<td style="text-align: left;">userAgent </td>
<td style="text-align: left;">String </td>
<td>下单用户的用户代理 </td>
</tr>
<tr>
<td style="text-align: left;">firstVisitPromotionTime</td>
<td style="text-align: left;">DateTime</td>
<td>下单用户首次访问推广链接的时间</td>
</tr>
<tr>
<td style="text-align: left;">refundState</td>
<td style="text-align: left;">Integer</td>
<td>订单退款状态：<br/>0-未退款；<br/>1-退款中；<br/>2-退款成功；<br/>3-退款失败。</td>
</tr>
<tr>
<td style="text-align: left;">refundAmount</td>
<td style="text-align: left;">Integer</td>
<td>退款金额</td>
</tr>
<tr>
<td style="text-align: left;">refundDate</td>
<td style="text-align: left;">DateTime</td>
<td>退款时间</td>
</tr>
<tr>
<td style="text-align: left;">memberRechargeNumber</td>
<td style="text-align: left;">Integer</td>
<td>用户到此订单为止的充值次数</td>
</tr>
<tr>
<td style="text-align: left;">memberRechargeAmount</td>
<td style="text-align: left;">Integer</td>
<td>用户到此订单为止的充值金额</td>
</tr>
<tr>
<td style="text-align: left;">memberMobileBrand</td>
<td style="text-align: left;">String</td>
<td>用户手机型号(可能为空)</td>
</tr>
<tr>
<td style="text-align: left;">orderProductResList </td>
<td style="text-align: left;">List </td>
<td>订单商品信息列表 </td>
</tr>
</tbody>
</table>
<h6>订单商品信息列表项响应结构</h6>
<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;">id </td>
<td style="text-align: left;">Long </td>
<td>订单商品信息 ID </td>
</tr>
<tr>
<td style="text-align: left;">orderId </td>
<td style="text-align: left;">Long </td>
<td>订单 ID </td>
</tr>
<tr>
<td style="text-align: left;">productId </td>
<td style="text-align: left;">Long </td>
<td>商品 ID </td>
</tr>
<tr>
<td style="text-align: left;">productName </td>
<td style="text-align: left;">String </td>
<td>商品名称 </td>
</tr>
<tr>
<td style="text-align: left;">productPrice </td>
<td style="text-align: left;">Integer </td>
<td>商品价格，单位：分 </td>
</tr>
<tr>
<td style="text-align: left;">originalPrice </td>
<td style="text-align: left;">Integer </td>
<td>商品原价，单位：分 </td>
</tr>
<tr>
<td style="text-align: left;">productType </td>
<td style="text-align: left;">Integer </td>
<td>商品类型 </td>
</tr>
<tr>
<td style="text-align: left;">coinsBuy </td>
<td style="text-align: left;">Integer </td>
<td>购买的金币数量 </td>
</tr>
<tr>
<td style="text-align: left;">coinsBonus </td>
<td style="text-align: left;">Integer </td>
<td>赠送金币数 </td>
</tr>
<tr>
<td style="text-align: left;">daysSubscribe </td>
<td style="text-align: left;">Integer </td>
<td>VIP 订阅天数 </td>
</tr>
</tbody>
</table>
<h5>备注</h5>
<ul>
<li>返回错误代码请查看[错误响应](<a href="https://www.showdoc.com.cn/gatewaypartnerv1/10903560257841502">https://www.showdoc.com.cn/gatewaypartnerv1/10903560257841502</a> "错误响应")页面描述</li>
</ul>