智简魔方文档

GET 订单内页产品退款列表

接口概览

项目内容
文档类型后台接口
请求方式GET
接口地址/DIR_ADMIN/v1/order/{id}/host_refund
所属业务订单管理
来源模块/系统订单管理
认证方式Bearer Token(管理员令牌)

完整请求

请求

bash
正在加载示例…

失败请求

bash
正在加载示例…

接口说明

订单内页产品退款列表

请求参数

名称位置类型必选说明
idpathinteger(int32)是订单 ID
keywordsquerystring否关键字 商品名称 产品标识 备注

成功响应

json
正在加载示例…

失败响应 400:请求参数或业务校验失败

json
正在加载示例…

失败响应 401:未认证或登录已失效

json
正在加载示例…

失败响应 403:无权执行当前操作

json
正在加载示例…

失败响应 404:接口或业务资源不存在

json
正在加载示例…

失败响应 500:服务器内部错误

json
正在加载示例…

响应状态

状态码状态码含义说明数据模型
200OK成功响应内联对象
400Bad Request请求参数或业务校验失败内联对象
401Unauthorized未认证或登录已失效内联对象
403Forbidden无权执行当前操作内联对象
404Not Found接口或业务资源不存在内联对象
500Internal Server Error服务器内部错误内联对象

响应参数

状态码 200

名称类型必选约束说明
statusinteger(int32)否—状态码
msgstring否—提示信息
dataobject否——
data.list[object]否——
data.list[].idinteger(int32)否—订单子项 ID
data.list[].product_idinteger(int32)否—商品 ID
data.list[].host_idinteger(int32)否—产品 ID
data.list[].product_namestring否—商品名称
data.list[].host_namestring否—产品标识
data.list[].ip_numinteger(int32)否—IP 数量
data.list[].dedicate_ipstring否—主 IP
data.list[].assign_ipstring否—附加 IP
data.list[].descriptionstring否—描述
data.list[].host_statusstring否—产品状态 Unpaid未付款 Pending开通中 Active使用中 Suspended暂停 Deleted删除 Failed开通失败
data.list[].amountstring否—金额
data.list[].refund_creditstring否—退款余额金额
data.list[].refund_gatewaystring否—退款渠道金额
data.list[].refund_totalstring否—退款总金额
data.list[].refund_statusstring否—退款状态 not_refund=未退款 part_refund=部分退款 all_refund=全部退款 addon_refund=插件退款
data.list[].profitstring否—利润
data.list[].agentinteger(int32)否—代理订单 1是 0否

失败状态码 400、401、403、404、500 共用以下结构:

名称类型必选约束说明
statusinteger(int32)是—错误状态码
msgstring是—错误提示