Connectors

WooCommerce

Manage a WooCommerce store — products, variations, orders, customers, coupons, taxes, shipping zones, webhooks, and reports — via the REST v3 API. Covers Basic auth, the store base URL, the CRUD+batch pattern, and header-based pagination.

On this page

Connecting WooCommerce How WooCommerce actions are structured Reading the response Orders Products Customers Coupons Taxes Shipping Zones Payment Gateways Reports Webhooks Settings & System Status Generic Request Step Name Step Reference Execution Settings Caching Locking

Connecting WooCommerce

Every action needs a WooCommerce connection configured with HTTP Basic authentication — the Consumer Key and Consumer Secret generated in your WordPress admin under WooCommerce → Settings → Advanced → REST API. (Read/write as needed.)

Set the Base URL to your store. The spec's server is a placeholder; on every action, use the Base URL field to enter your store's REST root: https://<your-store>/wp-json/wc/v3.

How WooCommerce actions are structured

Each action is one operation of the WooCommerce REST v3 API. They all appear under a single WooCommerce group in the picker (plus a Generic Request group). This page organizes them by resource.

Almost every resource follows the same five-plus-one pattern:

List All <resource> — GET /<resource>.
Create <resource> — POST /<resource>.
Retrieve <resource> By ID — GET /<resource>/{id}.
Update <resource> By ID — PUT /<resource>/{id}.
Delete <resource> By ID — DELETE /<resource>/{id}. WooCommerce needs force=true (query) to permanently delete most resources rather than trashing them — add it via Additional Query Parameters.
Batch <resource> — POST /<resource>/batch with a body of { "create": [...], "update": [...], "delete": [id, ...] } (up to 100 items).

Common Additional Query Parameters on list actions: page, per_page (default 10, max 100), search, orderby, order (asc/desc), after / before (ISO 8601), plus resource-specific filters (status, category, customer, …).

Reading the response

Every action's result is at {{<stepReference>.response...}} (see Step Reference): {{<stepReference>.response.status}}, {{<stepReference>.response.headers.<name>}}, and {{<stepReference>.response.data...}} for the body.

WooCommerce returns the resource directly — no envelope:

A single record (create / retrieve / update) — fields are directly under data, e.g. {{retrieveOrderById.response.data.id}}, {{retrieveOrderById.response.data.status}}, {{retrieveOrderById.response.data.total}}.
A list — data is the array: {{listAllProducts.response.data}} (e.g. {{listAllProducts.response.data[0].name}}). Total count and page count are response headers: {{<stepReference>.response.headers['x-wp-total']}} and {{<stepReference>.response.headers['x-wp-totalpages']}}.
A batch — {{<stepReference>.response.data.create}}, {{<stepReference>.response.data.update}}, {{<stepReference>.response.data.delete}} arrays.

A non-2xx response does not fail the step — it's returned with the real status and WooCommerce's error body ({{<stepReference>.response.data.code}}, {{<stepReference>.response.data.message}}).

Orders

Full CRUD + batch on /orders, plus:

Order notes — GET|POST /orders/{orderId}/notes, GET|DELETE /orders/{orderId}/notes/{noteId}.
Order refunds — GET|POST /orders/{orderId}/refunds, GET|DELETE /orders/{orderId}/refunds/{refundId}. Create body: { "amount": "10.00", "reason": "...", "api_refund": true, "line_items": [...] }.

Order fields: id, number, status (pending, processing, on-hold, completed, cancelled, refunded, failed), total, currency, customer_id, billing, shipping, line_items, payment_method, date_created.

Products

Full CRUD + batch on /products, plus:

Duplicate Product — POST /products/{productId}/duplicate.
Product variations — CRUD + batch on /products/{productId}/variations.
Product attributes — CRUD + batch on /products/attributes; attribute terms — CRUD + batch on /products/attributes/{attributeId}/terms.
Product categories / tags / shipping classes / reviews — CRUD + batch, each under /products/<...>.

Product fields: id, name, slug, type (simple, variable, grouped, external), status, sku, price, regular_price, sale_price, stock_quantity, stock_status, categories, images, attributes, variations.

Customers

Full CRUD + batch on /customers. Fields: id, email, first_name, last_name, username, billing, shipping, is_paying_customer, avatar_url, date_created.

Coupons

Full CRUD + batch on /coupons. Fields: id, code, discount_type (percent, fixed_cart, fixed_product), amount, date_expires, usage_limit, individual_use, product_ids, minimum_amount.

Taxes

Tax rates — full CRUD + batch on /taxes. Fields: country, state, postcode, rate, name, priority, compound, shipping, class.
Tax classes — GET|POST /taxes/classes, GET|DELETE /taxes/classes/{slug}.

Shipping Zones

Zones — CRUD on /shipping/zones.
Zone locations — GET|PUT /shipping/zones/{id}/locations (PUT replaces the whole set).
Zone methods — GET|POST /shipping/zones/{id}/methods, GET|PUT|DELETE /shipping/zones/{id}/methods/{instanceId}.

Payment Gateways

GET /payment_gateways, GET|PUT /payment_gateways/{id} (enable/disable and configure a gateway).

Reports

Read-only aggregates: GET /reports (list available), plus /reports/sales, /reports/top_sellers, /reports/orders/totals, /reports/customers/totals, /reports/products/totals, /reports/coupons/totals, /reports/reviews/totals. Add date_min / date_max or period via Additional Query Parameters.

Webhooks

Full CRUD + batch on /webhooks. Fields: name, topic (e.g. order.created, product.updated), delivery_url, secret, status (active, paused, disabled).

Settings & System Status

Settings — GET /settings (groups), GET /settings/{groupId}, GET|PUT /settings/{groupId}/{id}.
System status — GET /system_status, GET /system_status/tools, GET|PUT /system_status/tools/{id} (run a maintenance tool).

Generic Request

Five actions — Generic GET / POST / PUT / PATCH / DELETE Request — for anything the dedicated actions don't cover (product custom fields via meta, order actions, WooCommerce extensions that add their own REST routes, other WP REST namespaces).

path — required, relative to the Base URL, e.g. /products/123/reviews, /data/countries, or an absolute path to another namespace.
Request Body (Raw) — the JSON body for write methods.

Also applies here

Step Name

What it's for

Every step in a workflow gets a name — either one you set or a default based on the connector and action (e.g. "Get Order Details", "Send Welcome Email"). It's shown throughout the UI and in your execution history, and it's also the source for the step's Reference — a camelCase identifier auto-generated from the name (e.g. "Get Order Details" → getOrderDetails) — which is what you actually use in {{...}} expressions to read this step's output from later steps. See Step Reference.

Rules

Must be at least 2 characters, and 50 characters or fewer.
Must be unique within the workflow — reusing a name that's already taken will be rejected, with a suggested alternative (e.g. "Get Order Details 2").
Can't be empty.

Tips

Prefer a descriptive, human-readable name over a generic one — "Get Order Details" is easier to work with later than "HTTP Request 2", especially once a workflow has a dozen steps.
Renaming a step updates every reference to it elsewhere in the workflow automatically.

Step Reference

Syntax

Any input field can reference earlier data using {{expression}}. The expression is evaluated as JSONata — so simple dot-paths and more advanced queries (filters, functions) both work.

Referencing a step's output

Use the step's Reference — a camelCase identifier auto-generated from its Name (e.g. "Get Order Details" → getOrderDetails), shown read-only wherever the step's fields are configured — followed by the field path. Elsewhere in these docs this general pattern is written as {{<stepReference>.field.path}}:

{{getOrderDetails.response.data.id}}
{{getOrderDetails.response.status}}

The raw display name won't work here even though it's what you see in the UI — {{Get Order Details.response.data.id}} isn't valid, since a bare name containing spaces isn't a single JSONata identifier. Always use the camelCase Reference.

You can also reference steps by position instead of by reference:

{{steps[0].response.data.id}}

Referencing trigger data

{{trigger.headers.authorization}}
{{trigger.body.customerId}}
{{trigger.query.page}}
{{trigger.params.orderId}}
{{trigger.method}}
{{trigger.path}}

Referencing workflow variables

{{variables.myVariable}}

See Variables for the full list of variable types and more examples, including connection-type variables.

Referencing runtime variables

A separate, mutable namespace written by the Variable connector while a run is in progress — not the same as the workflow-level variables above:

{{runtimeVariables.myVariable}}

Notes

If an expression can't be resolved (a typo in a step name, a field that doesn't exist), it resolves to an empty string rather than failing the workflow — check your execution history if a value comes through blank.
Object values are automatically JSON-stringified when interpolated into a string field.

Execution Settings

Fire-and-forget

When enabled, the workflow doesn't wait for this step to complete before moving to the next one. Use it for steps whose result nothing downstream depends on — logging, analytics, notifications — so they don't add latency to the steps that matter.

Continue on error

When enabled, a failure in this step doesn't stop the workflow — execution continues to the next step. The failure is still recorded in the execution history; this just controls whether it's fatal.

Combine the two for steps that are genuinely optional to the outcome: fire-and-forget so they don't add latency, continue-on-error so a failure in them (e.g. an analytics endpoint being briefly down) doesn't take down an otherwise-successful workflow run.

Caching

What it does

When enabled, a step's result is cached for a configurable TTL (time-to-live, in seconds). If the step runs again with the same effective cache key before the TTL expires, the cached result is returned instead of re-running the step.

Configuring it

Enabled — turn caching on or off for this step.
TTL — how long (in seconds) a cached result stays valid.
Cache key template — an expression (supporting the same {{...}} step reference syntax used elsewhere) that determines what counts as "the same call". By default this is based on the step's resolved input; a custom template lets you cache more narrowly or broadly than that.

When to use it

Good candidates are steps that call something slow or rate-limited but return the same answer for the same input within a short window — a lookup against a rarely-changing external system, for example. Skip it for steps whose result must always be fresh (anything involving live inventory, pricing, or payment state).

Locking

What it does

When enabled, only one execution of this step (for a given lock key) can run at a time. If a second execution tries to run the same step while a lock is held, it waits until the lock is released or the hold period elapses.

Configuring it

Enabled — turn locking on or off for this step.
Lock key — an expression (supporting the same {{...}} step reference syntax used elsewhere) that determines what counts as "the same resource". By default the lock is scoped to the step itself; a custom key lets you lock per-customer, per-order, or any other identifier that needs serialized access.
Period — how long (in seconds) the lock is held before it's automatically released, in case an execution doesn't complete normally.

When to use it

Use it whenever concurrent executions could race on the same resource — e.g. two workflow runs both trying to update the same order's status at once. A lock key scoped to the order id ensures only one of them proceeds at a time.