Product
You can send Products data to Zapier, or you can create or update it from external source.
Product Types¶
WooCommerce comes with multiple types of products out of the box. Please consult the following tables for details.
Info
Extensions can extend available data and introduce other product types. Please see the Plugin Compatibility chapter for details.
Integration Functionality by Product Type:¶
Product type | Triggers | Actions and Searches | Order Context1 |
---|---|---|---|
Simple product | Yes | Yes | Yes |
Grouped product | Yes | Yes | N/A |
External/Affiliate product | Yes | Yes | N/A |
Variable product | Yes | Yes | Yes |
Bookable product2 | Yes | Yes | Yes |
Simple subscription3 | Yes | Yes | Yes |
Variable subscription3 | Yes | Yes | Yes |
Data Availability by Product Type¶
Product type | Inventory | Shipping | Attributes | Variations |
---|---|---|---|---|
Simple product | Yes | Yes | Yes | N/A |
Grouped product | N/A | N/A | Yes | N/A |
External/Affiliate product | N/A | N/A | Yes | N/A |
Variable product | Yes | Yes | Yes | Yes |
Bookable product2 | N/A | Yes | Yes | N/A |
Simple subscription3 | Yes | Yes | Yes | N/A |
Variable subscription3 | Yes | Yes | Yes | Yes |
Legends
Yes: Supported.
N/A: Functionality or data is not provided by WooCommerce.
Product Data in Order Context¶
While every order contains one or more product as a line item, not all product data included by default. Please compare Order Data Structure or Line Item in an Order Data Structure with Product Data Structure above for availability. If you need additional product data fields while working with an Order, consider adding a Find Product step to your Zap.
Variable Products¶
In WooCommerce, a product with variable attributes is constructed as multiple interconnected products. The parent product that connects everything and holds shared information, which you can edit in the WooCommerce dashboard, has a variable product type. For each individual variation, a separate product is created and stored as a product variation. This latter product holds selected attributes for the variable product. For example, an individual product variation has price, SKU or stock level information for a particular attribute.
In the Zapier interface, you can see IDs of linked variations in the variations
field for a variable product. On the other hand, the variable product ID is visible in the parent_id
field for a product variation.
Heads Up
You can’t edit a variation name directly in the WooCommerce dashboard. Instead, the name is automatically constructed with the used product attributes and the selected values.
Sending or Receiving a Variable Product¶
Triggers are supported for variable products as well as their individual product variations. They do not behave differently from any other supported product type.
Important
- When using the Product created or Product updated trigger rules with a variable product, every individual variation will be sent as a separate task alongside the parent product task.
Actions are also supported for individual variations. I.e., you can create, update and search for a variable product, as well as its individual product variations.
WooCommerce Zapier Plugin Version 2.6 Required
Please ensure you update the WooCommerce Zapier plugin to version 2.6.0 to use this functionality.
Variable Products as Order Line Item¶
In Order Triggers, when a line item represents a variable product, WooCommerce combines fields data from the parent and the selected variation. While the line_items
→ product_id
and some other fields source are the variable product, most of the information is selected from the used product variation. For example, the actual used product ID is visible in the line_items
→ variation_id
.
For Order Actions or Searches, you can add a variable product to an order as long you know the ID or SKU of a variation and the product already exists in your WooCommerce store.
Notable Order Field Sources:¶
Field | Source |
---|---|
line_items → product_id | Variable product |
line_items → variation_id | Product variation |
line_items → name | Product variation |
line_items → price | Product variation |
line_items → sku | Product variation |
line_items → tax_class | Variable product |
Tip
If you want to use Zapier to create an order in WooCommerce for a variable product, consider using the individual variation’s SKU rather than variation ID.
Trigger Rules¶
A Trigger Rule defines an event (or multiple events) that will cause WooCommerce data to be sent to a Zapier Zap.
The following trigger rules are available to trigger your Zaps when product data in your WooCommerce store is added, changed or deleted.
Product created¶
Triggers when a product is created.
Triggers for every individual product variation in a variable product, and the parent product as well.
Product deleted¶
Triggers when a product is deleted (trashed).
Only the ID
field is available
Due to limitations in how WooCommerce handles deleted events, when using this trigger rule, only the ID
of the deleted resource is sent to Zapier. No other data fields are available.
Product restored¶
Triggers when an already trashed product is restored from the trash.
Product stock low ¶
Triggers when an existing product or product variation’s stock quantity reaches the low stock threshold.
Tip: Configuring the low stock threshold
The default low stock threshold for your store can be configured in WooCommerce → Settings → Products → Inventory then entering a value in the Low stock threshold field.
The low stock threshold can also be configured on a per-product basis by editing the product in WooCommerce, and then:
- For regular products, go to Product Data → Inventory → Low stock threshold and enter a value in the Low stock threshold field and save the product.
- For individual variations, go to Product Data → Variations, then editing each variation and enter a value in the Low stock threshold field and save each variation.
Stock management must be enabled for each product
The default stock management feature for your store can be configured in WooCommerce → Settings → Products → Inventory → Manage stock checkbox. (Enabled by default).
Stock management feature must be enabled for a product as well for this trigger rule to work:
- For regular products, go to Product Data → Inventory → Stock management → then ticking the Track stock quantity for this product and saving the product.
- For individual variations, edit the product in WooCommerce, then go to Product Data → Variations, then edit each variation and tick the Manage stock? checkbox and save each variation.
WooCommerce Zapier Plugin Version 2.6 Required
Please ensure you update the WooCommerce Zapier plugin to version 2.6.0 to use this functionality.
Product stock status changed ¶
Product stock statuses in WooCommerce are an important aspect of product management in WooCommerce.
The standard product stock statuses in WooCommerce are:
- In stock
- On backorder
- Out of stock
If your product has stock management enabled, then the stock status of your product will change automatically based on the stock quantity of your product.
Below is a full list of Product stock status changed trigger rules:
- Product stock status changed (any status)
- Product stock status changed to in stock
- Product stock status changed to on backorder
- Product stock status changed to out of stock
The Product stock status changed (any status) trigger rule will trigger every time an existing product changes status to any status.
If you are interested in specific product stock status change(s) only, you may wish to use a more specific Product stock changed to … trigger rule.
Stock management must be enabled for each product
The default stock management feature for your store can be configured in WooCommerce → Settings → Products → Inventory → Manage stock checkbox. (Enabled by default).
Stock management feature must be enabled for a product as well for this trigger rule to work:
- For regular products, go to Product Data → Inventory → Stock management → then ticking the Track stock quantity for this product and saving the product.
- For individual variations, edit the product in WooCommerce, then go to Product Data → Variations, then edit each variation and tick the Manage stock? checkbox and save each variation.
WooCommerce Zapier Plugin Version 2.6 Required
Please ensure you update the WooCommerce Zapier plugin to version 2.6.0 to use this functionality.
Product updated¶
Triggers when a product is updated/edited/changed/modified.
Triggers for every individual product variation in a variable product, and the parent product as well.
Actions and Searches¶
An action is an event a Zap performs after it is triggered. Actions allow you to create new or update existing WooCommerce data from a Zap.
Searches let you find existing WooCommerce data in a Zap, and then use it later in a subsequent step.
The following actions are available for use in your Zaps to create, update or find products.
Line-Item Enabled Data Fields: Downloads, Categories, Images, Attributes, Meta Data
To specify multiple values for these field(s), the values must be sent in a line-item aware format. Please see here for details on how the Line Itemizer can be used to achieve this.
Create Product¶
Creates a new product or product variation in WooCommerce.
Creating a Variable Product ¶
To create a variable product, set Type to variable
or variable-subscription
3, and specify one or more product Attributes with Variation set to true
.
For example, to create a variable product with a custom Size attribute, you would specify something like the following:
- Type:
variable
- Attributes → Name:
Size
- Attributes → Variation:
true
- Attributes → Options:
Small, Medium, Large
If you already have a store-wide global attribute named Size, you can use that instead of creating a new custom attribute:
- Type:
variable
- Attributes → Name:
pa_size
(or whatever the slug of the global attribute is) - Attributes → Variation:
true
- Attributes → Options:
Small, Medium, Large
Once the Create Product action has been run, you can then create individual product variation(s) using a subsequent Create Product action(s).
WooCommerce Zapier Plugin Version 2.6 Required
Please ensure you update the WooCommerce Zapier plugin to version 2.6.0 to use this functionality.
Creating a Variation ¶
To create an individual product variation, you must already have its parent Variable Product or Variable Subscription Product3 created.
In the Create Product step, set Type to variation
or subscription_variation
3, and then in the Parent Id field, enter the ID of the parent variable product that the variation should belong to:
- Type:
variation
- Parent Id →
123
(where123
is the ID of the parent variable product) - Attributes → Name:
Size
- Attributes → Option:
Small
The above example will create a new variation with a Size of Small.
WooCommerce Zapier Plugin Version 2.6 Required
Please ensure you update the WooCommerce Zapier plugin to version 2.6.0 to use this functionality.
Create Input Fields¶
NAME | TYPE | DESCRIPTION |
---|---|---|
Name | string | Product name. |
Slug | string | Product slug. |
Date Created | date-time | The date the product was created, in the site's timezone. |
Type | string | Product type. |
Status | string | Product status (post status). |
Featured | boolean | Featured product. |
Catalog Visibility | string | Catalog visibility. |
Description | string | Product description. |
Short Description | string | Product short description. |
Sku | string | Unique identifier. |
Regular Price | string | Product regular price. |
Sale Price | string | Product sale price. |
Date on Sale from | date-time | Start date of sale price, in the site's timezone. |
Date on Sale to | date-time | End date of sale price, in the site's timezone. |
Virtual | boolean | If the product is virtual. |
Downloadable | boolean | If the product is downloadable. |
Downloads | array | List of downloadable files. Only the child fields are visible in the Zapier UI. |
Downloads --> Id | string | File ID. |
Downloads --> Name | string | File name. |
Downloads --> File | string | File URL. |
Download Limit | integer | Number of times downloadable files can be downloaded after purchase. |
Download Expiry | integer | Number of days until access to downloadable files expires. |
External Url | string | Product external URL. Only for external products. |
Button Text | string | Product external button text. Only for external products. |
Tax Status | string | Tax status. |
Tax Class | string | Tax class. |
Manage Stock | boolean | Stock management at product level. |
Stock Quantity | integer | Stock quantity. |
Stock Status | string | Controls the stock status of the product. |
Backorders | string | If managing stock, this controls if backorders are allowed. |
Low Stock Amount | integer | Low Stock amount for the product. |
Sold Individually | boolean | Allow one item to be bought in a single order. |
Weight | string | Product weight (kg). |
Dimensions | object | Product dimensions. Only the child fields are visible in the Zapier UI. |
Dimensions --> Length | string | Product length (cm). |
Dimensions --> Width | string | Product width (cm). |
Dimensions --> Height | string | Product height (cm). |
Shipping Class | string | Shipping class slug. |
Reviews Allowed | boolean | Allow reviews. |
Upsell Ids | array | List of up-sell products IDs. |
Cross Sell Ids | array | List of cross-sell products IDs. |
Parent Id | integer | Product parent ID. |
Purchase Note | string | Optional note to send the customer after purchase. |
Categories | array | List of categories. Only the child fields are visible in the Zapier UI. |
Categories --> Id | integer | Category ID. |
Tags | array | List of tags. Only the child fields are visible in the Zapier UI. |
Tags --> Id | integer | Tag ID. |
Images | array | List of images. Only the child fields are visible in the Zapier UI. |
Images --> Id | integer | Image ID. |
Images --> Src | string | Image URL. |
Images --> Name | string | Image name. |
Images --> Alt | string | Image alternative text. |
Attributes | array | List of attributes. Only the child fields are visible in the Zapier UI. |
Attributes --> Id | integer | Attribute ID. |
Attributes --> Name | string | Attribute name. |
Attributes --> Position | integer | Attribute position. |
Attributes --> Visible | boolean | Define if the attribute is visible on the "Additional information" tab in the product's page. |
Attributes --> Variation | boolean | Define if the attribute can be used as variation. |
Attributes --> Options | array | List of available term names of the attribute. |
Default Attributes | array | Defaults variation attributes. Only the child fields are visible in the Zapier UI. |
Default Attributes --> Id | integer | Attribute ID. |
Default Attributes --> Name | string | Attribute name. |
Default Attributes --> Option | string | Selected attribute term name. |
Menu Order | integer | Menu order, used to custom sort products. |
Meta Data | array | Meta data. Only the child fields are visible in the Zapier UI. |
Meta Data --> Key | string | Meta key. |
Meta Data --> Value | any | Meta value. |
Update Product¶
Updates (modifies) an existing product or production variation in WooCommerce.
This action lets you change almost any aspect of an existing product. See the Update Product Data Fields section for a full list of fields that can be updated.
If you would like to update the product’s pricing or stock quantity, we recommend using the dedicated Update Product Price or Update Product Stock Quantity actions instead. These separate actions also support relative price and stock quantity adjustments.
Note: Resource ID is Required for Update Steps
An update action always requires a valid top-level ID to be specified. This ensures that your Zap knows which record to update. On the other hand, any non-top level ID is optional. If you leave it empty, WooCommerce will create a new entry, such as a new Meta Data item.
To help identify the correct Resource ID, you can add a Find step before your update step. The result of your Find step will contain the Resource ID, which you can then use in the Update step.
Updating a Product Variation ¶
To update an individual product variation, set the ID field to the individual variation’s ID.
Updating Variation Attributes
You must specify all or none of the Attributes fields for a variation. If any attribute is present, any other attributes that are not specified will be removed from the variation.
WooCommerce Zapier Plugin Version 2.6 Required
Please ensure you update the WooCommerce Zapier plugin to version 2.6.0 to use this functionality.
Update Input Fields¶
NAME | TYPE | DESCRIPTION |
---|---|---|
Existing ID | integer | Unique identifier for the resource. |
Name | string | Product name. |
Slug | string | Product slug. |
Date Created | date-time | The date the product was created, in the site's timezone. |
Type | string | Product type. |
Status | string | Product status (post status). |
Featured | boolean | Featured product. |
Catalog Visibility | string | Catalog visibility. |
Description | string | Product description. |
Short Description | string | Product short description. |
Sku | string | Unique identifier. |
Regular Price | string | Product regular price. |
Sale Price | string | Product sale price. |
Date on Sale from | date-time | Start date of sale price, in the site's timezone. |
Date on Sale to | date-time | End date of sale price, in the site's timezone. |
Virtual | boolean | If the product is virtual. |
Downloadable | boolean | If the product is downloadable. |
Downloads | array | List of downloadable files. Only the child fields are visible in the Zapier UI. |
Downloads --> Existing ID | string | File ID. Leave empty to create a new downloads record. Otherwise, enter an existing ID. |
Downloads --> Name | string | File name. |
Downloads --> File | string | File URL. |
Download Limit | integer | Number of times downloadable files can be downloaded after purchase. |
Download Expiry | integer | Number of days until access to downloadable files expires. |
External Url | string | Product external URL. Only for external products. |
Button Text | string | Product external button text. Only for external products. |
Tax Status | string | Tax status. |
Tax Class | string | Tax class. |
Manage Stock | boolean | Stock management at product level. |
Stock Quantity | integer | Stock quantity. |
Stock Status | string | Controls the stock status of the product. |
Backorders | string | If managing stock, this controls if backorders are allowed. |
Low Stock Amount | integer | Low Stock amount for the product. |
Sold Individually | boolean | Allow one item to be bought in a single order. |
Weight | string | Product weight (kg). |
Dimensions | object | Product dimensions. Only the child fields are visible in the Zapier UI. |
Dimensions --> Length | string | Product length (cm). |
Dimensions --> Width | string | Product width (cm). |
Dimensions --> Height | string | Product height (cm). |
Shipping Class | string | Shipping class slug. |
Reviews Allowed | boolean | Allow reviews. |
Upsell Ids | array | List of up-sell products IDs. |
Cross Sell Ids | array | List of cross-sell products IDs. |
Parent Id | integer | Product parent ID. |
Purchase Note | string | Optional note to send the customer after purchase. |
Categories | array | List of categories. Only the child fields are visible in the Zapier UI. |
Categories --> Existing ID | integer | Category ID. Leave empty to create a new categories record. Otherwise, enter an existing ID. |
Tags | array | List of tags. Only the child fields are visible in the Zapier UI. |
Tags --> Existing ID | integer | Tag ID. Leave empty to create a new tags record. Otherwise, enter an existing ID. |
Images | array | List of images. Only the child fields are visible in the Zapier UI. |
Images --> Existing ID | integer | Image ID. Leave empty to create a new images record. Otherwise, enter an existing ID. |
Images --> Src | string | Image URL. |
Images --> Name | string | Image name. |
Images --> Alt | string | Image alternative text. |
Attributes | array | List of attributes. Only the child fields are visible in the Zapier UI. |
Attributes --> Existing ID | integer | Attribute ID. Leave empty to create a new attributes record. Otherwise, enter an existing ID. |
Attributes --> Name | string | Attribute name. |
Attributes --> Position | integer | Attribute position. |
Attributes --> Visible | boolean | Define if the attribute is visible on the "Additional information" tab in the product's page. |
Attributes --> Variation | boolean | Define if the attribute can be used as variation. |
Attributes --> Options | array | List of available term names of the attribute. |
Default Attributes | array | Defaults variation attributes. Only the child fields are visible in the Zapier UI. |
Default Attributes --> Existing ID | integer | Attribute ID. Leave empty to create a new default attributes record. Otherwise, enter an existing ID. |
Default Attributes --> Name | string | Attribute name. |
Default Attributes --> Option | string | Selected attribute term name. |
Menu Order | integer | Menu order, used to custom sort products. |
Meta Data | array | Meta data. Only the child fields are visible in the Zapier UI. |
Meta Data --> Existing ID | integer | Meta ID. Leave empty to create a new meta data record. Otherwise, enter an existing ID. |
Meta Data --> Key | string | Meta key. |
Meta Data --> Value | any | Meta value. |
Update Product Price ¶
WooCommerce Zapier Plugin Version 2.6 Required
Please ensure you update the WooCommerce Zapier plugin to version 2.6.0 to use this functionality.
Modifies an existing product or product variation’s regular price or sale price in WooCommerce.
This action targets a specific product or product variation by SKU or ID. It also supports the calculation of new (relative) prices by increasing or decreasing the prices by the specified amount or percentage.
It also allows users to set a product’s sale price relative to the product’s regular price.
Note: You can use ID or SKU to identify a product to update in this action
A valid SKU or a valid ID can be used in your Zap to identify which existing product to update.
The following adjustment types are available for use in this action:
- Set Regular Price To
- Increase Regular Price By (fixed amount or percentage)
- Decrease Regular Price By (fixed amount or percentage)
- Set Sale Price To
- Increase Sale Price By (fixed amount or percentage)
- Decrease Sale Price By (fixed amount or percentage)
- Set Sale Price to Regular Price Decreased By (fixed amount or percentage)
This action returns a subset of the product data fields. See the Update Product Price Data Fields section for more information.
Update Product Price Data Fields¶
NAME | TYPE | DESCRIPTION |
---|---|---|
Product Identifier | string | Select how to find the existing product or variation to update |
Product Value | string | Input the SKU or ID of the product or variation to update |
Adjustment Type | string | Choose how and what to modify the product’s price |
Price Value | string | Enter a value to set, increase, or decrease the current price (fixed or %) |
NAME | TYPE | DESCRIPTION |
---|---|---|
Id | integer | Unique identifier for the resource |
Sku | string | Unique identifier |
Price | string | Current product price |
Regular Price | string | Product regular price |
Sale Price | string | Product sale price |
On Sale | boolean | Shows if the product is on sale |
Update Product Stock Quantity ¶
WooCommerce Zapier Plugin Version 2.5 Required
Please ensure you update the WooCommerce Zapier plugin to version 2.5.0 to use this Action.
Modifies an existing product or product variation’s stock quantity in WooCommerce.
Tip: Stock management must be enabled for each product
WooCommerce’s stock management feature must be enabled for each product you want to update using this action.
This can be done by editing the product in WooCommerce, then going to Product Data → Inventory → Stock management → then ticking the Track stock quantity for this product checkbox and save.
For individual variations, edit the product in WooCommerce, then go to Product Data → Variations, then edit each variation and tick the Manage stock? checkbox and save.
This action targets a specific product or product variation by SKU or ID. It also supports the calculation of new (relative) stock quantity by increasing or reducing the current stock quantity by the specified amount.
Note: You can use ID or SKU to identify a product to update in this action
A valid SKU or a valid ID can be used in your Zap to identify which existing product to update.
The following adjustment types are available for use in this action:
- Set Stock Quantity To
- Increase Stock Quantity By
- Reduce Stock Quantity By
This action returns a subset of the product data fields. See the Update Product Stock Quantity Data Fields section for more information.
When this action runs, it will automatically set the relevant product’s Stock Status to In Stock or Out of Stock depending on the new stock quantity. If the product has backorders enabled, then the Stock Status will be set to On Backorder when the quantity goes to zero or negative
Update Product Stock Quantity Data Fields¶
NAME | TYPE | DESCRIPTION |
---|---|---|
Product Identifier | string | Select how to find the existing product or variation to update |
Product Value | string | Input the SKU or ID of the product or variation to update |
Adjustment Type | string | Choose how to modify the product’s stock quantity |
Adjustment Value | integer | Enter a numeric value to set, increase, or reduce the current stock quantity |
NAME | TYPE | DESCRIPTION |
---|---|---|
Id | integer | Unique identifier for the resource |
Sku | string | Unique identifier |
Stock Quantity | integer | Stock quantity |
Stock Status | string | Controls the stock status of the product |
Find Product¶
Searches for an existing product or product variation in WooCommerce. Optionally create one if none are found.
All available search fields can be viewed here. We recommend the using the following search fields:
- SKU: Searches for the specified product SKU.
- Product ID: Searches for the specified (numeric) product or variation ID.
- Search: Searches the Product Name and Product Description fields for the specified string/term/phrase.
Finding Top-Level Products Only
By default a Find Product step will search across all products types, including individual product variations.
If you only want to find top-level products (i.e. not variations), then you can use the Parent Id search field and set it to 0
(zero).
Tip: Finding Products from Orders
Please see here for some suggestions on how to find WooCommerce products from WooCommerce Order Line Items.
Tip: Search Sort Order
Searches return the first result found, and make it available in your Zap’s subsequent action step.
Each search has a default sort order, so when definining your Search step, you can use the Order and Orderby fields to choose (for example) whether the most recent result or the oldest result is returned from your search.
WooCommerce Zapier Plugin Version 2.6 Required
Please ensure you update the WooCommerce Zapier plugin to version 2.6.0 to use this functionality.
Search Input Fields¶
NAME | TYPE | DESCRIPTION |
---|---|---|
Product Id | string | Limit search by ID. |
Search | string | Limit results to those matching a string. |
Modified After | string | Limit response to resources modified after a given ISO8601 compliant date. |
Modified Before | string | Limit response to resources modified before a given ISO8601 compliant date. |
Order | string | Order sort attribute ascending or descending. |
Orderby | string | Sort collection by object attribute. |
Parent | array | Limit result set to those of particular parent IDs. |
Slug | string | Limit result set to products with a specific slug. |
Status | string | Limit result set to products assigned a specific status. |
Type | string | Limit result set to products assigned a specific type. |
Sku | string | Limit result set to products with specific SKU(s). Use commas to separate. |
Featured | boolean | Limit result set to featured products. |
Category | string | Limit result set to products assigned a specific category ID. |
Tag | string | Limit result set to products assigned a specific tag ID. |
Shipping Class | string | Limit result set to products assigned a specific shipping class ID. |
Attribute | string | Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug. |
Attribute Term | string | Limit result set to products with a specific attribute term ID (required an assigned attribute). |
Tax Class | string | Limit result set to products with a specific tax class. |
On Sale | boolean | Limit result set to products on sale. |
Min Price | string | Limit result set to products based on a minimum price. |
Max Price | string | Limit result set to products based on a maximum price. |
Include Meta | array | Limit meta_data to specific keys. |
Exclude Meta | array | Ensure meta_data excludes specific keys. |
Stock Status | string | Limit result set to products with specified stock status. |
Search Sku | string | Limit results to those with a SKU that partial matches a string. |
Product Data¶
NAME | TYPE | DESCRIPTION |
---|---|---|
Id | integer | Unique identifier for the resource. |
Name | string | Product name. |
Slug | string | Product slug. |
Permalink | string | Product URL. |
Date Created | date-time | The date the product was created, in the site's timezone. |
Date Modified | date-time | The date the product was last modified, in the site's timezone. |
Type | string | Product type. |
Status | string | Product status (post status). |
Featured | boolean | Featured product. |
Catalog Visibility | string | Catalog visibility. |
Description | string | Product description. |
Short Description | string | Product short description. |
Sku | string | Unique identifier. |
Price | string | Current product price. |
Regular Price | string | Product regular price. |
Sale Price | string | Product sale price. |
Date on Sale from | date-time | Start date of sale price, in the site's timezone. |
Date on Sale to | date-time | End date of sale price, in the site's timezone. |
Price Html | string | Price formatted in HTML. |
On Sale | boolean | Shows if the product is on sale. |
Purchasable | boolean | Shows if the product can be bought. |
Total Sales | integer | Amount of sales. |
Virtual | boolean | If the product is virtual. |
Downloadable | boolean | If the product is downloadable. |
Downloads | array | List of downloadable files. |
Downloads --> Id | string | File ID. |
Downloads --> Name | string | File name. |
Downloads --> File | string | File URL. |
Download Limit | integer | Number of times downloadable files can be downloaded after purchase. |
Download Expiry | integer | Number of days until access to downloadable files expires. |
External Url | string | Product external URL. Only for external products. |
Button Text | string | Product external button text. Only for external products. |
Tax Status | string | Tax status. |
Tax Class | string | Tax class. |
Manage Stock | boolean | Stock management at product level. |
Stock Quantity | integer | Stock quantity. |
Stock Status | string | Controls the stock status of the product. |
Backorders | string | If managing stock, this controls if backorders are allowed. |
Backorders Allowed | boolean | Shows if backorders are allowed. |
Backordered | boolean | Shows if the product is on backordered. |
Low Stock Amount | integer | Low Stock amount for the product. |
Sold Individually | boolean | Allow one item to be bought in a single order. |
Weight | string | Product weight (kg). |
Dimensions | object | Product dimensions. |
Dimensions --> Length | string | Product length (cm). |
Dimensions --> Width | string | Product width (cm). |
Dimensions --> Height | string | Product height (cm). |
Shipping Required | boolean | Shows if the product need to be shipped. |
Shipping Taxable | boolean | Shows whether or not the product shipping is taxable. |
Shipping Class | string | Shipping class slug. |
Shipping Class Id | string | Shipping class ID. |
Reviews Allowed | boolean | Allow reviews. |
Average Rating | string | Reviews average rating. |
Rating Count | integer | Amount of reviews that the product have. |
Related Ids | array | List of related products IDs. |
Upsell Ids | array | List of up-sell products IDs. |
Cross Sell Ids | array | List of cross-sell products IDs. |
Parent Id | integer | Product parent ID. |
Purchase Note | string | Optional note to send the customer after purchase. |
Categories | array | List of categories. |
Categories --> Id | integer | Category ID. |
Categories --> Name | string | Category name. |
Categories --> Slug | string | Category slug. |
Tags | array | List of tags. |
Tags --> Id | integer | Tag ID. |
Tags --> Name | string | Tag name. |
Tags --> Slug | string | Tag slug. |
Images | array | List of images. |
Images --> Id | integer | Image ID. |
Images --> Date Created | date-time | The date the image was created, in the site's timezone. |
Images --> Date Modified | date-time | The date the image was last modified, in the site's timezone. |
Images --> Src | string | Image URL. |
Images --> Name | string | Image name. |
Images --> Alt | string | Image alternative text. |
Has Options | boolean | Shows if the product needs to be configured before it can be bought. |
Attributes | array | List of attributes. |
Attributes --> Id | integer | Attribute ID. |
Attributes --> Name | string | Attribute name. |
Attributes --> Position | integer | Attribute position. |
Attributes --> Visible | boolean | Define if the attribute is visible on the "Additional information" tab in the product's page. |
Attributes --> Variation | boolean | Define if the attribute can be used as variation. |
Attributes --> Options | array | List of available term names of the attribute. |
Default Attributes | array | Defaults variation attributes. |
Default Attributes --> Id | integer | Attribute ID. |
Default Attributes --> Name | string | Attribute name. |
Default Attributes --> Option | string | Selected attribute term name. |
Variations | array | List of variations IDs. |
Grouped Products | array | List of grouped products ID. |
Menu Order | integer | Menu order, used to custom sort products. |
Meta Data | array | Meta data. |
Meta Data --> Id | integer | Meta ID. |
Meta Data --> Key | string | Meta key. |
Meta Data --> Value | any | Meta value. |
Tip
WooCommerce Zapier uses WooCommerce’s REST API. This means that data field names, descriptions and values can vary from one WooCommerce store to another.
Your store’s data, fields and trigger rules may be different to this documentation due any of the following:
- Your installed (active) WordPress plugins and WooCommerce extensions.
- Your WooCommerce and WordPress versions and the used locale/language.
- Any custom code that overrides or changes how the WooCommerce/WordPress REST API operates.
Note: The field definitions in this documentation were generated using WordPress v6.3 and WooCommerce v8.0, with the en-US
locale. The WooCommerce Bookings and WooCommerce Subscriptions plugins were enabled.
-
Not every product data available in an Order Context as a line item. ↩
-
Only available if the WooCommerce Bookings plugin is installed. ↩↩
-
Only available if the WooCommerce Subscriptions plugin is installed. ↩↩↩↩↩↩↩