WOO API Extended Order Filters plugin enables various filters to be made within the listed products via /orders. With the installation of the plugin, parameters such as name, surname, e-mail, city, payment amount, update date, store name will also become available.

WOO API Extended Order Filters

WOO API Extended Order Filters plugin is a WordPress plugin that works with the WooCommerce REST API to filter /orders¹ response.

https://domain.com/wp-json/wc/v3/orders?[parametre]=[deger]

The use of the WooCommerce plugin is mandatory for the plugin to work. With the optional Dokar plugin, it becomes possible to perform store filtering operations. Below, the available parameters are listed with usage details.

Name & Surname

It provides the listing of orders according to the name and surname of the customer specified in the invoice information. The name parameter is defined for filtering the contact information. Example usage is ?name=John or ?name[first]=John for name and ?name[last]=Doe for surname.

E-mail

It provides a listing of orders according to the e-mail address to which the billing information is sent. The email parameter is defined for this filtering process. An Example usage can be ?email=john, ?email=john@doe.com, or with a specific domain name; ?email=gmail.com.

Telephone

It provides filtering of orders according to the phone number in the billing information. The phone parameter is used for this filtering process. Example usage is ?phone=555444322. Also can be used only the area code via the parameter; Like ?phone=532 or ?phone=+90.

City

It provides filtering of orders according to the city information specified in the cargo information. The city parameter is used for filtering. Example usage is ?city=istanbul.

Order Status Update Date

It enables filtering according to order-related updates (payment and shipping status updates, etc.).

The modified_after parameter is defined to list the orders according to a certain date before, and the modified_before parameter is defined to list the orders according to the date. Example usage is modified_after=2021-04-05 and modified_before=2021-04-05.

The date expression can be Year-Month-Day (%Y-%m-%d) , Year-Month (%Y-%m) or Year (%Y) .

Payment Total

The 'total' parameter defined in the plugin allows orders to be filtered according to a certain payment amount.

total will provide a filtering for the equal amount, while total[greater] will list orders greater than the specified amount and total[less] will list orders less than the specified amount. Example usage is ?total=100, ?total[greater]=100 and ?total[less]=100.

Payment Method

It allows orders to be filtered according to payment methods (bacs (wire transfer), Stripe, PayPal, check, cod (payment at the door), iyzico, etc.). The pmethod parameter is defined for this filtering operation. Example usage is ?pmethod=bacs.

Product ID

It allows to filter orders according to the product ID value in the content. The pid parameter is used for this operation. Example usage is ?pid=100.

Store & Multi-vendor

Dokan ² allows multi-store plugin users to filter orders by stores. Filtering can be done by store ID using the storeid parameter or by the store name with the storename parameter. Example usage is ?storeid=1 and storename=mystore.