Skip to main content
Glama

List orders

wp_wc_list_orders
Read-onlyIdempotent

Retrieve a paginated list of WooCommerce orders, newest first, with ID, status, total, customer name, email and ISO date. Filter by status or search term to find specific orders quickly.

Instructions

WooCommerce: list the shop's orders, newest first, one page at a time. Each item gives id, status, total, currency, customer (billing name), email and date (ISO 8601); pagination gives total and total_pages. Line items and payment method are in wp_wc_get_order. Read-only; needs manage_woocommerce. An order status the shop does not know is refused with the list of the ones it does. Requires WooCommerce.

Input Schema

NameRequiredDescriptionDefault
pageNoPage number, starting at 1. Default 1.
searchNoSearch term, handed to WooCommerce's own order search. Omitted: no search.
statusNoOnly orders in this status: one of the shop's statuses (pending, processing, on-hold, completed, cancelled, refunded, failed, plus any a plugin registers), with or without the wc- prefix, or trash. Omitted or any: the order statuses the shop has registered (wc_get_order_statuses), so not trash.
per_pageNoOrders per page, 1 to 100. Default 20.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv4.7.0

TDQS

A4.7/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Beyond the annotations, the description discloses permission requirements ('needs manage_woocommerce'), plugin dependency ('Requires WooCommerce'), and error behavior for unknown statuses. It also describes returned fields and pagination metadata, which helps the agent understand what a successful call yields.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is compact and front-loaded with the core action and scope. Every sentence adds useful information about returns, pagination, permissions, or error handling, with no filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Although there is no output schema, the description explains the returned fields and pagination shape. Annotations cover the safety profile, and the description fills in auth, dependency, and invalid-status behavior, leaving no major gap for an agent invoking this list tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the parameter documentation already carries most semantics. The description adds useful behavior around status handling, including that unknown statuses are refused with the valid list, but it does not add much beyond the schema for page, search, or per_page.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource ('list the shop's orders') plus scope details such as newest-first ordering and one-page-at-a-time behavior. It also distinguishes the tool from wp_wc_get_order by noting that line items and payment method live there, so an agent can tell the two apart.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives clear usage context: use this to list orders page by page, and use wp_wc_get_order for line items and payment method. It does not state broader exclusions or contrast with every relevant sibling, but the key alternative is explicitly named.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools