主题
订单管理
订单列表
| 项目 | 内容 |
|---|---|
| 接口描述 | 订单列表 |
| 接口地址 | /console/v1/order |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| keywords | string | - | 搜索范围订单IDvalidate:optional | desc:关键字 |
| type | string | - | new新订单renew续费订单upgrade升降级订单artificial人工订单validate:optional | desc:类型 |
| status | string | - | Unpaid未付款Paid已付款validate:optional | desc:状态 |
| page | int | - | validate:optional | desc:页数 |
| limit | int | - | validate:optional | desc:每页条数 |
| orderby | string | - | idtypecreate_timeamountstatusvalidate:optional | desc:排序字段 |
| sort | string | - | ascdescvalidate:optional | desc:升降序 |
响应参数
| name | type | default | desc |
|---|---|---|---|
| list | array | - | desc:订单列表 |
| list[].id | int | - | desc:订单ID |
| list[].type | string | - | desc:类型 |
| list[].create_time | int | - | desc:创建时间 |
| list[].amount | string | - | desc:金额 |
| list[].status | string | - | desc:状态 |
| list[].gateway | string | - | desc:支付方式 |
| list[].credit | float | - | desc:使用余额 |
| list[].host_name | string | - | desc:产品标识 |
| list[].description | string | - | desc:描述 |
| list[].product_names | array | - | desc:订单下所有产品的商品名称 |
| list[].host_id | int | - | desc:产品ID |
| list[].order_item_count | int | - | desc:订单子项数量 |
| list[].voucher | array | - | desc:上传的凭证 |
| list[].review_fail_reason | string | - | desc:审核失败原因 |
| count | int | - | desc:订单总数 |
订单详情
| 项目 | 内容 |
|---|---|
| 接口描述 | 订单详情 |
| 接口地址 | /console/v1/order/:id |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | validate:required | desc:订单ID |
响应参数
| name | type | default | desc |
|---|---|---|---|
| order | object | - | desc:产品 |
| order.id | int | - | desc:订单ID |
| order.type | string | - | desc:类型 |
| order.amount | string | - | desc:金额 |
| order.create_time | int | - | desc:创建时间 |
| order.pay_time | int | - | desc:支付时间 |
| order.status | string | - | desc:状态 |
| order.gateway | string | - | desc:支付方式 |
| order.credit | string | - | desc:使用余额 |
| order.notes | string | - | desc:备注 |
| order.refund_amount | string | - | desc:订单已退款金额 |
| order.amount_unpaid | string | - | desc:未支付金额 |
| order.voucher | array | - | desc:上传的凭证 |
| order.review_fail_reason | string | - | desc:审核失败原因 |
| order.unpaid_timeout | int | - | desc:未支付超时时间 |
| order.remain_pay_time | int | - | desc:剩余支付时间 |
| order.items | array | - | desc:订单子项 |
| order.items[].id | int | - | desc:订单子项ID |
| order.items[].description | string | - | desc:描述 |
| order.items[].amount | string | - | desc:金额 |
| order.items[].host_id | int | - | desc:产品ID |
| order.items[].product_name | string | - | desc:商品名称 |
| order.items[].host_name | string | - | desc:产品标识 |
| order.items[].billing_cycle | string | - | desc:计费周期 |
| order.items[].host_status | string | - | desc:产品状态 |
| self_defined_field[].id | int | - | desc:自定义字段ID |
| self_defined_field[].field_name | string | - | desc:字段名称 |
| self_defined_field[].field_type | string | - | desc:字段类型 |
| self_defined_field[].value | string | - | desc:当前值 |
删除订单
| 项目 | 内容 |
|---|---|
| 接口描述 | 删除订单 |
| 接口地址 | /console/v1/order/:id |
| 请求方式 | DELETE |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | validate:required | desc:订单ID |
响应参数
无
批量删除订单
| 项目 | 内容 |
|---|---|
| 接口描述 | 批量删除订单 |
| 接口地址 | /console/v1/order |
| 请求方式 | DELETE |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | array | - | validate:required | desc:订单ID |
响应参数
无
订单列表导出EXCEL
| 项目 | 内容 |
|---|---|
| 接口描述 | 订单列表导出EXCEL |
| 接口地址 | /console/v1/order/export_excel |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| keywords | string | - | 搜索范围订单IDvalidate:optional | desc:关键字 |
| type | string | - | new新订单renew续费订单upgrade升降级订单artificial人工订单validate:optional | desc:类型 |
| status | string | - | Unpaid未付款Paid已付款validate:optional | desc:状态 |
| page | int | - | validate:optional | desc:页数 |
| limit | int | - | validate:optional | desc:每页条数 |
| orderby | string | - | idtypecreate_timeamountstatusvalidate:optional | desc:排序字段 |
| sort | string | - | ascdescvalidate:optional | desc:升降序 |
响应参数
无
银行转账提交申请
| 项目 | 内容 |
|---|---|
| 接口描述 | 银行转账提交申请 |
| 接口地址 | /console/v1/order/:id/submit_application |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | validate:required | desc:订单ID |
响应参数
无
其他文档字段
json
{
"时间": "2024-07-19"
}上传凭证
| 项目 | 内容 |
|---|---|
| 接口描述 | 上传凭证 |
| 接口地址 | /console/v1/order/:id/voucher |
| 请求方式 | PUT |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | validate:required | desc:订单ID |
| voucher | array | - | 上传后的文件名validate:required | desc:上传的凭证 |
响应参数
无
其他文档字段
json
{
"时间": "2024-07-19"
}变更支付方式
| 项目 | 内容 |
|---|---|
| 接口描述 | 变更支付方式 |
| 接口地址 | /console/v1/order/:id/gateway |
| 请求方式 | PUT |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | validate:required | desc:订单ID |
响应参数
无
其他文档字段
json
{
"时间": "2024-07-22"
}订单交易记录
| 项目 | 内容 |
|---|---|
| 接口描述 | 订单交易记录 |
| 接口地址 | /console/v1/order/:id/transaction_record |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| id | int | - | validate:required | desc:订单ID |
响应参数
| name | type | default | desc |
|---|---|---|---|
| list[].create_time | int | - | desc:交易时间 |
| list[].host_id | int | - | desc:产品ID |
| list[].host_name | string | - | desc:产品标识 |
| list[].product_id | int | - | desc:商品ID |
| list[].product_name | string | - | desc:商品名称 |
| list[].description | string | - | desc:描述 |
| list[].amount | string | - | desc:金额 |
其他文档字段
json
{
"时间": "2024-12-03"
}合并按需订单
| 项目 | 内容 |
|---|---|
| 接口描述 | 合并按需订单 |
| 接口地址 | /console/v1/order/on_demand/combine |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| ids | array | - | 数组validate:required | desc:订单ID |
响应参数
| name | type | default | desc |
|---|---|---|---|
| id | int | - | desc:合并后的订单ID |
| amount | string | - | desc:合并后的订单金额 |
其他文档字段
json
{
"时间": "2025-04-11"
}