WooCommerce
Create and manage products and orders in your WooCommerce store.
On this page
Connect
Auth type: Credentials form (custom_auth). Fill in the fields the provider needs (listed below). They are stored encrypted in the vault.
| Field | Type | Description |
|---|---|---|
urlrequired | text | Your WooCommerce store URL (e.g. https://mystore.com) |
consumerKeyrequired | secret | WooCommerce REST API Consumer Key |
consumerSecretrequired | secret | WooCommerce REST API Consumer Secret |
- In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
- For every project in a workspace: Workspace settings, Integrations.
- Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.
Call it from a workflow
Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.
// .workflow.js (native ctx)
export async function run(ctx) {
const res = await ctx.integrations.invoke("woocommerce", "Create Product", {
"name": "<name>",
"type": "simple",
"regular_price": 1,
"description": "<description>",
"short_description": "<short description>",
"categories": "<categories>",
"images": "<images>"
});
if (!res.success) throw new Error(res.error);
ctx.log.info("WooCommerce answered", { output: res.output });
}// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";
export default defineWorkflow({
id: "woocommerce-create-product",
name: "WooCommerce: Create Product",
description: "Calls WooCommerce when a row is created.",
trigger: { type: "entity_event", entity: "tickets", event: "created" },
async run(ctx, event) {
const res = await ctx.integrations.call("woocommerce", {
"action": "Create Product",
"name": "<name>",
"type": "simple",
"regular_price": 1,
"description": "<description>",
"short_description": "<short description>",
"categories": "<categories>",
"images": "<images>"
}) as { success: boolean; error?: string };
if (!res.success) throw new Error(res.error);
},
});curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/woocommerce/Create%20Product" \
-H "Authorization: Bearer $APP_KEY" \
-H "content-type: application/json" \
-d '{"props":{"name":"<name>","type":"simple","regular_price":1,"description":"<description>","short_description":"<short description>","categories":"<categories>","images":"<images>"}}'Actions
Create Productin catalog
Create Product. Create a Product
Also accepted as create_product.
| Input | Type | Description |
|---|---|---|
namerequired | text | Enter the name |
typerequired | one of "simple" | "grouped" | "external" | "variable" | Select the type |
regular_pricerequired | number | Enter the regular price |
descriptionrequired | long text | Enter the description |
short_descriptionrequired | long text | Enter the short description |
categoriesrequired | text | Enter the category IDs (comma separated) |
imagesrequired | long text | Enter the URLs of images you want to upload (comma separated) |
Create Coupon
Create Coupon. Create a coupon
| Input | Type | Description |
|---|---|---|
coderequired | text | Enter the coupon code |
discount_typerequired | one of "fixed_cart" | "fixed_product" | "percent" | "percent_product" | Select the discount type |
amountrequired | number | Enter the amount |
minimum_amountrequired | number | Enter the minimum amount |
Create Customer
Create Customer. Create a Customer
| Input | Type | Description |
|---|---|---|
emailrequired | text | Enter the email |
first_namerequired | text | Enter the first name |
last_namerequired | text | Enter the last name |
usernamerequired | text | Enter the username |
passwordrequired | text | Enter the password |
street_addressrequired | text | Enter the street address |
cityrequired | text | Enter the city |
staterequired | text | Enter the state |
postcoderequired | text | Enter the postcode |
countryrequired | text | Enter the country |
phonerequired | text | Enter the phone |
custom_api_call
Custom API Call. Make a custom API call to a specific endpoint
| Input | Type | Description |
|---|---|---|
urlrequired | object (depends on other props) | url |
methodrequired | one of "GET" | "POST" | "PATCH" | "PUT" | "DELETE" | "HEAD" | Method |
headersrequired | object | Authorization headers are injected automatically from your connection. |
queryParamsrequired | object | Query Parameters |
body_typeoptional | one of "none" | "json" | "form_data" | "raw" | Body Type |
bodyoptional | object (depends on other props) | Body |
response_is_binaryoptional | boolean | Enable for files like PDFs, images, etc. |
failsafeoptional | boolean | No Error on Failure |
timeoutoptional | number | Timeout (in seconds) |
followRedirectsoptional | boolean | Follow redirects |
Find Customer
Find Customer. Find a Customer
| Input | Type | Description |
|---|---|---|
emailrequired | text | Enter the email |
Find Product
Find Product. Find a Product
| Input | Type | Description |
|---|---|---|
idrequired | text | Enter the product ID |
Details
- Id
woocommerce- Category
- E-commerce
- Tags
- store, wordpress, products, orders
- Package
@activepieces/piece-woocommerce@0.1.4- Tier
- Built in