版本:202506
查询退款记录列表
GET/openapi/2025-06/orders/refund_records
返回所有订单的退款记录,支持按订单 ID、退款记录 ID、状态、排序字段与方向、 创建/更新时间范围过滤,使用 cursor 分页。
请求
Query参数
- pending: 退款中。
- finished: 退款完成。
- failed: 退款失败。 示例:?refund_statuses=pending&refund_statuses=finished
created_at: 按创建时间排序updated_at: 按更新时间排序desc: 降序asc: 升序
cursor string
分页游标
page_size int32
每页记录数(1-100,默认 10)
order_ids string[]
按订单 ID 过滤,最多支持 10 个。 示例:?order_ids=1001&order_ids=1002
refund_order_ids string[]
按退款记录 ID 过滤,最多支持 20 个。 示例:?refund_order_ids=2001&refund_order_ids=2002
refund_statuses string[]
按退款状态过滤。
sort_by string
排序字段:
sort_direction string
排序方向:
created_at_start string
按创建时间过滤的起始值(如 2018-11-02T12:30:10Z)
created_at_end string
按创建时间过滤的结束值(如 2018-11-02T12:30:10Z)
updated_at_start string
按最后更新时间过滤的起始值(如 2018-11-02T12:30:10Z)
updated_at_end string
按最后更新时间过滤的结束值(如 2018-11-02T12:30:10Z)
响应
- 200
OK
- application/json
- 数据结构
- 示例
数据结构
- Array [
pending: 退款中finished: 退款完成failed: 退款失败- Array [
- ]
- Array [
pending: 退款中finished: 退款完成failed: 退款失败- ]
- Array [
- ]
- ]
codestring
错误码
messagestring
错误信息
data object
records object[]
退款记录列表
idstring
退款记录 ID
refund_pricestring
退款金额
refund_shippingstring
运费退款信息
refund_shipping_taxstring
退款运费税金额
refund_methodstring
退款方式
refund_statusstring
退款状态:
notestring
备注
created_atstring
退款记录创建时间(如 2018-11-02T12:30:10Z)
updated_atstring
退款记录最后更新时间(如 2018-11-02T12:30:10Z)
refund_line_items object[]
退款行项目列表
line_item_idstring
被退款的订单商品行 ID
refund_quantityint32
退款数量
taxstring
税费
discountstring
折扣信息
sub_totalstring
小计金额
totalstring
总计
delete_quantityint32
删除数量
payment_details object[]
支付详情列表
idstring
退款记录 ID
payment_line_idstring
支付行 ID
payment_channelstring
支付渠道
payment_methodstring
支付方式
refund_pricestring
退款金额
refund_statusstring
退款状态:
finished_atstring
退款完成时间
additional_totalstring
附加总额
additional_prices object[]
附加价格列表
namestring
附加费用名称
pricestring
附加费用金额
biz_idstring
业务 ID
fee_titlestring
自定义收费名称
refund_tipstring
小费退款金额
order_idstring
订单 ID
cursorstring
分页游标
has_moreboolean
是否有更多记录
{
"code": "string",
"message": "string",
"data": {
"records": [
{
"id": "string",
"refund_price": "string",
"refund_shipping": "string",
"refund_shipping_tax": "string",
"refund_method": "string",
"refund_status": "string",
"note": "string",
"created_at": "string",
"updated_at": "string",
"refund_line_items": [
{
"line_item_id": "string",
"refund_quantity": 0,
"tax": "string",
"discount": "string",
"sub_total": "string",
"total": "string",
"delete_quantity": 0
}
],
"payment_details": [
{
"id": "string",
"payment_line_id": "string",
"payment_channel": "string",
"payment_method": "string",
"refund_price": "string",
"refund_status": "string",
"finished_at": "string"
}
],
"additional_total": "string",
"additional_prices": [
{
"name": "string",
"price": "string",
"biz_id": "string",
"fee_title": "string"
}
],
"refund_tip": "string",
"order_id": "string"
}
],
"cursor": "string",
"has_more": true
}
}