GET 订单列表
接口概览
| 项目 | 内容 |
|---|---|
| 文档类型 | 前台接口 |
| 请求方式 | GET |
| 接口地址 | /console/v1/order |
| 所属业务 | 订单管理 |
| 来源模块/系统 | 订单管理 |
| 认证方式 | Bearer Token（用户令牌） |
完整请求
请求
正在加载示例…失败请求
正在加载示例…接口说明
订单列表
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| keywords | query | string | 否 | 关键字 搜索范围订单 ID |
| type | query | string | 否 | 类型 new新订单 renew续费订单 upgrade升降级订单 artificial人工订单 |
| status | query | string | 否 | 状态 Unpaid未付款 Paid已付款 |
| page | query | integer(int32) | 否 | 页数 |
| limit | query | integer(int32) | 否 | 每页条数 |
| orderby | query | string | 否 | 排序字段 id type create_time amount status |
| sort | query | string | 否 | 升降序 asc desc |
成功响应
正在加载示例…失败响应 400：请求参数或业务校验失败
正在加载示例…失败响应 401：未认证或登录已失效
正在加载示例…失败响应 403：无权执行当前操作
正在加载示例…失败响应 404：接口或业务资源不存在
正在加载示例…失败响应 500：服务器内部错误
正在加载示例…响应状态
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功响应 | 内联对象 |
| 400 | Bad Request | 请求参数或业务校验失败 | 内联对象 |
| 401 | Unauthorized | 未认证或登录已失效 | 内联对象 |
| 403 | Forbidden | 无权执行当前操作 | 内联对象 |
| 404 | Not Found | 接口或业务资源不存在 | 内联对象 |
| 500 | Internal Server Error | 服务器内部错误 | 内联对象 |
响应参数
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| status | integer(int32) | 否 | — | — | 状态码 |
| msg | string | 否 | — | — | 提示信息 |
| data | object | 否 | — | — | — |
| data.list | [object] | 否 | — | — | 订单列表 |
| data.list[].id | integer(int32) | 否 | — | — | 订单 ID |
| data.list[].type | string | 否 | — | — | 类型 new新订单 renew续费订单 upgrade升降级订单 artificial人工订单 |
| data.list[].create_time | integer(int32) | 否 | — | — | 创建时间 |
| data.list[].amount | string | 否 | — | — | 金额 |
| data.list[].status | string | 否 | — | — | 状态 Unpaid未付款 Paid已付款 WaitUpload待上传 WaitReview待审核 ReviewFail审核失败 |
| data.list[].gateway | string | 否 | — | — | 支付方式 |
| data.list[].credit | number(double) | string | 否 | — | — | 使用余额 大于0代表订单使用了余额和金额相同代表订单支付方式为余额 |
| data.list[].host_name | string | 否 | — | — | 产品标识 |
| data.list[].description | string | 否 | — | — | 描述 |
| data.list[].product_names | [string] | 否 | — | — | 订单下所有产品的商品名称 |
| data.list[].host_id | integer(int32) | 否 | — | — | 产品 ID |
| data.list[].order_item_count | integer(int32) | 否 | — | — | 订单子项数量 |
| data.list[].voucher | [string] | 否 | — | — | 上传的凭证 |
| data.list[].review_fail_reason | string | 否 | — | — | 审核失败原因 |
| data.list[].pay_time | integer | 否 | — | — | — |
| data.list[].gateway_sign | string | 否 | — | — | — |
| data.list[].developer_type | integer | 否 | — | — | — |
| data.count | integer(int32) | 否 | — | — | 订单总数 |
失败状态码 400、401、403、404、500 共用以下结构：
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| status | integer(int32) | 是 | — | — | 错误状态码 |
| msg | string | 是 | — | — | 错误提示 |