WooCommerce

WooCommerce icon

WooCommerce is a free eCommerce plugin that allows you to sell anything, beautifully. Built to integrate seamlessly with WordPress, WooCommerce is the world’s favorite eCommerce solution that gives both store owners and developers complete control.

Triggers

Trigger

Configuration fields

Data type

Required?

Coupon deleted - A coupon has been deleted

 

 

 

Coupon updated - A coupon has been updated

 

 

 

Customer updated - A customer's details has been updated

 

 

 

Customer deleted - A customer has been deleted

 

 

 

New coupon created - A new coupon has been created

 

 

 

New customer created - A new customer has been created

 

 

 

New order created - A new order has been created

 

 

 

New product created - A new product has been created as a draft or as a published product

 

 

 

Product deleted - A product has been deleted

 

 

 

Product updated - A product has been updated

 

 

 

Order deleted - An order has been deleted

 

 

 

Order updated - An order has been updated

 

 

 

Actions

Action

Configuration fields

Data type

Required?

Create a product - Create a new product

Short description - A short description of the product

String

 

Downloads - List of downloadable files

 

 

File ID - The ID of the file

String

 

File name - The name of the file

String

 

File URL - The source URL of the file

String

 

Images - List of product images

 

 

Image ID - The ID of the image

String

 

Image name - The name of the image

String

 

Image URL - The source URL of the image

String

 

Product height - Product height

String

 

Product length - Product length

String

 

Product weight - Product weight

String

 

Product width - Product width

String

 

Stock status - Select the status of the product in stock

Choice

 

Backorders - Set whether or not backorders are allowed. If allowed, stock quantity can go below 0.

Choice

 

Downloadable - Set whether or not the product is downloadable. Downloadable products give access to a file upon purchase.

Boolean

 

Virtual - Set whether or not the product is virtual. Virtual products are not physical and are not shipped.

Boolean

 

Shipping class - Shipping class slug

Choice

 

Description - The description of the product

String

 

Name - The name of the product

String

 

Tags - The name of the product tag

 

 

Tag ID - The ID of the product tag

String

 

Stock quantity - The number of items in stock

String

 

Regular price - The regular price of the product

Example: 24.54

String

 

Sale price - The sale price of the product

Example: 18.42

String

 

Status - The status of the product. Plugins may add extra options (not listed).

Choice

 

Type - The type of the product. Plugins may add extra options (not listed).

Choice

 

Update a product - Update the details of a product

Product - The product to update

Choice

Checkmark icon, required field

Short description - A short description of the product

String

 

Downloads - List of downloadable files

 

 

File ID - The ID of the file

String

 

File name - The name of the file

String

 

File URL - The source URL of the file

String

 

Images - List of product images

 

 

Image ID - The ID of the image

String

 

Image name - The name of the image

String

 

Image URL - The source URL of the image

String

 

Stock status - Select the status of the product in stock

Choice

 

Backorders - Set whether or not backorders are allowed. If enabled, stock quantity can go below 0.

Choice

 

Downloadable - Set whether or not the product is downloadable. Downloadable products give access to a file upon purchase.

Boolean

 

Virtual - Set whether or not the product is virtual. Virtual products are not physical and are not shipped.

Boolean

 

Description - The description of the product

String

 

Category ID - The ID of the product category

String

 

Tags ID - The ID of the product tag

String

 

Name - The name of the product

String

 

Stock quantity - The number of items in stock

String

 

Regular price - The regular price of the product

Example: 24.54

String

 

Sale price - The sale price of the product

Example: 18.42

String

 

Status - The status of the product. Plugins may add extra options (not listed).

Choice

 

Type - The type of the product. Plugins may add extra options (not listed).

Choice

 

Create an order - Create a new order

Line items

 

 

Country ISO code - The ISO code of the country associated with the line item

String

 

Subtotal - The line subtotal (before discounts)

String

 

Total - The line total (after discounts)

String

 

Postal code - The postal code associated with the line item

String

 

Product ID - The product ID

String

 

Name - The product name

String

 

Quantity - The quantity ordered

String

 

Tax class - The slug of the product's tax class

String

 

Variation ID - The variation ID (if applicable)

String

 

Coupon code

String

 

Status - Select the status of the order. Default is Any.

Choice

 

Address line 1 (Billing) - The address line 1 of the order

String

 

Address line 1 (Shipping) - The address line 1 of the order

String

 

