WooRefundApi extension

WooCommerce Refund API Extension

This extension provides comprehensive refund management capabilities for WooCommerce stores. It enables retrieval of refund information with extensive filtering and pagination options to help store owners track and manage order refunds effectively.

Key Features

  • Refund Retrieval: Get detailed refund information with comprehensive filtering
  • Advanced Filtering: Filter by date ranges, parent orders, and specific criteria
  • Pagination Support: Handle large datasets with page-based navigation
  • Search Capabilities: Find refunds by specific search terms
  • Sorting Options: Sort refunds by various attributes (date, amount, etc.)

Example Usage

// Get all refunds
final refunds = await wooCommerce.getRefunds();

// Get refunds for a specific order
final orderRefunds = await wooCommerce.getRefunds(
  parent: [123],
  perPage: 50,
);

// Search for refunds by reason
final searchResults = await wooCommerce.getRefunds(
  search: 'defective product',
  orderBy: WooSortOrderBy.date,
);
on

Methods

getRefunds({WooContext context = WooContext.view, int page = 1, int perPage = 10, String? search, DateTime? after, DateTime? before, List<int>? exclude, List<int>? include, int? offset, WooSortOrder order = WooSortOrder.desc, WooSortOrderBy orderBy = WooSortOrderBy.date, List<int>? parent, List<int>? parentExclude, int? dp, bool? useFaker}) → Future<List<WooRefund>>

Available on WooCommerce, provided by the WooRefundApi extension

Retrieves a list of refunds from the WooCommerce store.