退款单管理 API

1. 接口概述

用于查询退款单信息，提供时间范围查询功能，支持获取退款单基本信息和详细信息。

2. 接口列表

接口名	方法	功能描述
refunds.getList	POST	批量获取指定条件下的退款单列表
refunds.getRefundAmount	POST	按条件汇总退款金额

3. 系统级参数

系统级参数是调用所有接口都必须提供的参数：

参数名	类型	必填	名称	描述
flag	string	是	应用标识	用于标识调用方身份
method	string	是	接口方法名	例如：refunds.getList
ver	number	是	版本号	固定为1
charset	string	是	字符集	固定为utf-8
type	string	是	返回格式	固定为json
timestamp	string	是	时间戳	格式：yyyyMMddHHmmss
sign	string	是	签名	用于验证请求的合法性

4. 接口详细说明

4.1 批量获取指定条件下的退款单列表

请求参数

参数名	类型	必填	描述
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	退款单列表

lists 数组中的每个对象包含以下字段：

参数名	类型	描述
bn	string	退款单号
shop_bn	string	店铺编号
shop_name	string	店铺名称
order_bn	string	关联的销售单号
total_amount	decimal	退款总金额
status	string	状态
createtime	string	创建时间
updatetime	string	更新时间

请求示例

请参考openapi.md文档中【6. 接口调用示例】。

响应示例

{
  "count": 100,
  "lists": [
    {
      "bn": "REFUND202401010001",
      "shop_bn": "SHOP001",
      "shop_name": "测试店铺",
      "order_bn": "SALES202401010001",
      "total_amount": 1000.00,
      "status": "succ",
      "createtime": "2024-01-01 10:00:00",
      "updatetime": "2024-01-01 10:00:00"
    }
  ]
}

4.2 按条件汇总退款金额

请求参数

参数名	类型	必填	描述
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	退款总金额

请求示例

请参考openapi.md文档中【6. 接口调用示例】。

响应示例

{
  "total_amount": 5000.00
}

5. 错误码说明

错误码	错误信息	解决方案
0	成功	-
1	参数错误	检查参数格式是否正确，所有必填参数是否都已提供
400	参数错误	检查参数格式是否正确，所有必填参数是否都已提供
401	未授权访问	检查flag和sign是否正确
403	禁止访问	联系管理员获取权限
500	服务器内部错误	检查请求参数或联系技术支持
1001	非法的flag	请检查flag是否正确
1002	请求已过期	请检查timestamp是否正确，请求有效期为5分钟
1003	签名错误	请检查签名算法和参数是否正确
1004	不支持的type格式	请使用json格式
2001	缺少必要的参数	请检查请求参数是否完整
2002	非法的请求参数	请检查参数格式和范围是否正确
2003	接口不存在	请检查接口方法名是否正确

6. 注意事项

1. 时间格式必须为 yyyy-MM-dd HH:mm:ss，否则可能导致查询失败。
2. page_size 参数最大支持 1000，默认50，超过100将被限制为 100。
3. 对于大数据量的查询，建议使用时间范围进行筛选，以提高查询效率。
4. 时间戳必须与服务器时间保持同步，误差不超过3600秒。
5. 每个请求必须生成唯一的签名，避免重复提交。
6. 请妥善保管接口密钥，避免泄露。
7. 所有请求参数中的特殊字符必须进行 URL 编码，特别是在使用 GET 方法时。
8. 请确保在请求头中设置正确的 Content-Type，对于 POST 请求建议使用 application/json。
9. 为了系统性能和稳定性，请避免短时间内发送大量请求，建议控制调用频率。
10. 敏感数据（如签名、密钥等）请勿在日志中记录，确保数据安全。