Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to WooCommerce

Scalekit connector
Open markdown

The WooCommerce connector lets your AI agent work with WooCommerce. Scalekit handles authentication for every call, so your agent never handles credentials. It comes with 23 tools.

Tools
23
What they doRead · write · destructive
13 · 10 · 013 read10 write0 destructive
Users sign in with

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>
  3. Create the WooCommerce connection

    In AgentKit > Connections, create a WooCommerce connection. The name you give it is the connection_name your code passes. See Configure connections.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • woocommerce_coupons_listList coupons in the WooCommerce store, optionally filtered by code, search text or creation date.Read-only

    List Coupons

    List coupons in the WooCommerce store, optionally filtered by code, search text or creation date. Returns each coupon's id, code, discount type and amount, expiry date, usage count and limits, and product and email restrictions. Use woocommerce_coupons_list to find a coupon or check whether a code exists. Use woocommerce_coupon_create to add a coupon.

    Inputs

    afterstring
    Only return coupons created after this date. ISO 8601 date-time in the store's timezone. Example: 2025-01-01T00:00:00.
    beforestring
    Only return coupons created before this date. ISO 8601 date-time in the store's timezone. Example: 2025-01-01T00:00:00.
    codestring
    Only return the coupon with this exact code. Example: 10off.
    excludestring
    Comma-separated list of coupon IDs to leave out of the results. Example: 12,15,27.
    includestring
    Comma-separated list of coupon IDs to limit the results to. Example: 12,15,27.
    orderstring
    Sort direction: asc for ascending or desc for descending. WooCommerce defaults to desc.one of ascdesc
    orderbystring
    Field to sort coupons by: date, modified, id, include, title or slug. WooCommerce defaults to date.one of datemodifiedidincludetitleslug
    pageinteger
    Page of results to return, starting at 1. Use with per_page to walk through large result sets. Example: 2.
    per_pageinteger
    Maximum number of coupons to return per page, from 1 to 100. WooCommerce defaults to 10. Example: 50.
    searchstring
    Free-text search across coupons. Example: summer.
  • woocommerce_customer_getGet one WooCommerce customer by their ID.Read-only

    Get Customer

    Get one WooCommerce customer by their ID. Returns the customer's email, name, username, role, billing and shipping addresses, avatar URL and meta data. Use woocommerce_customer_get when you know the customer ID. Use woocommerce_customers_list to find a customer by email or name, and woocommerce_orders_list with customer to see their orders.

    Inputs

    customer_idintegerrequired
    Numeric ID of the customer. This is the WordPress user ID; get it from woocommerce_customers_list. Example: 25.
  • woocommerce_customers_listList registered customers in the WooCommerce store, filtered by search text, email or role.Read-only

    List Customers

    List registered customers in the WooCommerce store, filtered by search text, email or role. Returns each customer's id, email, name, username, billing and shipping addresses, and whether they are a paying customer. Use woocommerce_customers_list to find a customer or their ID. Use woocommerce_customer_get when you already have the ID. Guest checkouts are not customers; find them with woocommerce_orders_list.

    Inputs

    emailstring
    Only return the customer with this exact email address. Example: john.doe@example.com.
    excludestring
    Comma-separated list of customer IDs to leave out of the results. Example: 12,15,27.
    includestring
    Comma-separated list of customer IDs to limit the results to. Example: 12,15,27.
    offsetinteger
    Number of matching customers to skip before returning results. Example: 20.
    orderstring
    Sort direction: asc for ascending or desc for descending. WooCommerce defaults to asc.one of ascdesc
    orderbystring
    Field to sort customers by: id, include, name or registered_date. WooCommerce defaults to name.one of idincludenameregistered_date
    pageinteger
    Page of results to return, starting at 1. Use with per_page to walk through large result sets. Example: 2.
    per_pageinteger
    Maximum number of customers to return per page, from 1 to 100. WooCommerce defaults to 10. Example: 50.
    rolestring
    Only return users with this WordPress role: all, administrator, editor, author, contributor, subscriber, customer or shop_manager. WooCommerce defaults to customer.one of alladministratoreditorauthorcontributorsubscribercustomershop_manager
    searchstring
    Free-text search across customer names, email addresses and usernames. Example: john.
  • woocommerce_order_getGet one order from the WooCommerce store by its ID.Read-only

    Get Order

    Get one order from the WooCommerce store by its ID. Returns the full order: status, customer, billing and shipping addresses, line items, shipping, fee, coupon and tax lines, refunds, payment details and totals. Use woocommerce_order_get when you know the order ID. Use woocommerce_orders_list to find an order by customer, status or search text.

    Inputs

    order_idintegerrequired
    Numeric ID of the order. Get it from woocommerce_orders_list or the order's edit screen in WP Admin (WooCommerce > Orders). Example: 727.
  • woocommerce_order_notes_listList the notes on a WooCommerce order, optionally only customer-facing or only internal notes.Read-only

    List Order Notes

    List the notes on a WooCommerce order, optionally only customer-facing or only internal notes. Returns each note's id, author, note text, date and whether it was sent to the customer. Use woocommerce_order_notes_list to read an order's history. Use woocommerce_order_note_create to add a note.

    Inputs

    order_idintegerrequired
    Numeric ID of the order. Get it from woocommerce_orders_list or the order's edit screen in WP Admin (WooCommerce > Orders). Example: 727.
    typestring
    Which notes to return: any, customer (notes sent to the customer) or internal (private notes). WooCommerce defaults to any.one of anycustomerinternal
  • woocommerce_order_refunds_listList the refunds issued on one WooCommerce order.Read-only

    List Order Refunds

    List the refunds issued on one WooCommerce order. Returns each refund's id, amount, reason, date, who issued it, whether the payment gateway refunded the money, and refunded line items. Use woocommerce_order_refunds_list to see what was already refunded. Use woocommerce_order_refund_create to issue a new refund.

    Inputs

    order_idintegerrequired
    Numeric ID of the order. Get it from woocommerce_orders_list or the order's edit screen in WP Admin (WooCommerce > Orders). Example: 723.
    afterstring
    Only return refunds created after this date. ISO 8601 date-time in the store's timezone. Example: 2025-01-01T00:00:00.
    beforestring
    Only return refunds created before this date. ISO 8601 date-time in the store's timezone. Example: 2025-01-01T00:00:00.
    orderstring
    Sort direction: asc for ascending or desc for descending. WooCommerce defaults to desc.one of ascdesc
    pageinteger
    Page of results to return, starting at 1. Use with per_page to walk through large result sets. Example: 2.
    per_pageinteger
    Maximum number of refunds to return per page, from 1 to 100. WooCommerce defaults to 10. Example: 50.
  • woocommerce_orders_listList orders in the WooCommerce store, filtered by status, customer, product, date range or a search term.Read-only

    List Orders

    List orders in the WooCommerce store, filtered by status, customer, product, date range or a search term. Returns a page of orders with id, number, status, totals, currency, billing and shipping addresses, line items and dates. Use woocommerce_orders_list to find or browse orders. Use woocommerce_order_get when you already have the order ID.

    Inputs

    afterstring
    Only return orders created after this date. ISO 8601 date-time in the store's timezone. Example: 2025-01-01T00:00:00.
    beforestring
    Only return orders created before this date. ISO 8601 date-time in the store's timezone. Example: 2025-01-01T00:00:00.
    customerinteger
    Only return orders placed by this customer ID. This is the WordPress user ID; get it from woocommerce_customers_list. Example: 25.
    excludestring
    Comma-separated list of order IDs to leave out of the results. Example: 12,15,27.
    includestring
    Comma-separated list of order IDs to limit the results to. Example: 12,15,27.
    modified_afterstring
    Only return orders modified after this date. ISO 8601 date-time in the store's timezone. Example: 2025-01-01T00:00:00.
    modified_beforestring
    Only return orders modified before this date. ISO 8601 date-time in the store's timezone. Example: 2025-01-01T00:00:00.
    offsetinteger
    Number of matching orders to skip before returning results. Example: 20.
    orderstring
    Sort direction: asc for ascending or desc for descending. WooCommerce defaults to desc.one of ascdesc
    orderbystring
    Field to sort orders by: date, modified, id, include, title or slug. WooCommerce defaults to date.one of datemodifiedidincludetitleslug
    pageinteger
    Page of results to return, starting at 1. Use with per_page to walk through large result sets. Example: 2.
    per_pageinteger
    Maximum number of orders to return per page, from 1 to 100. WooCommerce defaults to 10. Example: 50.
    productinteger
    Only return orders that contain this product ID. Get it from woocommerce_products_list or the product's edit screen in WP Admin. Example: 93.
    searchstring
    Free-text search across orders, such as a customer name, email address or order number. Example: john.doe@example.com.
    statusstring
    Only return orders with these statuses, as a comma-separated list. Values: any, pending, processing, on-hold, completed, cancelled, refunded, failed, trash. WooCommerce defaults to any. Example: processing,on-hold.
  • woocommerce_product_categories_listList product categories in the WooCommerce store, optionally filtered by name, parent, product or slug.Read-only

    List Product Categories

    List product categories in the WooCommerce store, optionally filtered by name, parent, product or slug. Returns each category's id, name, slug, parent, description, image and product count. Use woocommerce_product_categories_list to find category IDs for products, coupons or the category filter of woocommerce_products_list. Use woocommerce_product_category_create to add a category.

    Inputs

    excludestring
    Comma-separated list of category IDs to leave out of the results. Example: 12,15,27.
    hide_emptyboolean
    Set to true to leave out categories that have no products. WooCommerce defaults to false.
    includestring
    Comma-separated list of category IDs to limit the results to. Example: 12,15,27.
    orderstring
    Sort direction: asc for ascending or desc for descending. WooCommerce defaults to asc.one of ascdesc
    orderbystring
    Field to sort categories by: id, include, name, slug, term_group, description or count. WooCommerce defaults to name.one of idincludenameslugterm_groupdescriptioncount
    pageinteger
    Page of results to return, starting at 1. Use with per_page to walk through large result sets. Example: 2.
    parentinteger
    Only return direct children of this category ID; use 0 for top-level categories. Example: 0.
    per_pageinteger
    Maximum number of categories to return per page, from 1 to 100. WooCommerce defaults to 10. Example: 50.
    productinteger
    Only return categories assigned to this product ID. Get it from woocommerce_products_list or the product's edit screen in WP Admin. Example: 794.
    searchstring
    Free-text search on category names. Example: clothing.
    slugstring
    Only return the category with this slug. Example: hoodies.