Address line 2 (Billing) - The address line 2 of the order

String

 

Address line 2 (Shipping) - The address line 2 of the order

String

 

City (Billing) - The city of the order

String

 

City (Shipping) - The city of the order

String

 

Company name (Billing) - The company name of the order

String

 

Company name (Shipping) - The company name of the order

String

 

Currency - The currency to create the order with. Default is USD.

Choice

 

Customer - The customer who owns the order

Choice

 

Email (Billing) - The email address of the order

String

 

First name (Billing) - The first name of the order

String

 

First name (Shipping) - The first name of the order

String

 

Shipping method ID - The ID of the shipping method

String

 

Country ISO code (Billing) - The ISO code of the country of the order

String

 

Country ISO code (Shipping) - The ISO code of the country of the order

String

 

State (Billing) - The ISO code or name of the state, province, or district associated with the order

String

 

State (Shipping) - The ISO code or name of the state, province, or district of the order

String

 

Last name (Billing) - The last name of the order

String

 

Last name (Shipping) - The last name of the order

String

 

Shipping method name - The name of the shipping method

String

 

Customer note - The note left by the customer during checkout

Boolean

 

Phone (Billing) - The phone number of the order

String

 

Postal code (Billing) - The postal code of the order

String

 

Postal code (Shipping) - The postal code of the order

String

 

Transaction ID - The unique transaction ID of the order

String

 

Retrieve all products - Retrieve a list of all products

Tags - Filter products by tag ID. Enter multiple as comma-separated values with no space between them.

Example: 9,14

String

 

Category - Limit results to products with a specific category ID

Choice

 

SKU - Limit results to products with a specific SKU

String

 

Email - Limit results to those matching an email

String

 

Search - Limit results to those matching entered text

String

 

Page - The current page of results

String

 

Results per page - The maximum number of items to be returned per page

String

 

Type - The type of the product. Plugins may add extra options (not listed).

Choice

 

Retrieve all orders - Retrieve a list of all orders

Status - Filter results by product status. Default is Any.

Choice

 

Before - Limit results to those after a specified ISO date

String

 

After - Limit results to those before a specified ISO date

String

 

Search - Limit results to those matching entered text

String

 

Parent - Limit results to those with a specific parent

String

 

Order - Select the order of the results

Choice

 

Order by - Select what parameter to order results by. Default is Date.

Choice

 

Customer - The customer to retrieve the details of

String

 

Results per page - The maximum number of items to be returned per page

String

 

Product - The product to retrieve the details of

String

 

Context - The scope under which the request was made

Choice

 

Create an order note - Creates a note to store additional details about a specified order

Order - Select the order to add the note to

Choice

Checkmark icon, required field

Customer note - If true, the note will be shown to customers and they will be notified. If false, the note will be for internal reference only. Default is false.

Boolean

 

Added by user - If true, this note will be attributed to the current user. If false, the note will be attributed to the system. Default is false.

Boolean

 

Content - The note's content

String

Checkmark icon, required field

Retrieve all customers - Retrieve a list of all customers

Email - Limit results to customers with a specific email

String

 

Search - Limit results to those matching entered text

String

 

Page - The current page of results

String

 

Customer - The customer to update

Choice

Checkmark icon, required field

Results per page - The maximum number of items to be returned per page

String

 

Retrieve all product variations - Retrieve a list of all product variations

Product - The product to return details of

Choice

Checkmark icon, required field

Parent - Limit results to products with a specific parent

String

 

SKU - Limit results to products with a specific SKU

String

 

Page - The current page of results

String

 

Results per page - The maximum number of items to be returned per page

String

 

Context - The scope under which the request is made

Choice

 

Create a product variation - Create a variation of a product

Product - The product to create a variation of

Choice

Checkmark icon, required field

Images - List of images

 

 

Image ID - The ID of the image

String

 

Image name - The name of the image

String

 

Image URL - The URL of the image

String

 

Stock status - Select the status of the product variation in stock

Choice

 

Backorders allowed - Set whether or not backorders are allowed. If enabled, stock quantity can go below 0.

Choice

 

Description - The description of the product variation

String

 

Stock quantity - The number of items in stock

String

 

Regular price - The regular price of the product variation

24.54

String

 

Sale price - The sale price of the product variation

18.42

String

 

SKU - The SKU of the product variation

String

 

Status - The status of the product variation. Plugins may add extra options (not listed).

Choice

 

