野象新媒体接口文档

新媒体对外接口文档


获取商品列表

<p>[TOC]</p> <h5>简要描述</h5> <ul> <li>获取商品列表</li> </ul> <h5>请求URL</h5> <ul> <li><code>/product/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>说明            </th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">partnerId</td> <td style="text-align: left;">是</td> <td style="text-align: left;">Long</td> <td>分销商 ID(子分销商 ID)</td> </tr> <tr> <td style="text-align: left;">productName</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>商品名称</td> </tr> <tr> <td style="text-align: left;">productId</td> <td style="text-align: left;">否</td> <td style="text-align: left;">Long</td> <td>商品 ID</td> </tr> <tr> <td style="text-align: left;">productType</td> <td style="text-align: left;">否</td> <td style="text-align: left;">Integer</td> <td>商品类型:&lt;br/&gt;1-金币充值;&lt;br/&gt;2-VIP 充值;&lt;br/&gt;3-SVIP 充值。</td> </tr> <tr> <td style="text-align: left;">productCreatorType</td> <td style="text-align: left;">否</td> <td style="text-align: left;">Integer</td> <td>商品创建者类型:&lt;br/&gt;1-管理员;&lt;br/&gt;2-子分销商;&lt;br/&gt;0-全部。</td> </tr> <tr> <td style="text-align: left;">productProp</td> <td style="text-align: left;">否</td> <td style="text-align: left;">Integer</td> <td>商品属性:&lt;br/&gt;1-充值商品;&lt;br/&gt;2-活动商品。</td> </tr> <tr> <td style="text-align: left;">orderType</td> <td style="text-align: left;">否</td> <td style="text-align: left;">Integer</td> <td>排序类型:&lt;br/&gt;0-按金额创建时间倒序;(默认)&lt;br/&gt;1-按金额创建时间正序;&lt;br/&gt;2-按金额大小倒序;&lt;br/&gt;3-按金额大小正序。</td> </tr> <tr> <td style="text-align: left;">pageIndex</td> <td style="text-align: left;">是</td> <td style="text-align: left;">Integer</td> <td>页码:最小值 1  </td> </tr> <tr> <td style="text-align: left;">pageSize  </td> <td style="text-align: left;">是</td> <td style="text-align: left;">Integer</td> <td>页大小范围:[1, 100],即最小值为1,最大值为100</td> </tr> </tbody> </table> <h5>返回示例</h5> <pre><code>{ &amp;quot;code&amp;quot;: 0, &amp;quot;data&amp;quot;: { &amp;quot;current&amp;quot;: 1, &amp;quot;pages&amp;quot;: 117, &amp;quot;records&amp;quot;: [ { &amp;quot;appId&amp;quot;: 1000, &amp;quot;coinsBonus&amp;quot;: 2, &amp;quot;coinsBuy&amp;quot;: 0, &amp;quot;contentType&amp;quot;: 1, &amp;quot;contentTypeStr&amp;quot;: &amp;quot;小说&amp;quot;, &amp;quot;cornerTip&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;createBy&amp;quot;: 2, &amp;quot;createDateTime&amp;quot;: &amp;quot;2024-01-27 14:36:20&amp;quot;, &amp;quot;createRoleStr&amp;quot;: null, &amp;quot;daysSubscribe&amp;quot;: 0, &amp;quot;description&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;exclusiveState&amp;quot;: 0, &amp;quot;exclusiveStateStr&amp;quot;: &amp;quot;非独家&amp;quot;, &amp;quot;footTip&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;id&amp;quot;: &amp;quot;82120193253572608&amp;quot;, &amp;quot;isCanBeEdit&amp;quot;: false, &amp;quot;name&amp;quot;: &amp;quot;赠送&amp;quot;, &amp;quot;pointerState&amp;quot;: 1, &amp;quot;pointerStateStr&amp;quot;: &amp;quot;开启&amp;quot;, &amp;quot;price&amp;quot;: 0, &amp;quot;productProp&amp;quot;: 2, &amp;quot;productPropStr&amp;quot;: &amp;quot;活动&amp;quot;, &amp;quot;productType&amp;quot;: 1, &amp;quot;productTypeStr&amp;quot;: &amp;quot;金币充值&amp;quot; }, { &amp;quot;appId&amp;quot;: 19743565588729856, &amp;quot;coinsBonus&amp;quot;: 0, &amp;quot;coinsBuy&amp;quot;: 0, &amp;quot;contentType&amp;quot;: 1, &amp;quot;contentTypeStr&amp;quot;: &amp;quot;小说&amp;quot;, &amp;quot;cornerTip&amp;quot;: &amp;quot;测试&amp;quot;, &amp;quot;createBy&amp;quot;: 19743565408374784, &amp;quot;createDateTime&amp;quot;: &amp;quot;2024-01-25 17:23:43&amp;quot;, &amp;quot;createRoleStr&amp;quot;: null, &amp;quot;daysSubscribe&amp;quot;: 0, &amp;quot;description&amp;quot;: &amp;quot;测试&amp;quot;, &amp;quot;exclusiveState&amp;quot;: 0, &amp;quot;exclusiveStateStr&amp;quot;: &amp;quot;非独家&amp;quot;, &amp;quot;footTip&amp;quot;: &amp;quot;测试&amp;quot;, &amp;quot;id&amp;quot;: &amp;quot;81437541731401728&amp;quot;, &amp;quot;isCanBeEdit&amp;quot;: true, &amp;quot;name&amp;quot;: &amp;quot;测试&amp;quot;, &amp;quot;pointerState&amp;quot;: 0, &amp;quot;pointerStateStr&amp;quot;: &amp;quot;关闭&amp;quot;, &amp;quot;price&amp;quot;: 16000, &amp;quot;productProp&amp;quot;: 1, &amp;quot;productPropStr&amp;quot;: &amp;quot;充值&amp;quot;, &amp;quot;productType&amp;quot;: 3, &amp;quot;productTypeStr&amp;quot;: &amp;quot;&amp;quot; } ], &amp;quot;size&amp;quot;: 2, &amp;quot;total&amp;quot;: 234 }, &amp;quot;msg&amp;quot;: &amp;quot;OK&amp;quot;, &amp;quot;traceId&amp;quot;: &amp;quot;37dedf25-d498-43d7-999a-fe17a3a9d085&amp;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>data 数据结构说明</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;">current</td> <td style="text-align: left;">Long</td> <td>分页-页码  </td> </tr> <tr> <td style="text-align: left;">pages  </td> <td style="text-align: left;">Long</td> <td>分页-总页数</td> </tr> <tr> <td style="text-align: left;">records</td> <td style="text-align: left;">List</td> <td>商品列表    </td> </tr> <tr> <td style="text-align: left;">size    </td> <td style="text-align: left;">Long</td> <td>分页-页大小</td> </tr> <tr> <td style="text-align: left;">total  </td> <td style="text-align: left;">Long</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;">String  </td> <td>商品 ID              </td> </tr> <tr> <td style="text-align: left;">name        </td> <td style="text-align: left;">String  </td> <td>商品名称              </td> </tr> <tr> <td style="text-align: left;">productType</td> <td style="text-align: left;">Integer</td> <td>商品类型:&lt;br/&gt;1-金币充值;&lt;br/&gt;2-VIP 充值;&lt;br/&gt;3-SVIP 充值。</td> </tr> <tr> <td style="text-align: left;">productTypeStr</td> <td style="text-align: left;">String</td> <td>商品类型描述</td> </tr> <tr> <td style="text-align: left;">productProp</td> <td style="text-align: left;">Integer</td> <td>商品属性:&lt;br/&gt;1-充值商品;&lt;br/&gt;2-活动商品。</td> </tr> <tr> <td style="text-align: left;">productPropStr</td> <td style="text-align: left;">String</td> <td>商品属性描述</td> </tr> <tr> <td style="text-align: left;">price</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> <tr> <td style="text-align: left;">footTip</td> <td style="text-align: left;">String</td> <td>底部提示</td> </tr> <tr> <td style="text-align: left;">cornerTip</td> <td style="text-align: left;">String</td> <td>角标</td> </tr> <tr> <td style="text-align: left;">pointerState</td> <td style="text-align: left;">Integer</td> <td>手势引导:0-关闭,1-开启</td> </tr> <tr> <td style="text-align: left;">pointerStateStr</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>内容类型:&lt;/br&gt;0-全部;&lt;/br&gt;1-小说;&lt;/br&gt;2-短剧;&lt;/br&gt;4-短篇。</td> </tr> <tr> <td style="text-align: left;">contentTypeStr</td> <td style="text-align: left;">String</td> <td>内容类型描述</td> </tr> <tr> <td style="text-align: left;">exclusiveState</td> <td style="text-align: left;">Integer</td> <td>独家状态:0-非独家,1-独家</td> </tr> <tr> <td style="text-align: left;">exclusiveStateStr</td> <td style="text-align: left;">String</td> <td>独家状态描述</td> </tr> <tr> <td style="text-align: left;">description</td> <td style="text-align: left;">String</td> <td>商品描述,VIP 类型展示使用</td> </tr> <tr> <td style="text-align: left;">appId</td> <td style="text-align: left;">Long</td> <td>商品隶属的应用 ID,&lt;/br&gt;<strong>有两个特殊值:&lt;/br&gt;1000-表示超管创建的商品,任何应用都可以使用;&lt;/br&gt;2000-创建子分销商的商务创建的商品,商务创建的所有子分销商都可以使用。</strong></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;">createBy</td> <td style="text-align: left;">Long</td> <td>创建者</td> </tr> <tr> <td style="text-align: left;">createRoleStr</td> <td style="text-align: left;">String</td> <td>创建者所属角色</td> </tr> <tr> <td style="text-align: left;">isCanBeEdit</td> <td style="text-align: left;">Boolean</td> <td>是否可以编辑</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> &quot;错误响应&quot;)页面描述</li> </ul>

页面列表

ITEM_HTML