WC_API_Orders::get_order_refunds( string $order_id, string|null $fields = null )
Get the order refunds for an order
Description Description
Parameters Parameters
- $order_id
-
(Required) order ID
- $fields
-
(Optional) fields to include in response
Default value: null
Return Return
(array|WP_Error)
Source Source
File: includes/legacy/api/v2/class-wc-api-orders.php
public function get_order_refunds( $order_id, $fields = null ) {
// Ensure ID is valid order ID
$order_id = $this->validate_request( $order_id, $this->post_type, 'read' );
if ( is_wp_error( $order_id ) ) {
return $order_id;
}
$refund_items = wc_get_orders( array(
'type' => 'shop_order_refund',
'parent' => $order_id,
'limit' => -1,
'return' => 'ids',
) );
$order_refunds = array();
foreach ( $refund_items as $refund_id ) {
$order_refunds[] = current( $this->get_order_refund( $order_id, $refund_id, $fields ) );
}
return array( 'order_refunds' => apply_filters( 'woocommerce_api_order_refunds_response', $order_refunds, $order_id, $fields, $refund_items, $this ) );
}
Changelog Changelog
| Version | Description |
|---|---|
| 2.2 | Introduced. |