Batch update products - Update a batch of products

Images - List of product images

 

 

Image ID - The ID of the image

String

 

Image name - The name of the image

String

 

Image URL - The source URL of the image

String

 

Description - The description of the product

String

 

Category ID - The ID of the product category

String

 

Product ID - The ID of the product

String

Checkmark icon, required field

Tag ID - The ID of the product tag

String

 

Category name - The name of the product category

String

 

Name - The name of the product

String

 

Type - The product type. Plugins may add extra options (not listed).

Choice

 

Regular price - The regular price of the product

Example: 24.54

String

 

Update a customer - Update details of a specific customer

Customer - The customer to update

Choice

Checkmark icon, required field

Address line 1 (Billing) - The address line 1 of the order

String

 

Address line 1 (Shipping) - The address line 1 of the order

String

 

Address line 2 (Billing) - The address line 2 of the order

String

 

Address line 2 (Shipping) - The address line 2 of the order

String

 

City (Billing) - The city of the order

String

 

City (Shipping) - The city of the order

String

 

Company name (Billing) - The company name of the order

String

 

Company name (Shipping) - The company name of the order

String

 

Email - The customer's email address

String

Checkmark icon, required field

First name - The customer's first name

String

 

Last name - The customer's last name

String

 

Password - The customer's password

String

 

Email (Billing) - The email address of the order

String

 

First name (Billing) - The first name of the order

String

 

First name (Shipping) - The first name of the order

String

 

Country ISO code (Billing) - The ISO code of the country of the order

String

 

Country ISO code (Shipping) - The ISO code of the country of the order

String

 

State (Billing) - The ISO code or name of the state, province, or district associated with the order

String

 

State (Shipping) - The ISO code or name of the state, province, or district of the order

String

 

Last name (Billing) - The last name of the order

String

 

Last name (Shipping) - The last name of the order

String

 

Phone (Billing) - The phone number of the order

String

 

Postal code (Billing) - The postal code of the order

String

 

Postal code (Shipping) - The postal code of the order

String

 

Create a customer - Create a new customer and add details about them

Address line 1 (Billing) - The address line 1 of the order

String

 

Address line 1 (Shipping) - The address line 1 of the order

String

 

Address line 2 (Billing) - The address line 2 of the order

String

 

Address line 2 (Shipping) - The address line 2 of the order

String

 

City (Billing) - The city of the order

String

 

City (Shipping) - The city of the order

String

 

Company name (Billing) - The company name of the order

String

 

Company name (Shipping) - The company name of the order

String

 

Email - The customer's email

String

Checkmark icon, required field

First name - The customer's first name

String

 

Last name - The customer's last name

String

 

Password - The customer's password

String

 

User name - The customer's user name

String

 

Email (Billing) - The email address of the order

String

 

First name (Billing) - The first name of the order

String

 

First name (Shipping) - The first name of the order

String

 

Country ISO code (Billing) - The ISO code of the country of the order

String

 

Country ISO code (Shipping) - The ISO code of the country of the order

String

 

State (Billing) - The ISO code or name of the state, province, or district associated with the order

String

 

State (Shipping) - The ISO code or name of the state, province, or district of the order

String

 

Last name (Billing) - The last name of the order

String

 

Last name (Shipping) - The last name of the order

String

 

Phone (Billing) - The phone number of the order

String

 

Postal code (Billing) - The postal code of the order

String

 

Postal code (Shipping) - The postal code of the order

String

 

Retrieve a customer - Retrieve details of a specific customer

Customer - The customer to retrieve the details of

Choice

Checkmark icon, required field

Retrieve an order - Retrieve details of a specific order

Order - The order to retrieve the details of

Choice

Checkmark icon, required field

Retrieve a product - Retrieve details of a specific product

Product - The product to retrieve the details of

Choice

Checkmark icon, required field

Retrieve a product variation - Retrieve details of a specific product variation

Product - The product to return the details of

Choice

Checkmark icon, required field

Variation - The variation of the product to return the details of

Choice

Checkmark icon, required field

Find products by name - Return a list of products by name

Status - Filter products by status

Choice

 

Search - Limit results to those matching entered text

String

Checkmark icon, required field

Find products by tag - Return a list of products by tag

Status - Filter by product status

Choice

 

Tags - Filter products by tag ID. Enter multiple as comma-separated values with no space between them.

Example: 9,14

Choice

Checkmark icon, required field