Woocommerce

The Woocommerce agent connector is a Python package that equips AI agents to interact with Woocommerce through strongly typed, well-documented tools. It's ready to use directly in your Python app, in an agent framework, or exposed through an MCP.

Connector for the WooCommerce REST API (v3). Provides read access to a WooCommerce store's customers, orders, products, coupons, product categories, tags, reviews, attributes, variations, order notes, refunds, payment gateways, shipping methods, shipping zones, tax rates, and tax classes. Requires a WooCommerce store URL and REST API consumer key / consumer secret for authentication.

Example questions

The Woocommerce connector is optimized to handle prompts like these.

List all customers in WooCommerce
Show me all orders
List all products
Show me all coupons
List all product categories
Show me the product reviews
List all shipping zones
Show me the tax rates
List all payment gateways
Find orders placed this month
What are the top-selling products?
Show me customers who have made purchases
Find all coupons expiring this year
What orders are still processing?

Unsupported questions

The Woocommerce connector isn't currently able to handle prompts like these.

Create a new product
Update an order status
Delete a customer
Apply a coupon to an order
Process a refund

Installation

uv pip install airbyte-agent-sdk

Usage

Connectors can run in open source or hosted mode.

Open source

In open source mode, you provide API credentials directly to the connector.

from airbyte_agent_sdk.connectors.woocommerce import WoocommerceConnector
from airbyte_agent_sdk.connectors.woocommerce.models import WoocommerceAuthConfig

connector = WoocommerceConnector(
    auth_config=WoocommerceAuthConfig(
        api_key="<WooCommerce REST API consumer key (starts with ck_)>",
        api_secret="<WooCommerce REST API consumer secret (starts with cs_)>"
    )
)

@agent.tool_plain # assumes you're using Pydantic AI
@WoocommerceConnector.tool_utils
async def woocommerce_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})

Hosted

In hosted mode, API credentials are stored securely in Airbyte Cloud. You provide your Airbyte credentials instead. If your Airbyte client can access multiple organizations, also set organization_id.

This example assumes you've already authenticated your connector with Airbyte. See Authentication to learn more about authenticating. If you need a step-by-step guide, see the hosted execution tutorial.

from airbyte_agent_sdk.connectors.woocommerce import WoocommerceConnector, AirbyteAuthConfig

connector = WoocommerceConnector(
    auth_config=AirbyteAuthConfig(
        workspace_name="<your_workspace_name>",
        organization_id="<your_organization_id>",  # Optional for multi-org clients
        airbyte_client_id="<your-client-id>",
        airbyte_client_secret="<your-client-secret>"
    )
)

@agent.tool_plain # assumes you're using Pydantic AI
@WoocommerceConnector.tool_utils
async def woocommerce_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})

Full documentation

Entities and actions

This connector supports the following entities and actions. For more details, see this connector's full reference documentation.

Entity	Actions
Customers	List, Get, Context Store Search
Orders	List, Get, Context Store Search
Products	List, Get, Context Store Search
Coupons	List, Get, Context Store Search
Product Categories	List, Get, Context Store Search
Product Tags	List, Get, Context Store Search
Product Reviews	List, Get, Context Store Search
Product Attributes	List, Get, Context Store Search
Product Variations	List, Get, Context Store Search
Order Notes	List, Get, Context Store Search
Refunds	List, Get, Context Store Search
Payment Gateways	List, Get, Context Store Search
Shipping Methods	List, Get, Context Store Search
Shipping Zones	List, Get, Context Store Search
Tax Rates	List, Get, Context Store Search
Tax Classes	List, Context Store Search

Authentication

For all authentication options, see the connector's authentication documentation.

Woocommerce API docs

See the official Woocommerce API reference.

Version information

Package version: 1.0.4
Connector version: 1.0.4
Generated with Connector SDK commit SHA: unknown

Example questions​

Unsupported questions​

Installation​

Usage​

Open source​

Hosted​

Full documentation​

Entities and actions​

Authentication​

Woocommerce API docs​

Version information​