GET 订单详情
接口概览
| 项目 | 内容 |
|---|---|
| 文档类型 | 后台接口 |
| 请求方式 | GET |
| 接口地址 | /DIR_ADMIN/v1/order/{id} |
| 所属业务 | 订单管理 |
| 来源模块/系统 | 订单管理 |
| 认证方式 | Bearer Token（管理员令牌） |
完整请求
请求
正在加载示例…失败请求
正在加载示例…接口说明
订单详情
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| id | path | integer(int32) | 是 | 订单 ID |
成功响应
正在加载示例…失败响应 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.order | object | 否 | — | 订单 |
data.order.id | integer(int32) | 否 | — | 订单 ID |
data.order.type | string | 否 | — | 类型,new新订单,renew续费订单,upgrade升降级订单,artificial人工订单 |
data.order.amount | string | 否 | — | 金额 |
data.order.create_time | integer(int32) | 否 | — | 创建时间 |
data.order.status | string | 否 | — | 状态,Unpaid未付款,Paid已付款,Cancelled已取消,Refunded已退款,WaitUpload待上传,WaitReview待审核,ReviewFail审核失败 |
data.order.gateway | string | 否 | — | 支付方式 |
data.order.credit | string | 否 | — | 使用余额,大于0代表订单使用了余额,和金额相同代表订单支付方式为余额 |
data.order.client_id | integer(int32) | 否 | — | 用户 ID |
data.order.client_name | string | 否 | — | 用户名称 |
data.order.notes | string | 否 | — | 备注 |
data.order.refund_amount | string | 否 | — | 订单已退款金额 |
data.order.amount_unpaid | string | 否 | — | 未支付金额 |
data.order.refundable_amount | string | 否 | — | 订单可退款金额 |
data.order.apply_credit_amount | string | 否 | — | 订单可应用余额金额 |
data.order.admin_id | integer(int32) | 否 | — | 管理员 ID |
data.order.admin_name | string | 否 | — | 管理员名称 |
data.order.is_recycle | integer(int32) | 否 | — | 是否在回收站,0否,1是 |
data.order.refund_orginal | integer(int32) | 否 | — | 订单支付方式退款时是否支持原路返回,1是,0否 |
data.order.voucher | [string] | 否 | — | 上传的凭证 |
data.order.review_fail_reason | string | 否 | — | 审核失败原因 |
data.order.refund_credit | string | 否 | — | 已退款余额 |
data.order.refund_gateway | string | 否 | — | 已退款渠道 |
data.order.gateway_sign | string | 否 | — | 支付接口标识,credit=余额,credit_limit=信用额 |
data.order.items | [object] | 否 | — | 订单子项 |
data.order.items[].id | integer(int32) | 否 | — | 订单子项 ID |
data.order.items[].description | string | 否 | — | 描述 |
data.order.items[].amount | string | 否 | — | 金额 |
data.order.items[].host_id | integer(int32) | 否 | — | 产品 ID |
data.order.items[].product_name | string | 否 | — | 商品名称 |
data.order.items[].host_name | string | 否 | — | 产品标识 |
data.order.items[].billing_cycle | string | 否 | — | 计费周期 |
data.order.items[].host_status | string | 否 | — | 产品状态,Unpaid未付款,Pending开通中,Active使用中,Suspended暂停,Deleted删除,Failed开通失败 |
data.order.items[].edit | integer(int32) | 否 | — | 是否可编辑,1是,0否 |
data.order.items[].profit | string | 否 | — | 利润 |
data.order.items[].agent | integer(int32) | 否 | — | 代理订单,1是,0否 |
data.self_defined_field | [object] | 否 | — | — |
data.self_defined_field[].id | integer(int32) | 否 | — | 自定义字段 ID |
data.self_defined_field[].field_name | string | 否 | — | 字段名称 |
data.self_defined_field[].field_type | string | 否 | — | 字段类型,text=文本框,link=链接,password=密码,dropdown=下拉,checkbox=勾选框,textarea=文本区 |
data.self_defined_field[].value | string | 否 | — | 当前值 |
失败状态码 400、401、403、404、500 共用以下结构：
| 名称 | 类型 | 必选 | 约束 | 说明 |
|---|---|---|---|---|
status | integer(int32) | 是 | — | 错误状态码 |
msg | string | 是 | — | 错误提示 |