WooCommerce tools
Every WooCommerce tool in the developer API, with arguments and examples: sales reports, orders, products and customers.
Needs: A WooCommerce store. 5 tools.
These tools appear in GET /v1/tools only when the API key's MCP server includes a connection of this kind. Call each one with POST /v1/tools/\<name>, sending its arguments as a JSON object. See Calling tools for the request and response format.
| Tool | What it does | Kind |
|---|---|---|
woocommerce_sales_report |
WooCommerce sales | Read |
woocommerce_list_orders |
List WooCommerce orders | Read |
woocommerce_get_order |
Read a WooCommerce order | Read |
woocommerce_search_products |
Search WooCommerce products | Read |
woocommerce_search_customers |
Search WooCommerce customers | Read |
The example requests fill in only the required arguments, with placeholder values.
woocommerce_sales_report
WooCommerce sales · Read
Sales for a period from a WooCommerce store: gross and net sales, orders, items sold, average order, tax, shipping, refunds and discounts, with a per-day (or per-month) breakdown and the best-selling products. Use it for 'how did the shop do' questions.
| Argument | Type | Required | What it is |
|---|---|---|---|
from |
string | Yes | YYYY-MM-DD |
to |
string | Yes | YYYY-MM-DD |
top_products |
integer | No | How many best-selling products to list. Default 10. |
account |
string | No | Store connection id from list_accounts (optional when there's only one) |
Example request:
curl -X POST https://app.plugsight.app/v1/tools/woocommerce_sales_report \
-H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
-H "Content-Type: application/json" \
-d '{"from": "2026-11-01", "to": "2026-11-15"}'
woocommerce_list_orders
List WooCommerce orders · Read
Orders, newest first, optionally by status, date range or a search (customer name, email, order number or product). Use woocommerce_get_order for the items, addresses and notes of one order.
| Argument | Type | Required | What it is |
|---|---|---|---|
status |
string | No | Status. One of: any, pending, processing, on-hold, completed, cancelled, refunded, failed, checkout-draft. Default "any". |
from |
string | No | YYYY-MM-DD |
to |
string | No | YYYY-MM-DD |
search |
string | No | Search text |
limit |
integer | No | Most results to return. Default 25. |
page |
integer | No | Page of results, from 1. Default 1. |
account |
string | No | Store connection id from list_accounts (optional when there's only one) |
Example request:
curl -X POST https://app.plugsight.app/v1/tools/woocommerce_list_orders \
-H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'
woocommerce_get_order
Read a WooCommerce order · Read
One order in full: items, totals, discounts, shipping, refunds, payment method, customer, addresses and order notes.
| Argument | Type | Required | What it is |
|---|---|---|---|
order_id |
integer | Yes | Order number |
account |
string | No | Store connection id from list_accounts (optional when there's only one) |
Example request:
curl -X POST https://app.plugsight.app/v1/tools/woocommerce_get_order \
-H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
-H "Content-Type: application/json" \
-d '{"order_id": 1}'
woocommerce_search_products
Search WooCommerce products · Read
Products by name or SKU, optionally only those out of stock or on backorder, with price, stock level and total sales. Sort by popularity to see best sellers of all time.
| Argument | Type | Required | What it is |
|---|---|---|---|
search |
string | No | Search text |
sku |
string | No | Product SKU |
stock_status |
string | No | Only products with this stock status. One of: instock, outofstock, onbackorder. |
orderby |
string | No | Sort products by. One of: popularity, date, title, price, rating. Default "popularity". |
limit |
integer | No | Most results to return. Default 25. |
page |
integer | No | Page of results, from 1. Default 1. |
account |
string | No | Store connection id from list_accounts (optional when there's only one) |
Example request:
curl -X POST https://app.plugsight.app/v1/tools/woocommerce_search_products \
-H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'
woocommerce_search_customers
Search WooCommerce customers · Read
Registered customers by name or email, with how many orders they placed and how much they spent. Newest first unless searching.
| Argument | Type | Required | What it is |
|---|---|---|---|
search |
string | No | Name or email |
limit |
integer | No | Most results to return. Default 25. |
page |
integer | No | Page of results, from 1. Default 1. |
account |
string | No | Store connection id from list_accounts (optional when there's only one) |
Example request:
curl -X POST https://app.plugsight.app/v1/tools/woocommerce_search_customers \
-H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'