shopApi

商城API项目


订单列表

<h5>接口描述</h5> <ul> <li>订单列表</li> </ul> <h5>请求URL</h5> <ul> <li><code>/api/orders</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;">Authorization</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>JWT token</td> </tr> </tbody> </table> <h5>Query 请求参数</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;">page</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td>分页</td> </tr> <tr> <td style="text-align: left;">title</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>标题模糊搜索</td> </tr> <tr> <td style="text-align: left;">status</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td>订单状态: 1下单 2支付 3发货 4收货 5过期</td> </tr> <tr> <td style="text-align: left;">include</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>包含额外的数据: goods 商品,user 用户 ,orderDetails订单详情</td> </tr> </tbody> </table> <p>inlude可以返回额外的数据, 多个使用 <code>,</code> 分隔, 比如: <code>include=goods,user,orderDetails</code> 多层关联可以是 <code>.</code>, 比如要获取订单细节的同时,还要获取细节关联的商品:<code>include=orderDetails.goods</code></p> <p><code>推荐使用的方式: include=orderDetails.goods</code></p> <h5>返回参数</h5> <p><strong>data</strong></p> <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;">id</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</td> <td>自增长主键ID</td> </tr> <tr> <td style="text-align: left;">order_no</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>单号</td> </tr> <tr> <td style="text-align: left;">user_id</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</td> <td>创建者</td> </tr> <tr> <td style="text-align: left;">amount</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</td> <td>总价</td> </tr> <tr> <td style="text-align: left;">status</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</td> <td>状态</td> </tr> <tr> <td style="text-align: left;">address_id</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</td> <td>收货地址</td> </tr> <tr> <td style="text-align: left;">express_type</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>快递类型</td> </tr> <tr> <td style="text-align: left;">express_no</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>快递号</td> </tr> <tr> <td style="text-align: left;">pay_time</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</td> <td>支付时间</td> </tr> <tr> <td style="text-align: left;">pay_type</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>支付类型</td> </tr> <tr> <td style="text-align: left;">trade_no</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>支付流水号</td> </tr> <tr> <td style="text-align: left;">created_at</td> <td style="text-align: left;">是</td> <td style="text-align: left;">timestamp</td> <td>添加时间</td> </tr> <tr> <td style="text-align: left;">updated_at</td> <td style="text-align: left;">是</td> <td style="text-align: left;">timestamp</td> <td>修改时间</td> </tr> </tbody> </table> <p><strong>meta.pagination</strong></p> <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;">total</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</td> <td>数据总数</td> </tr> <tr> <td style="text-align: left;">count</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</td> <td>当前页数据</td> </tr> <tr> <td style="text-align: left;">per_page</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</td> <td>每页显示条数</td> </tr> <tr> <td style="text-align: left;">current_page</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</td> <td>当前页页码</td> </tr> <tr> <td style="text-align: left;">total_pages</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</td> <td>总页数</td> </tr> <tr> <td style="text-align: left;">links.previous</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>上一页链接</td> </tr> <tr> <td style="text-align: left;">links.next</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>下一页链接</td> </tr> </tbody> </table> <h5>返回示例</h5> <ul> <li>状态码 200 请求成功</li> </ul> <pre><code> { "data": [ { "id": 7, "order_no": "20210922101816835949", "user_id": 1, "amount": "9086.00", "status": 4, "address_id": 40, "express_type": "YD", "express_no": "20210922101818587474", "pay_time": "2021-09-23 11:44:50", "pay_type": "支付宝", "trade_no": "2021092322001425560501700091", "created_at": "2021-09-22T03:16:16.000000Z", "updated_at": "2021-09-24T13:17:43.000000Z", "goods": { "data": [ { "id": 22, "title": "Fugiat in saepe hic.", "category_id": 70, "description": "Repellat nulla atque non voluptatum.", "price": 245, "stock": 1570, "pics": [ "http://placeimg.com/640/480/any", "http://placeimg.com/640/480/any", "http://placeimg.com/640/480/any" ], "pics_url": [ "http://placeimg.com/640/480/any", "http://placeimg.com/640/480/any", "http://placeimg.com/640/480/any" ], "cover": "http://placeimg.com/640/480/any", "cover_url": "http://placeimg.com/640/480/any", "details": "Suscipit totam omnis molestias eos veniam et nihil sed. Ea velit doloremque quia debitis. Praesentium quam voluptatem consequatur. Eum repudiandae quis enim qui esse.\n\nTenetur autem nostrum quia sit. Illum sunt vero illo ipsa numquam quibusdam. Sint et quaerat ut soluta ut voluptatibus.\n\nCorporis in repellat et voluptates vero eos ducimus. Porro animi accusamus quod. Iste enim non nisi veritatis. Provident error labore ratione doloribus cumque qui ipsum. Aperiam enim eos sint ullam ratione enim est.\n\nIn ut exercitationem modi expedita. Porro quaerat est excepturi ut aperiam possimus qui. Facere ut quis placeat earum eaque.", "is_on": 1, "is_recommend": 1, "created_at": "2021-09-17T01:49:16.000000Z", "updated_at": "2021-09-24T13:17:43.000000Z" }, { "id": 23, "title": "Officia ullam vel.", "category_id": 74, "description": "Vel eum nostrum quam repellat.", "price": 756, "stock": 4275, "pics": [ "http://placeimg.com/640/480/any", "http://placeimg.com/640/480/any", "http://placeimg.com/640/480/any" ], "pics_url": [ "http://placeimg.com/640/480/any", "http://placeimg.com/640/480/any", "http://placeimg.com/640/480/any" ], "cover": "http://placeimg.com/640/480/any", "cover_url": "http://placeimg.com/640/480/any", "details": "Est eos incidunt voluptate reprehenderit. Quia et dicta quod nostrum laudantium quis praesentium. Qui consequatur aut vel.\n\nMagni enim animi sint eveniet quasi ut consequatur. Expedita molestiae atque aut blanditiis nihil laboriosam. Explicabo et rerum omnis molestiae error recusandae ut quos. Inventore distinctio aut et tenetur vitae vel iste.\n\nNeque laboriosam illo vero expedita. Maiores velit voluptatibus dolorem ipsum ipsa officiis eaque. Aspernatur eaque quidem possimus eos sint. Molestiae similique consequatur eos alias et repudiandae.\n\nPerferendis officiis magnam ex quo. Ut optio amet dolorum commodi eos velit mollitia. Perspiciatis velit dolorem nam porro ipsum rem. Ut sit culpa odit provident sequi suscipit. Voluptas corrupti voluptates voluptatem quasi.", "is_on": 1, "is_recommend": 1, "created_at": "2021-09-17T01:49:16.000000Z", "updated_at": "2021-09-24T13:17:43.000000Z" } ] } }, { "id": 8, "order_no": "20210924131945693669", "user_id": 1, "amount": "245.00", "status": 5, "address_id": 40, "express_type": null, "express_no": null, "pay_time": null, "pay_type": null, "trade_no": null, "created_at": "2021-09-24T05:19:45.000000Z", "updated_at": "2021-09-24T12:13:41.000000Z", "goods": { "data": [ { "id": 22, "title": "Fugiat in saepe hic.", "category_id": 70, "description": "Repellat nulla atque non voluptatum.", "price": 245, "stock": 1570, "pics": [ "http://placeimg.com/640/480/any", "http://placeimg.com/640/480/any", "http://placeimg.com/640/480/any" ], "pics_url": [ "http://placeimg.com/640/480/any", "http://placeimg.com/640/480/any", "http://placeimg.com/640/480/any" ], "cover": "http://placeimg.com/640/480/any", "cover_url": "http://placeimg.com/640/480/any", "details": "Suscipit totam omnis molestias eos veniam et nihil sed. Ea velit doloremque quia debitis. Praesentium quam voluptatem consequatur. Eum repudiandae quis enim qui esse.\n\nTenetur autem nostrum quia sit. Illum sunt vero illo ipsa numquam quibusdam. Sint et quaerat ut soluta ut voluptatibus.\n\nCorporis in repellat et voluptates vero eos ducimus. Porro animi accusamus quod. Iste enim non nisi veritatis. Provident error labore ratione doloribus cumque qui ipsum. Aperiam enim eos sint ullam ratione enim est.\n\nIn ut exercitationem modi expedita. Porro quaerat est excepturi ut aperiam possimus qui. Facere ut quis placeat earum eaque.", "is_on": 1, "is_recommend": 1, "created_at": "2021-09-17T01:49:16.000000Z", "updated_at": "2021-09-24T13:17:43.000000Z" } ] } } ], "meta": { "pagination": { "total": 2, "count": 2, "per_page": 3, "current_page": 1, "total_pages": 1, "links": null } } }</code></pre>

页面列表

ITEM_HTML