Connect your store
To let an agent read your WooCommerce orders, products, customers and stock, create a REST API key in WooCommerce and connect it to the agent.
Only agents with WooCommerce tools need a store connection. Without one, they ask you to paste the details instead.
Create a WooCommerce REST API key
- In your WordPress admin, go to WooCommerce → Settings → Advanced → REST API.
- Click Add key.
-
Fill in the form:
- Description: a name you will recognize later.
- User: a WordPress user who can manage the shop, such as a Shop Manager.
- Permissions: Read is enough for agents that only report or write copy. Choose Read/Write if an agent needs to add order notes or change stock.
- Click Generate API key. WooCommerce shows the Consumer key and Consumer secret once, so copy both now.
Connect the key
- Open the agent from Agents in the sidebar.
- In the Your setup card, find the WooCommerce tool under Connections and press Connect.
-
Enter:
- Store URL: the address of your store, for example
https://shop.example.com. - Consumer Key: starts with
ck_. - Consumer Secret: starts with
cs_.
- Store URL: the address of your store, for example
You can also save the key once under Credentials in the sidebar (choose WooCommerce REST API) and pick it from the list when you connect each agent.
What agents can do with your store
An agent can use only the tools it was built with. These are the WooCommerce tools:
| Tool | What it does |
|---|---|
wc_get_orders |
Lists orders. Can filter by status, by date (after, before) and by a search on customer name, email or order number. Returns up to 20 at a time. |
wc_get_order |
Reads one order by ID: line items, shipping, billing, payment method and order notes. |
wc_create_order_note |
Adds a note to an order. Notes are internal unless customer_note is true, in which case the customer can see it and WooCommerce emails them. |
wc_get_products |
Lists products with name, SKU, price, stock and status. Can search by name or SKU, filter by status and sort. |
wc_get_product |
Reads one product by ID: name, SKU, price, stock, attributes, categories and images. |
wc_update_product_stock |
Sets the stock quantity of a product and turns on stock management for it. The change applies to your live store immediately. |
wc_low_stock_products |
Lists products that are low in stock or out of stock. |
wc_get_customers |
Lists customers with their name, email, number of orders and total spend. Can search by name or email. |
wc_sales_report |
Reads the sales summary for a period (week, month, last month or year) or a date range: total sales, number of orders, average order value and net sales. |
Read-only keys
With a Read key,wc_create_order_note and wc_update_product_stock are refused by your store, and the run reports the error.
Security
- Your consumer key and secret are stored encrypted (AES-256). They are not shown again after you save them, and our support staff cannot see them.
- The platform only connects to public addresses. Private, local and cloud metadata addresses are refused.
To disconnect the platform from your store, revoke the key in WordPress under WooCommerce → Settings → Advanced → REST API. Requests made with it stop working straight away.