WooOrderApi extension

WooCommerce Order API Extension

This extension provides comprehensive order management capabilities for WooCommerce stores. Orders represent customer purchases and contain all the information needed for fulfillment.

Key Features

  • Order Retrieval: Get orders with extensive filtering and pagination
  • Order Management: Create, update, and delete orders
  • Order Status Management: Track order lifecycle from pending to completed
  • Customer Orders: Retrieve orders for specific customers
  • Order Notifications: Send order details to customers via email
  • Advanced Filtering: Filter by status, customer, product, date, and more

Example Usage

// Get all orders
final orders = await wooCommerce.getOrders();

// Create a new order
final order = WooOrder(
  id: 0,
  status: WooOrderStatus.pending,
  total: 99.99,
);
final createdOrder = await wooCommerce.createOrder(order);

// Get orders for a specific customer
final customerOrders = await wooCommerce.getOrders(
  customer: 123,
  status: [WooOrderStatus.completed],
);
on

Methods

batchUpdateOrders(WooOrderBatchRequest request, {bool? useFaker}) → Future<WooOrderBatchResponse>

Available on WooCommerce, provided by the WooOrderApi extension

Performs batch operations on orders (create, update, delete) in a single request.
createOrder(WooOrder order, {bool? useFaker}) → Future<WooOrder>

Available on WooCommerce, provided by the WooOrderApi extension

Creates a new order in the WooCommerce store.
deleteOrder(int id, {bool? useFaker, bool force = false}) → Future<bool>

Available on WooCommerce, provided by the WooOrderApi extension

Deletes an order from the WooCommerce store.
getOrder(int id, {bool? useFaker}) → Future<WooOrder>

Available on WooCommerce, provided by the WooOrderApi extension

Retrieves a single order by its ID.
getOrders({WooContext context = WooContext.view, int page = 1, int perPage = 10, String? search, DateTime? after, DateTime? before, DateTime? modifiedAfter, DateTime? modifiedBefore, bool? datesAreGmt, List<int>? exclude, List<int>? include, int? offset, WooSortOrder order = WooSortOrder.desc, WooOrderOrderBy orderBy = WooOrderOrderBy.date, List<int>? parent, List<int>? parentExclude, List<WooOrderStatus> status = const [WooOrderStatus.any], int? customer, int? product, int? dp, bool? useFaker}) → Future<List<WooOrder>>

Available on WooCommerce, provided by the WooOrderApi extension

Retrieves a list of orders from the WooCommerce store.
sendOrderDetailsToCustomer(int orderId, {bool? useFaker}) → Future<String>

Available on WooCommerce, provided by the WooOrderApi extension

Sends order details to the customer via email.
updateOrder(WooOrder order, {bool? useFaker}) → Future<WooOrder>

Available on WooCommerce, provided by the WooOrderApi extension

Updates an existing order in the WooCommerce store.