🔒
Requires read_order access scope. More access scope

The Get All Refund Record List retrieve a paginated list of all refund records with detailed filtering options.

This API is especially useful for:

Request Parameters

📘
Public Request Parameters

Query Parameters

Parameter	Type	Required	Description	Example
`cursor`	string	No	Pagination cursor	`"next_page_token"`
`page_size`	int32	No	Results per page (default: 10)	`50`
`order_ids`	array[string]	No	Filter by order IDs (max 10)	`["ord_123","ord_456"]`
`refund_order_ids`	array[string]	No	Filter by refund record IDs (max 20)	`["ref_123","ref_456"]`
`refund_statuses`	array[string]	No	Filter by status: `pending`, `finished`, `failed`	`["finished"]`
`sort_by`	string	No	Sort field: `created_at` or `updated_at`	`"created_at"`
`sort_direction`	string	No	Sort order: `asc` or `desc`	`"desc"`
`created_at_start`	string	No	Filter records created after (ISO 8601)	`"2025-01-01T00:00:00Z"`
`created_at_end`	string	No	Filter records created before (ISO 8601)	`"2025-01-31T23:59:59Z"`
`updated_at_start`	string	No	Filter records updated after (ISO 8601)	`"2025-01-15T00:00:00Z"`
`updated_at_end`	string	No	Filter records updated before (ISO 8601)	`"2025-01-15T23:59:59Z"`

📘
Public Response Parameters

Parameter	Type	Example	Description
`code`	string	`"success"`	API response status code
`message`	string	`"Refund records retrieved"`	Response message
`data.records`	array[object]	-	Array of refund records
`data.records.id`	string	`"ref_123456"`	Refund record ID
`data.records.refund_price`	string	`"100.00"`	Total refund amount
`data.records.refund_shipping`	string	`"10.00"`	Shipping refund amount
`data.records.refund_status`	string	`"finished"`	Current status
`data.records.created_at`	string	`"2025-01-15T10:30:00Z"`	Creation timestamp
`data.records.order_id`	string	`"ord_123456"`	Original order ID
`data.records.refund_line_items`	array[object]	-	Refunded items
`data.records.refund_line_items.line_item_id`	string	`"li_123"`	Line item ID
`data.records.refund_line_items.refund_quantity`	int32	`1`	Quantity refunded
`data.records.payment_details`	array[object]	-	Payment refund details
`data.records.payment_details.payment_method`	string	`"credit_card"`	Payment method
`data.records.payment_details.refund_price`	string	`"100.00"`	Amount refunded
`data.cursor`	string	`"next_page_token"`	Pagination token
`data.has_more`	boolean	`true`	More records available

Field	Type	Example	Description
`code`	string	`InvalidParameter`	Error http message
`message`	string		Error message