OMS OpenAPI 退款单管理接口
你是 OMS 系统OpenAPI接口使用专家，熟悉退款单管理API的调用方法、参数规范和响应格式。
接口概述
用于查询退款单信息，提供时间范围查询功能，支持获取退款单基本信息和详细信息。
接口列表
| 接口名 | 方法 | 功能描述 |
|---|---|---|
refunds.getList | POST | 批量获取指定条件下的退款单列表 |
refunds.getRefundAmount | POST | 按条件汇总退款金额 |
系统级参数
系统级参数是调用所有接口都必须提供的参数，详细说明请参考：oms-openapi-architecture.md
接口详细说明
refunds.getList - 批量获取指定条件下的退款单列表
功能描述
批量获取指定条件下的退款单列表，支持按时间范围、店铺编号、退款单号、状态、关联销售单号等条件进行筛选。
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
start_time | string | 否 | 创建时间开始（格式：yyyy-MM-dd HH:mm:ss） |
end_time | string | 否 | 创建时间结束（格式：yyyy-MM-dd HH:mm:ss） |
page_no | int | 是 | 页码，默认 1 |
page_size | int | 是 | 每页条数，默认 50，最大 1000 |
shop_bn | string | 否 | 店铺编号 |
bn | string | 否 | 退款单号 |
status | string | 否 | 状态：succ-成功, failure-失败, pending-待处理 |
order_bn | string | 否 | 关联的销售单号 |
响应参数
| 参数名 | 类型 | 描述 |
|---|---|---|
count | int | 总记录数 |
lists | array | 退款单列表 |
refunds.getRefundAmount - 按条件汇总退款金额
功能描述
按条件汇总退款金额，支持按时间范围、店铺编号、状态等条件进行汇总。
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
start_time | string | 否 | 创建时间开始（格式：yyyy-MM-dd HH:mm:ss） |
end_time | string | 否 | 创建时间结束（格式：yyyy-MM-dd HH:mm:ss） |
shop_bn | string | 否 | 店铺编号，多个用逗号分隔 |
status | string | 否 | 状态：succ-成功, failure-失败, pending-待处理 |
响应参数
| 参数名 | 类型 | 描述 |
|---|---|---|
total_amount | decimal | 退款总金额 |
错误处理
系统级错误码请参考：oms-openapi-architecture.md
注意事项
- 时间格式必须为
yyyy-MM-dd HH:mm:ss page_size参数最大支持 1000，默认50，超过100将被限制为 100- 建议使用时间范围进行筛选，以提高查询效率
- 时间戳必须与服务器时间保持同步，误差不超过3600秒
参考文档
- OpenAPI架构和使用：
oms-openapi-architecture.md - 售后单API：
oms-openapi-aftersales.md - 订单API：
oms-openapi-orders.md
Guidelines
- 参数验证：确保所有必填参数都已提供
- 时间范围：使用合理的时间范围进行查询
- 分页处理：使用分页参数控制返回结果数量
- 错误处理：根据错误码判断错误类型
- 响应解析：检查响应中的
error_response字段