Skip to content

订单管理 ​

订单列表 ​

项目内容
接口描述订单列表
接口地址/console/v1/order
请求方式GET
接口版本v1

请求参数

nametypedefaultvalidatedesc
keywordsstring-搜索范围订单IDvalidate:optionaldesc:关键字
typestring-new新订单renew续费订单upgrade升降级订单artificial人工订单validate:optionaldesc:类型
statusstring-Unpaid未付款Paid已付款validate:optionaldesc:状态
pageint-validate:optionaldesc:页数
limitint-validate:optionaldesc:每页条数
orderbystring-idtypecreate_timeamountstatusvalidate:optionaldesc:排序字段
sortstring-ascdescvalidate:optionaldesc:升降序

响应参数

nametypedefaultdesc
listarray-desc:订单列表
list[].idint-desc:订单ID
list[].typestring-desc:类型
list[].create_timeint-desc:创建时间
list[].amountstring-desc:金额
list[].statusstring-desc:状态
list[].gatewaystring-desc:支付方式
list[].creditfloat-desc:使用余额
list[].host_namestring-desc:产品标识
list[].descriptionstring-desc:描述
list[].product_namesarray-desc:订单下所有产品的商品名称
list[].host_idint-desc:产品ID
list[].order_item_countint-desc:订单子项数量
list[].voucherarray-desc:上传的凭证
list[].review_fail_reasonstring-desc:审核失败原因
countint-desc:订单总数

订单详情 ​

项目内容
接口描述订单详情
接口地址/console/v1/order/:id
请求方式GET
接口版本v1

请求参数

nametypedefaultvalidatedesc
idint-validate:requireddesc:订单ID

响应参数

nametypedefaultdesc
orderobject-desc:产品
order.idint-desc:订单ID
order.typestring-desc:类型
order.amountstring-desc:金额
order.create_timeint-desc:创建时间
order.pay_timeint-desc:支付时间
order.statusstring-desc:状态
order.gatewaystring-desc:支付方式
order.creditstring-desc:使用余额
order.notesstring-desc:备注
order.refund_amountstring-desc:订单已退款金额
order.amount_unpaidstring-desc:未支付金额
order.voucherarray-desc:上传的凭证
order.review_fail_reasonstring-desc:审核失败原因
order.unpaid_timeoutint-desc:未支付超时时间
order.remain_pay_timeint-desc:剩余支付时间
order.itemsarray-desc:订单子项
order.items[].idint-desc:订单子项ID
order.items[].descriptionstring-desc:描述
order.items[].amountstring-desc:金额
order.items[].host_idint-desc:产品ID
order.items[].product_namestring-desc:商品名称
order.items[].host_namestring-desc:产品标识
order.items[].billing_cyclestring-desc:计费周期
order.items[].host_statusstring-desc:产品状态
self_defined_field[].idint-desc:自定义字段ID
self_defined_field[].field_namestring-desc:字段名称
self_defined_field[].field_typestring-desc:字段类型
self_defined_field[].valuestring-desc:当前值

删除订单 ​

项目内容
接口描述删除订单
接口地址/console/v1/order/:id
请求方式DELETE
接口版本v1

请求参数

nametypedefaultvalidatedesc
idint-validate:requireddesc:订单ID

响应参数

无

批量删除订单 ​

项目内容
接口描述批量删除订单
接口地址/console/v1/order
请求方式DELETE
接口版本v1

请求参数

nametypedefaultvalidatedesc
idarray-validate:requireddesc:订单ID

响应参数

无

订单列表导出EXCEL ​

项目内容
接口描述订单列表导出EXCEL
接口地址/console/v1/order/export_excel
请求方式GET
接口版本v1

请求参数

nametypedefaultvalidatedesc
keywordsstring-搜索范围订单IDvalidate:optionaldesc:关键字
typestring-new新订单renew续费订单upgrade升降级订单artificial人工订单validate:optionaldesc:类型
statusstring-Unpaid未付款Paid已付款validate:optionaldesc:状态
pageint-validate:optionaldesc:页数
limitint-validate:optionaldesc:每页条数
orderbystring-idtypecreate_timeamountstatusvalidate:optionaldesc:排序字段
sortstring-ascdescvalidate:optionaldesc:升降序

响应参数

无

银行转账提交申请 ​

项目内容
接口描述银行转账提交申请
接口地址/console/v1/order/:id/submit_application
请求方式POST
接口版本v1

请求参数

nametypedefaultvalidatedesc
idint-validate:requireddesc:订单ID

响应参数

无

其他文档字段

json
{
  "时间": "2024-07-19"
}

上传凭证 ​

项目内容
接口描述上传凭证
接口地址/console/v1/order/:id/voucher
请求方式PUT
接口版本v1

请求参数

nametypedefaultvalidatedesc
idint-validate:requireddesc:订单ID
voucherarray-上传后的文件名validate:requireddesc:上传的凭证

响应参数

无

其他文档字段

json
{
  "时间": "2024-07-19"
}

变更支付方式 ​

项目内容
接口描述变更支付方式
接口地址/console/v1/order/:id/gateway
请求方式PUT
接口版本v1

请求参数

nametypedefaultvalidatedesc
idint-validate:requireddesc:订单ID

响应参数

无

其他文档字段

json
{
  "时间": "2024-07-22"
}

订单交易记录 ​

项目内容
接口描述订单交易记录
接口地址/console/v1/order/:id/transaction_record
请求方式GET
接口版本v1

请求参数

nametypedefaultvalidatedesc
idint-validate:requireddesc:订单ID

响应参数

nametypedefaultdesc
list[].create_timeint-desc:交易时间
list[].host_idint-desc:产品ID
list[].host_namestring-desc:产品标识
list[].product_idint-desc:商品ID
list[].product_namestring-desc:商品名称
list[].descriptionstring-desc:描述
list[].amountstring-desc:金额

其他文档字段

json
{
  "时间": "2024-12-03"
}

合并按需订单 ​

项目内容
接口描述合并按需订单
接口地址/console/v1/order/on_demand/combine
请求方式POST
接口版本v1

请求参数

nametypedefaultvalidatedesc
idsarray-数组validate:requireddesc:订单ID

响应参数

nametypedefaultdesc
idint-desc:合并后的订单ID
amountstring-desc:合并后的订单金额

其他文档字段

json
{
  "时间": "2025-04-11"
}