WooCommerce

Let your agents manage your WooCommerce store — list and create orders, manage products, customers, coupons, and retrieve sales reports via the REST API.

Connection

Authentication: API key (Consumer key:Consumer secret).
Required settings:
- Store domain — The domain of your WooCommerce store, without https:// or trailing slash. Must use HTTPS and have pretty permalinks enabled.

In your WordPress admin, go to WooCommerce → Settings → Advanced → REST API → Add Key. Name the key, choose the user, set permissions to Read/Write, then copy both the Consumer Key and Consumer Secret. Paste them as consumer_key:consumer_secret (both values, separated by a colon) in the field below. Pretty permalinks must be enabled in Settings → Permalinks.See WooCommerce’s documentation.

Read actions (13)

Action	Description
`get_customer`	Retrieve a single customer by ID.
`get_order`	Retrieve a single order by ID.
`get_product`	Retrieve a single product by ID, including variants and images.
`list_coupons`	List coupons. Filter by search term or code. Supports pagination.
`list_customers`	List customers. Filter by search term, email, or role. Supports pagination.
`list_order_notes`	List all notes for an order.
`list_orders`	List orders. Filter by status, customer, date range, or search term. Supports pagination.
`list_product_categories`	List product categories. Filter by search term or parent category.
`list_product_variations`	List all variations for a variable product.
`list_products`	List products. Filter by search term, status, SKU, category, tag, or stock status. Supports pagination.
`orders_totals`	Retrieve orders total counts by status.
`products_totals`	Retrieve products total counts by status.
`sales_report`	Retrieve sales report. Filter by period (week, month, last_month, year) or by date range.

Write actions (7)

Action	Description
`add_order_note`	Add a note to an order. Required: note (string, the note content). Optional: customer_note (boolean, if true the note is visible to the customer).
`create_coupon`	Create a coupon. Required: code (string, the coupon code). Optional: discount_type (string: percent\|fixed_cart\|fixed_product), amount (string, the discount amount), individual_use (boolean), exclude_sale_items (boolean), minimum_amount (string, decimal minimum cart total), date_expires (string, ISO 8601 date), usage_limit (integer).
`create_customer`	Create a customer. Required: email (string). Optional: first_name (string), last_name (string), username (string), billing (object with first_name, last_name, address_1, city, postcode, country, email, phone), shipping (object with first_name, last_name, address_1, city, postcode, country).
`create_order`	Create an order. Required: payment_method (string, e.g. “bacs”), line_items (array of {product_id: integer, quantity: integer, variation_id?: integer}). Optional: payment_method_title (string), set_paid (boolean), status (string: pending\|processing\|on-hold\|completed\|cancelled\|refunded\|failed), customer_id (integer), billing (object with first_name, last_name, address_1, city, postcode, country, email, phone), shipping (object with first_name, last_name, address_1, city, postcode, country), shipping_lines (array of {method_id: string, method_title: string, total: string}), customer_note (string).
`create_product`	Create a product. Required: name (string). Optional: type (string: simple\|grouped\|external\|variable), regular_price (string, decimal price), description (string, HTML), short_description (string, HTML), sku (string), categories (array of {id: integer}), manage_stock (boolean), stock_quantity (integer), status (string: draft\|pending\|private\|publish).
`update_order`	Update an order by ID. Modifiable fields: status (string: pending\|processing\|on-hold\|completed\|cancelled\|refunded\|failed), customer_note (string), set_paid (boolean).
`update_product`	Update a product by ID. Modifiable fields: regular_price (string, decimal price), sale_price (string, decimal price), status (string: draft\|pending\|private\|publish), stock_quantity (integer), manage_stock (boolean), stock_status (string: instock\|outofstock\|onbackorder), description (string, HTML), short_description (string, HTML).

Permissions

Every action above must be explicitly granted to an agent before it can be used. See Permissions for the grant model and Security for how credentials are protected.

Using integrations

Communication

Scheduling

Project management

Docs & design

Files & storage

CRM & sales

Customer support

HR & recruiting

Commerce & billing

Developer tools

Observability & analytics

AI & media

Connection

Read actions (13)

Write actions (7)

Permissions

​Connection

​Read actions (13)

​Write actions (7)

​Permissions

Connection

Read actions (13)

Write actions (7)

Permissions