List refund records

GET 
/openapi/2025-06/orders/refund_records

Returns refund records across all orders, paginated via cursor and filtered by order IDs, refund record IDs, status, sort field/direction, and create/ update time ranges.

Request

Query Parameters

cursor string

Cursor for pagination

page_size int32

Page size (1-100, default 10)

order_ids string[]

Filter by order IDs. Up to 10 IDs are supported. Example: ?order_ids=1001&order_ids=1002

refund_order_ids string[]

Filter by refund record IDs. Up to 20 IDs are supported. Example: ?refund_order_ids=2001&refund_order_ids=2002

refund_statuses string[]
Filter by refund status.
• pending: refund in progress.
• finished: refund completed.
• failed: refund failed. Example: ?refund_statuses=pending&refund_statuses=finished
sort_by string
Field used to sort the result list:
• created_at: sort by creation time
• updated_at: sort by last update time
sort_direction string
Sort direction:
• desc: descending order
• asc: ascending order
created_at_start string

Filter records created at or after this time (e.g., 2018-11-02T12:30:10Z)

created_at_end string

Filter records created at or before this time (e.g., 2018-11-02T12:30:10Z)

updated_at_start string

Filter records last updated at or after this time (e.g., 2018-11-02T12:30:10Z)

updated_at_end string

Filter records last updated at or before this time (e.g., 2018-11-02T12:30:10Z)

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

records object[]

List of refund records

Array [

idstring

Refund record ID

refund_pricestring

Refund price

refund_shippingstring

Shipping refund

refund_shipping_taxstring

Refund Shipping Tax

refund_methodstring

Refund method

refund_statusstring

Refund status:

• pending: refund in progress
• finished: refund completed
• failed: refund failed

notestring

Note

created_atstring

Time when the refund record was created (e.g., 2018-11-02T12:30:10Z)

updated_atstring

Time when the refund record was last updated (e.g., 2018-11-02T12:30:10Z)

refund_line_items object[]

List of refund line items

Array [

line_item_idstring

ID of the order line item being refunded

refund_quantityint32

Refund quantity

taxstring

Tax

discountstring

Discount

sub_totalstring

Subtotal

totalstring

Total

delete_quantityint32

Delete quantity

]

payment_details object[]

Payment details

Array [

idstring

Refund record ID

payment_line_idstring

Payment line ID

payment_channelstring

Payment channel

payment_methodstring

Payment method

refund_pricestring

Refund price

refund_statusstring

Refund status:

• pending: refund in progress
• finished: refund completed
• failed: refund failed

finished_atstring

Time when the refund was completed

]

additional_totalstring

Additional total

additional_prices object[]

Additional prices

Array [

namestring

Name of the additional charge

pricestring

Amount of the additional charge

biz_idstring

Business ID

fee_titlestring

Custom Charge Name

]

refund_tipstring

Tip refund amount

order_idstring

Order ID

]

cursorstring

Cursor for pagination

has_moreboolean

Whether there are more records

Example

{
  "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
  }
}