WooCommerce Zapier Integration

Tip:

This document applies to WooCommerce Zapier version 2, which includes a lot of requested new features and improvements to functionality.

Existing users, please see our Migration Guide for instructions on how to migrate your existing Zaps to the new WooCommerce App by April 30, 2021.

Introduction ↑ Back to top

WooCommerce Zapier integrates your WooCommerce store with 2000+ third-party web services via the Zapier web automation service.

Send your WooCommerce order, customer, product, coupon or subscription data to 2000+ Zapier-enabled apps.

Or use Zapier to automatically create or update WooCommerce order, customer, product, coupon or subscription data from a Zap.


Have a question before you buy? Please fill out our Pre-Sales form and we are happy to answer your questions about WooCommerce Zapier.

You can purchase this plugin from the WooCommerce.com Extension Store.

What’s New in Version 2? ↑ Back to top

Released 6 April 2020, WooCommerce Zapier version 2 includes a lot of requested new features and improvements to functionality. New triggers, support for actions, and more.

Two-Way Integration

The WooCommerce Zapier integration is two-way, and now supports Actions. You can use Zaps to create new and update existing Coupon, Customer, Product, Order or Subscription data in WooCommerce.

New Triggers

WooCommerce Zapier now has three times (3x) the number of available trigger events, giving you 3 times as many opportunities and reasons to send your WooCommerce store data to Zapier.

Simplified Zap Creation

The Zap creation process is simplified, and is now fully managed via the zapier.com interface. There is no more requirement to create corresponding Zapier Feeds in WooCommerce.

New Resources (Data Types)

WooCommerce Zapier Version 2 adds support for Products and Coupons, in addition to the already supported Orders, Customers and Subscriptions1.

Powered by REST API

Giving you increased access to more data fields as well as more robust and reliable data delivery via WooCommerce webhooks.

Secure by Design

Secure HTTPS communication between WooCommerce and Zapier, as well as a new authentication method, will help improve data confidentiality and integrity.

And More

Please see the release notes for full details.

Installation ↑ Back to top

Zapier Account ↑ Back to top

To use this plugin, you need a Zapier Account. If you don’t have one, you can sign up on the Zapier website. Select the Sign Up button or just enter your information in the available form.

Note:

Zapier offers both free and paid plans.

WooCommerce Zapier can be used with a free Zapier plan, however, advanced functionality such as Filter and Paths are only available for paid plans.

For further information of pricing see the Zapier’s Plans & Pricing page.

System Requirements ↑ Back to top

The WooCommerce Zapier plugin has the following minimum requirements:

Item Requirement
PHP Version 5.6.20 or higher
(We recommend using PHP 7.3 or greater2)
WordPress Version 4.7 or higher
WooCommerce Version 3.5 or higher
WooCommerce/WordPress Account Account needs to be an administrator role3
Zapier Account Free or paid plans4
WordPress Permalinks Pretty permalinks enabled 5
HTTPS Site needs to be accessible via https://
WordPress cron Running and operational

Note:

  • Zapier accounts have free and paid plans – see the Zapier Pricing page for more info.
  • Cron is a standard part of WordPress. WooCommerce’s Action Scheduler is depending on it. If not running, this plugin will not work. See the No Data is Being Sent to Zapier chapter.

Installation ↑ Back to top

There are two different methods to install your WooCommerce Zapier extension:

1. One-Click Install/Update Method

If you have connected your WooCommerce.com account to your website, go to your WordPress Dashboard —> Side Menu —> WooCommerce —> Extensions screen and click the one-click Download button next to WooCommerce Zapier. This is also the easiest way to keep your WooCommerce Zapier plugin up to date.

This article explains how you can connect your account to your WooCommerce store to activate in-dashboard one-click downloads/updates.

2. File Upload

You can also log in to your WooCommerce’s account and go to the Downloads page to download the latest zip file of the extension to your computer.

From your WordPress Dashboard, go to Side Menu —> Plugins screen and click the Add New and then Upload Plugin button at the top of the page. Select the zip file from your computer and click the Install Now button then the Activate button to active WooCommerce Zapier.

Tip: Some web browsers automatically unarchive downloaded Zip files. Make sure this functionality is disabled.

We also suggest going to WordPress Dashboard —> Side Menu —> WooCommerce —> Extensions —> WooCommerce.com Extensions screen to connect your WooCommerce.com account, so that you have access to future WooCommerce Zapier versions from within your WordPress Dashboard.

Check the Installation ↑ Back to top

Finally, it is best to go to the WordPress Dashboard —> Side Menu —> WooCommerce —> Status screen, and review the Active Plugins section to ensure that the WooCommerce Zapier plugin is up to date.

Congratulations!:

WooCommerce Zapier is now installed.

Please proceed to the Usage guide for details on how to use WooCommerce Zapier.

Usage ↑ Back to top

Once you have installed the WooCommerce Zapier plugin on your WooCommerce store, configuring your Zaps/integrations (Triggers and Actions) is done on via the Zapier.com website.

Make a Zap ↑ Back to top

Tip:

If you haven’t created a Zap before, please refer to Zapier’s key concepts article before proceeding.

To create a WooCommerce Zap, we recommend using one of the Zap templates, as it is typically quicker than hand-crafting your own Zap from scratch.

Tip:

The actual fields and data can vary depending on the WordPress and WooCommerce versions installed, and by installed plugins and settings. If you are using an Actions template, please refresh the fields to make sure everything is updated to match your individual store.

If you would like to start from scratch, go to your Zapier dashboard page on zapier.com and press the Make Zap button on the left sidebar to set up a new Zap. Alternatively, you can start typing directly on that page.

Zapier Dashboard

Create a Trigger (Outgoing Connection)

This feature allows you to send WooCommerce data to a Zapier Zap.

Step 1: Configure your Trigger step

  1. In the Choose App & Event step, search for the WooCommerce app and click it.
  2. Select the Resource (data type) in the Choose Trigger Event dropdown — for example, Order if you would like to send WooCommerce orders to Zapier.
  3. In the Choose Account step, click on Sign in to WooCommerce button to authenticate your Zapier account with your WooCommerce store.
    If you already authenticated, you can choose the previously used authentication from the WooCommerce account dropdown menu instead.

Tip: If you encounter issues while authenticating, please refer to our Troubleshooting Authentication Errors documentation.

  1. In the Customise…6 step, select a Trigger Rule from the Trigger Rule dropdown: — for example, Order created.
    See here for details on which Trigger Rule to use.
  2. In the Find Data step, click the Test & Continue button to retrieve sample data from your WooCommerce store.

Find Data:

When retrieving sample data from your store, it isn’t contextual to the Trigger Rule you have chosen for the Zap. Find Data simply retrieves your most recent store data (regardless of status) when getting sample data.

However, once you turn on on your Zap, the trigger rule will apply and should only send relevant data to Zapier.

Step 2: Configure your Action step

  1. In the Choose App & Event step, choose a service to send your WooCommerce data to.
  2. Finish configuring the the Action step. Please see Zapier’s instructions on setting up your Zap action for more details.

Step 3: Finish Zap Creation ↑ Back to top

Create an Action (Incoming Connection)

New in version 2.0:

Actions allow you to create new (or update existing) WooCommerce data from a Zapier Zap.

Step 1: Configure Trigger steps

  1. In the Choose App & Event step, choose a service to get the data what send to WooCommerce to.
  2. Finish configuring the the Trigger.

Step 2: Configure Action steps

  1. In the Choose App & Event step, select the WooCommerce app.
  2. Choose the Action in the Choose Action Event dropdown — for example, Create Order.
  3. In the Choose Account step, click on Sign in to WooCommerce button to authenticate your Zapier account with your WooCommerce store.
    If you already authenticated, you can choose the previously used authentication from the WooCommerce account dropdown menu instead.

Tip: If you encounter issues while authenticating, please refer to our Troubleshooting Authentication Errors documentation.

  1. In the Customise…6 step, fill in all of the WooCommerce input fields that you want to send data to. You can choose data fields from the Trigger part of your Zap, or you can type in hard-coded values.
  2. In the Send Data step, click the Test & Continue button to finish the Action configuration.

Step 3: Finish Zap Creation ↑ Back to top

Update a Resource

New in version 2.0:

This feature allows you to update existing data in WooCommerce from a Zapier Zap. For example, you could create a Zap that updates the inventory (stock) level of a WooCommerce product via a Zap automation.

If you know the ID of a WooCommerce Resource (for example coming fom a previous step), you can update that resource with the new Update Action.

Configure your Zap as seen in the Create an Action chapter above, and in the Choose Action Event dropdown select the corresponding Update Action. Keep in mind updating a Resource always needs a valid ID. To help identify the correct Resource ID, you can use a Find step before the update step.

Create a Resource

New in version 2.0:

This feature allows you to create new data in WooCommerce from a Zapier Zap. For example, you could create z Zap that creates a new Customer in WooCommerce whenever they subscribe to your mailing list.

Configure your Zap as seen in the Create an Action chapter above, and in the Choose Action Event dropdown select the corresponding Create Action.

The Zapier Integration (and WooCommerce itself) is quite relaxed when creating a new Resource. You can create orders, products, and subscriptions without any input, but that’s probably not what you want.

  • For Create Coupon, you must provide at least the Coupon code.
  • For Create Customer, you must provide at least the Customer email address.

The required fields are clearly labelled in the Zapier interface.

Tip: For more details on each data field, please consult the relevant Field Definitions documentation.

Find a Resource (Search)

New in version 2.0:

This feature allows you to search for existing WooCommerce data from a Zapier Zap. For example, you could search for a product based on it’s SKU before updating it in WooCommerce.

Configure your Zap as seen in the Create an Action chapter above, and in the Choose Action Event dropdown select the corresponding Find Action.

After finding a Resource you can immediately create one if its not found. This is a great way to implement synchronisation functionality between two apps using Zapier.

Create after Find

Alternatively, after searching you can add an additional step4 to your Zap to use the found Resource/data.

Advanced Zaps ↑ Back to top

In a Zap you can have additional steps between the Trigger and Action steps:

  • Use a Find step to access additional data.
  • Use the Code built-in app to transform data structures, or calculate new fields.
  • Use the Filter or Paths built-in apps to implement advanced logic or support multiple outputs.
  • Use the Formatter built-in app to transform fields values.

Note: Multi-steps Zaps require a paid Zapier account4. You can add multiple steps in a Zap to combine individual functionalities.

Find Steps

For accessing additional data in your Zap, you can add a Find step between your Trigger and Action steps in your Zap configuration.

You can see a list of available search (find) actions in the Searches documentation.

For example, if you are using one of the Order Triggers, and want to use the line item product category (or tag) in an action step as well, include a Find Product step and use the line_items —> sku or line_items —> product_id fields to pull all fields from the product, including the categories —> name (or tags —> name) array which you can then use in the next step of your Zap.

Code by Zapier

By adding the Code by Zapier step to your Zap, you can add fields based on the trigger data. For example, you can restructure, simplify or calculate new values. The output can be usable in the subsequent steps.

Please see Zapier’s help article for more details on how to use Javascript code in your Zaps.

Below are some examples of what you can achieve using a Code by Zapier step.

Heads Up:

The following code snippets are provided as examples only.

We are unable to provide support for writing custom code, so you may need to enlist the support of a a Certified Zapier Expert or Web Developer.

Add “Line Items Count” Field to an Order
// Define "lineItemIDs" in the Input Data section.
// Get the number of line items.
return { line_items_count: inputData.lineItemIDs.split(',').length };
  1. Add a Code by Zapier step to your Zap and choose Run Javascript for the Event Action.
  2. Define lineItemIDs by choosing the 1. Line Items ID in the Input Data section.
  3. Copy the above code snippet and paste it into the Code section.

The step should look like this:

Line Items Count Code settings

The result would show in the subsequent steps like this:

Line Items Count result

Add Meta Data Fields to a Trigger

Additional data for every Resource can be found in the corresponding Meta Data objects. Unfortunately, Zapier.com doesn’t handle these metadata objects very well by default. However with the following snippets, you can extract meta data information into an easily accessible list of fields. (The key used as the field name.)

To expose meta data for a specified Resource, follow these three steps:

  1. Add a Code by Zapier step to your Zap and choose Run Javascript for the Event Action.
  2. Define metaData in the Input Data section. Choose the corresponding fields based on your resource from the following table:
    Resource Field Name Input Data Section
    Coupon7,
    Customer,
    Order,
    Product
    meta_data Choose 1. Meta Data for metaData
    Line Item in an Order8 line_meta_data Choose 1. Line Meta Data for metaData
    Line Item in an Order order_meta_data Choose 1. Order Meta Data for metaData
    Subscription1 meta Choose 1. Meta for metaData

Info:

Ignore the fact that Zapier interface will show a NO Data label after the field name.

!!! danger “Heads Up”
If you would like to use meta data from Order Line Items in your Zaps, you must use the Line Item in an Order trigger, and not the Order Trigger. This is so that the Code by Zapier step reliably handles orders containing multiple line items.

  1. Copy the below code snippet and paste it into the Code section.
// Define "metaData" in the Input Data section. Ignore the "No Data" label.
// Reformat Resource Meta Data to generate key/value pairs.
// In case of multiple equal keys, only the last value available.
const buffer = {};
const metaData = inputData.metaData.split(/\n+/);
metaData.forEach((dataString, index) => {
  if (dataString.includes('id:')) {
    const key = metaData[index + 1].replace('key:', '').trim();
    const value = metaData[index + 2].replace('value:', '').trim();
    buffer[key] = value;
  }
});
return buffer;

Here is an example Code step:

Example Meta Key/Value Code settings (Order)

Example fields available in a subsequent steps:

Meta Key/Value result

Some plugins/extensions for WooCommerce store multiple values for the same key. If you want to access duplicated keys in your Meta Data, use the code snippet below instead, to automatically generate unique key names. Duplicated keys will be suffixed with a number, leaving the first key name unmodified:

// Define "metaData" in the Input Data section. Ignore the "No Data" label.
// Reformat Resource Meta Data to generate key/value pairs.
// Add number suffix for duplicated keys.
const buffer = {};
const keyNum = {};
const metaData = inputData.metaData.split(/\n+/);
metaData.forEach((dataString, index) => {
  if (dataString.includes('id:')) {
    const key = metaData[index + 1].replace('key:', '').trim();
    const value = metaData[index + 2].replace('value:', '').trim();
    keyNum[key] = typeof keyNum[key] === 'undefined' ? 1 : keyNum[key] + 1;
    const outputKey = keyNum[key] === 1 ? key : `${key}_${keyNum[key]}`;
    buffer[outputKey] = value;
  }
});
return buffer;

Filter by Zapier

Filter by Zapier allows you to add special conditions to Zaps. For example, using a filter you could configure a Zap to:

  • act only on orders with a status of refunded
  • act only on orders for a specific product category
  • act only on orders that exceed a specified order value
  • act only on orders that are to be shipped to a specific country

Please see Zapier’s help articles for more information on how to use filters in your Zaps.

Paths by Zapier

Paths by Zapier allows you to add branching logic to Zaps. The main advantage of using Paths is that you can create up to three different outputs (paths) within a single Zap.

Please see Zapier’s help article for more details.

Formatter by Zapier

With Formatter by Zapier you format data in Zaps. For example, you can split or combine field contents, convert between different number or date formats, or even transform the whole data structure.

Please see Zapier’s help article for more details.

Existing Connection ↑ Back to top

To manage, modify, or delete existing connections, please refer to the Zapier Help’s Manage your Zaps page.

Resources (Data Types)

The following WooCommerce Resources are supported in WooCommerce Zapier:

Tip: Click on the Resource name to see Trigger data and Action field definitions.

Warning:

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.

Field definitions in this documentation are generated with WordPress v5.3 and WooCommerce v3.9 with en-AU locale.

Trigger Rules

A Trigger Rule defines an event (or multiple events) that will cause WooCommerce data to be sent to a Zapier Zap.

Available Trigger Rules

Below is a description of all available Trigger Rules that can be used in your Zaps. Click on a Trigger Rule for more details and tips.

Tip: To see what has changed in Trigger Rules since the previous 1.x version, please see the Changes in Triggers chapter in the Migration Guide.

Trigger Rule Description
COUPONS7
Coupon created7 Triggers when a coupon is created.
Coupon deleted7 Triggers when a coupon is deleted (trashed).
Coupon restored7 Triggers when an already trashed coupon is restored from the trash.
Coupon updated7 Triggers when a coupon is updated/edited/changed/modified.
CUSTOMERS
Customer created Triggers when a WordPress user registers, a customer registers in the WooCommerce store, or customer data filled during checkout.
Customer deleted Triggers when a customer is deleted.
Customer updated Triggers when a WordPress user or a customer is updated/edited/changed/modified.
ORDERS
Order created9 Triggers when an order is created.
Order deleted9 Triggers when an order is deleted (trashed).
Order paid9 Triggers when an order is paid for. Occurs for real-time payment gateways (such as Stripe, PayPal, or most other credit card gateways).
Order restored9 Triggers when an already trashed order is restored from the trash.
Order status changed9 Triggers every time an order changes status.
Order updated9 Triggers when an order is updated/edited/changed/modified, including when an order is refunded.
PRODUCTS
Product created Triggers when a product is created
Product deleted Triggers when a product is deleted (trashed).
Product restored Triggers when an already trashed product is restored from the trash.
Product updated** Triggers when a product is updated/edited/changed/modified.
SUBSCRIPTIONS1
Subscription Created1 Triggers when a subscription is created.
Subscription Deleted1 Triggers when a subscription is deleted (trashed).
Subscription renewal failed1 Triggers when a subscription renewal payment fails
Subscription renewed1 Triggers when a subscription renewal payment completes successfully.
Subscription status changed1 Triggers every time a subscription changes status. Consider using with a Filter if you are interested in specific status changes only.
Subscription Switched1 Triggers when a user upgrades or downgrades a subscription from the My Account page.
Subscription Updated1 Triggers when a subscription is updated/edited/changed/modified/renewed/failed, including any status change.

Tips & Tricks ↑ Back to top

Some Trigger Rules are more complex than others. Below are some tips and tricks to help you get the most out of these more complex Trigger Rules.

Customers

Customer deleted

Note: There is no trash functionality for customers (users) in WordPress.

Orders

Order created

Note:

The Order created trigger will trigger for every order received (both paid and unpaid).

If you would like to trigger your Zap only when you receive a paid order, then consider using the Order Paid trigger instead.

Order paid

Tip for offline/deferred payment methods:

The Order paid trigger will not typically fire for offline/deferred payment methods such as Direct Bank Transfer (BACS), Check/Cheque or Cash on Delivery (COD).

If you are using an offline/deferred payment method, you have several choices:

  • Use the Order created trigger, which will trigger for both paid and unpaid orders.
  • Use the Order status changed trigger with a Filter, if you wish to trigger your Zap when you receive a payment for an order. You could filter on status = processing or status = completed. Your Zap will then trigger when you change an order’s status to processing or completed respectively.

Order status changed

Consider using with a Filter if you are interested in specific status changes only.

Note: For more information view the WooCommerce Order Status documentation.

Products

Product created

Note: Variable Products: Triggers for every product variation in a variable product, and the parent product as well.

Product updated

Triggers for every product variations in variable products as well.

Subscriptions

Subscription Created

Note: This will trigger for every subscription (both paid and unpaid).

Subscription status changed

Tip: For more information on the WooCommerce Subscriptions statuses and status flows, please see the Subscription Status Guide documentation.

Actions and Searches

An action is an event a Zap performs after it is triggered. Actions allow you to create, update or find WooCommerce data from a Zap.

Every Resource supports three basic actions (and searches) in the Zapier interface:

  • Create: for creating a new Resource in WooCommerce.
  • Update: for updating an existing Resource in WooCommerce.
  • Find: for searching for an existing Resource in WooCommerce.

Actions

Available Actions

Below is a description of all available Actions that can be used in your Zaps. Click on an Action for more details and tips.

Action Description
COUPONS7
Create Coupon7 Creates a new Coupon in WooCommerce.
Update Coupon7 Updates (modifies) an existing Coupon in WooCommerce.
CUSTOMERS
Create Customer Creates a new Customer in WooCommerce.
Update Customer Updates (modifies) an existing Customer in WooCommerce.
ORDERS
Create Order Creates a new Order in WooCommerce.
Update Order Updates (modifies) an existing Order in WooCommerce.
PRODUCTS
Create Product Creates a new simple Product in WooCommerce.
Update Product Updates (modifies) an existing simple Product in WooCommerce.
SUBSCRIPTIONS1
Create Subscription1 Creates a new Subscription in WooCommerce.
Update Subscription1 Updates (modifies) an existing Subscription in WooCommerce.

Tips & Tricks

Some Actions are more complex than others. Below are some tips and tricks to help you get the most out of these more complex Actions.

Coupons

Create Coupon

Here are some tips when using the Create Coupon action to create new WooCommerce Coupons via Zaps.

A common use case of this action to automatically create a unique coupon code for each customer that joins your mailing list.

To achieve this, in your Zap’s Create Coupon action, you would set the Email Restrictions data field to your customer’s email address from the Trigger (step 1) part of your Zap:

Email Restrictions Example

# Alphanumeric (Simple) Coupon Codes

When creating Coupons, it’s usually best to use simple alphanumeric coupon codes.

You can add a Code by Zapier step to your Zap which automatically generates an alphanumeric coupon code (a-z, 0-9 and hyphens only) based on the customer’s email address:

Code by Zapier Example

Input Data:

  • customer —> User Email Address From Step 1 in Your Zap (or any other uniquely identifiable information such as a customer name).
// Generate an alphanumeric coupon code (a-z, 0-9 and hyphens) based on the input.
return { slug: input.customer.replace(/[^A-Za-z0-9-]+/g, "") };

You can then use the result of this Code by Zapier step in your Create Coupon action:

Create Coupon Code Example

Tip: Using the WooCommerce URL Coupons Extension?: Please see here for some suggestions.

Searches

Searches let you find existing WooCommerce Zapier in a Zap, and then use it later in a subsequent step.

Available Searches

Below is a description of all available Search Actions that can be used in your Zaps.

Search Description
Find Coupon7 Searches for an existing Coupon in WooCommerce.
Optionally, create one if none are found.
Find Customer Searches for an existing Customer in WooCommerce.
Optionally, create one if none are found.
Find Order Searches for an existing Order in WooCommerce.
Optionally, create one if none are found.
Find Product Searches for an existing Product in WooCommerce.
Optionally, create one if none are found.
Find Subscription1 Searches for an existing Subscription in WooCommerce.
Optionally, create one if none are found.

Plugin Interface ↑ Back to top

The WooCommerce Zapier user interface is completely redesigned in version 2.

If you are upgrading from a previous 1.x version, please go to the Plugin Interface Changes chapter to see what’s changed and the Migrating Legacy Feeds chapter for instructions on how to migrate your existing Feeds and Zaps to the new method.

The information below describes the screens and interfaces that you see in your WooCommerce/WordPress dashboard.

Task History

New in version 2.0:

You can find the Task history in your WordPress Dashboard —> Side Menu —> WooCommerce —> Zapier screen —> Task History tab.

This is the main place to see every incoming and outgoing task/request for WooCommerce Zapier.

This includes any time that your WooCommerce store’s data is sent to one of your Zapier Zaps, or any time that Zapier creates or updates data in your WooCommerce store via one of your Zaps.

If the corresponding Resource is available in your store (i.e. not deleted), you can click on an individual item in the resource column, to open the related edit screen.

Task History

Note:

For performance reasons, task History records are stored and kept for 30 days before being automatically removed.

When the Task History is empty. It displays “No history records found.”

Resource History

New in version 2.0:

Every supported Resource screen (except for Customer) has a WooCommerce Zapier History metabox, located of the bottom of the screen when viewing/editing the Resource.

For example, when you are editing a Coupon, Product, Order or Subscription, you can see the Task History for that particular item.

Resource History

You can disable (hide) this metabox by clicking the Screen Options button on the top right corner and deselecting the WooCommerce Zapier History under the Boxes section and then applying (saving) the screen options.

Note: There is no dedicated “Customer” screen in WooCommerce. WooCommerce stores customers in the WordPress User screen.

Legacy Feeds

Available only if you have upgraded to version 2 from the previous 1.x version:

Location: WordPress Dashboard —> Side Menu —> WooCommerce —> Zapier screen —> Legacy Feeds tab.

If you have upgraded from the 1.x version, and you haven’t yet migrated your Zaps, you can see all existing Legacy Zapier Feeds. There is no option in version 2 to create a new Zapier Feed, but you can still edit and/or delete your existing one if you needed.

Legacy Feed

Legacy Feeds and Zaps must be migrated by 30 April 2021:

All Legacy Feeds and Zaps must be migrated to the new WooCommerce Zapier app before 30 April 2021.

Any Zaps using the WooCommerce (Legacy) app after this date will no longer work.

Please refer to the Migration Guide for details on how to migrate these legacy Zaps.

Note: When you delete your last Legacy Feed and empty the trash, the Legacy Feeds tab will disappear from WooCommerce and will no longer be accessible.

Status Screen

You can keep track of the overall status of the Zapier integration by going to the WordPress Dashboard —> Side Menu —> WooCommerce —> Status screen and then scrolling to the WooCommerce Zapier section towards the bottom of the screen. You can see detailed explanation of each row if you hover over the question mark with your pointer.

Status Screen

This information is also used by WooCommerce Zapier Support when you contact us.

Troubleshooting: This is the perfect place to start investigating if you encounters any error in the plugin. For further reference, please see the Troubleshooting Tips chapter.

Logs ↑ Back to top

To see the Zapier integration logs, go to your WordPress Dashboard —> Side Menu —> WooCommerce —> Status screen —> Logs tab and select the newest log whose name starts with woocommerce-zapier. To view the log, you need to press the View button.

This plugin uses WooCommerce’s facilities for logging. For more information on that, please see the Understanding the WooCommerce System Status Report documentation.

The WooCommerce Extension, by default, only logs significant errors that occurred within the plugin. You can enable detailed logging in the Settings Screen.

Note: The log file may be not exist if the plugin recently installed, or there are no recent errors/logs.

Plugin Settings ↑ Back to top

New in version 2.0:

Location: WordPress Dashboard —> Side Menu —> WooCommerce —> Settings screen —> Zapier tab.

Currently the only setting available for the WooCommerce Zapier plugin is to enable or disable the detailed logging.

If you are experiencing a problem with your integration (or technical support asks you to), you can turn detailed logging with Enable Detailed Logging checkbox.

See the Logs chapter how to access and view the Zapier Integration logs.

Other WooCommerce Screens ↑ Back to top

New in version 2.0:

The following lists consists various WooCommerce screens, which are exposing different parts of the inner workings of the WooCommerce Zapier plugin to the admin interface.

The WooCommerce Zapier extension depends on multiple WooCommerce core functionality, including REST API and Action Scheduler.

WooCommerce allows site administrators to inspect and/or modify these, however in normal use there should be no need for you to do so because it is managed automatically for you.

Danger: The following information is for reference only. Please be aware, that modifying the WooCommerce Extension behaviour manually is unsupported, and may break the Zapier Integration functionality.

WordPress Dashboard —> Side Menu —> WooCommerce —> Settings screen —> Advanced tab —> REST API
Lists the REST API Keys that allow other applications to authenticate with WooCommerce. You can find the Zapier integration authentication keys here, along with the other manually or automatically generated ones.
WooCommerce Zapier keys always start with Zapier - API Read/Write text, followed by the creation date. Upon removing a connection in the Zapier’s My Apps page, the REST API keys are automatically removed (revoked) from this list as well.
The number of used WooCommerce Zapier REST API authentication keys is also displayed on the Status Screen.

Note: The creation dates on the REST API keys screen and on the My Apps page may be different. For example, the plugin automatically monitors and revokes duplicated keys for a user if the key is not used for 30 days. This ensures that each WordPress administrator user can only have one key to communicate with Zapier.

WordPress Dashboard —> Side Menu —> WooCommerce —> Settings screen —> Advanced tab —> Webhooks
For every outgoing connections (Triggers), the plugin registers a webhook in WooCommerce.
These webhooks have a name starting with Zapier, followed by the corresponding Zap ID. Webhooks are created automatically you turn “ON” a Zap, and they are deleted when your turn “OFF” a Zap in the Zapier.com interface.
In normal usage, you should have one active WooCommerce Zapier webhook for each active Zap that has WooCommerce as a trigger.

Info: When a Zap is disabled, either because of a problem occurring or manually, the corresponding WooCommerce webhook will be removed. Upon turning the Zap “ON” again, the corresponding webhook will be created again.

WordPress Dashboard —> Side Menu —> WooCommerce —> Status screen —> Scheduled Actions tab
There are two different types of scheduled actions in the WooCommerce Zapier plugin: sending data via webhooks and utility tasks.

  • The webhook-related tasks have a Hook name of woocommerce_deliver_webhook_async and the argument has a related webhook_id. If you notice Pending woocommerce_deliver_webhook_async tasks, this means that data is queued to be sent to Zapier, but hasn’t been sent yet. You can safely click the Run link on each of these to force the data to be sent immediately.
  • Utility tasks are the wc_zapier_history_cleanup and the wc_zapier_key_cleanup. Both should be in the Pending section in all the time, and these should be left as-is.
    In the Complete section you can see the previously completed actions.

Frequently Asked Questions (FAQs) ↑ Back to top

Why Are My Zaps Are Not Being Sent? ↑ Back to top

See the explanation and solution in the No Data is Being Sent to Zapier chapter.

Can I Add Multiple WooCommerce Installations to My Zapier Account? ↑ Back to top

Yes you can!

Info: You need to install the WooCommerce Zapier plugin on each of the WooCommerce sites, which typically means purchasing multiple subscription for the Zapier Integration so each site can be eligible for updates and support. Each of those sites can be connected to the same Zapier account if you wish.

Can I Use WordPress Multisite? ↑ Back to top

Yes, WordPress multisite is supported!

To connect (authenticate) to a WordPress multisite installation, you need a separate authentication for each individual site.

Due to the current limitation of WordPress, you also need to authenticate with every site as a Super Admin, because administrators don’t have a capability to edit users (therefore customers) to the site.

Tip: You can read about creating and managing a multisite on WordPress.org in the Create A Network article.

WooCommerce Zaps also can’t be shared across individual sites in multisite. Instead, you need separate Zaps for each site. To streamline this process, you can duplicate a Zap once you created for the first site. In the duplication, you only need to switch the WooCommerce authentication/account to the other site.

Can I Use a Separate Zap for Each Product in an Order? ↑ Back to top

Each Zap set up will apply to all orders (and thus all products) by default, however a Filter by Zapier or a Paths by Zapier step can be added to each individual Zap so that it will only act (for example) on orders for a specific product name or SKU.

To set this up, you will need to create a separate Zap for each individual product or product category you want to have a specific action related to.

Then you will need to set up a conditional filter inside each of those Zap’s to specify which product you want it to fire for, and finalise it with an action (such as sending it to a specific spreadsheet).

With this setup, you would have a Zap for orders for each individual product in your store.

Please see the Integrating with More than One Service chapter for more details on Filter and Paths.

Info: This approach works well for stores with a few products, however if your store has many products (each needing their own Zap) then this approach isn’t very scalable or performant.

What About Order Line Items? ↑ Back to top

The WooCommerce Zapier plugin includes line item support since version 1.9.0. This includes having full support for handling arrays (lists) of data (such as multiple order line items).

Multiple line items can be used in supported action. For example you can create an itemised invoice in Quickbooks or Xero with multiple (separate) line items, provided that both Apps support line items.

Alternatively, you can use the Line Item in an Order trigger.

The same is true for all the other “array” type fields. For example in an order the downloadable_files and the notes fields.

Warning:

Zapier can support line items for specific apps but does not do so by default, so you’ll want to check to see if the action you’re want to pair with WooCommerce Zapier has line item support. Most often line item support relates to invoicing and financial apps, but some other apps do have support as well.

Please be careful while setting up the “Line Item in an Order” trigger. Tasks can be stopped and Zap can be disabled if the order doesn’t have line item. This usually not happens on production site, but common during development.

I Changed My Website’s URL or Domain Name, What Do I Need to Do? ↑ Back to top

After changing the URL of your website, please go to Zapier’s My Apps screen, and locate your existing WooCommerce authentication. Click the Reconnect button and re-authenticate with your WooCommerce store’s new URL. This tells Zapier to communicate with your new URL rather than the old URL.

After doing so, we recommend then going to Zapier’s My Zaps screen and editing and reviewing each WooCommerce Zap and test them to confirm that they are still working as expected.

Can This Extension Do [feature]?

New features are added to this extension based on customer demand.

We recommend searching for your idea on the WooCommerce Zapier Ideas Forum.

  • If your idea has already been suggested, please add your vote for it.
  • If your idea hasn’t already been suggested, post your idea on the Ideas Forum so that others can vote on your idea.

We review WooCommerce Zapier Ideas Forum suggestions regularly, and use the votes to understand how many customers are interested in the ideas posted. We then take this into account when planning future releases of WooCommerce Zapier.

How Can I Change the Format of the Order Date Field? ↑ Back to top

By default, the Order Date field is supplied in a universal timestamp format (ISO 8601 as per Zapier’s specification).

If required, the date/time format can be changed in your Zap by adding a Formatter action to your Zap. For further reference, see the Formatter chapter.

Example Date Formatter

Can I Send Previous (Historical) Data to Zapier? ↑ Back to top

After you install and configure WooCommerce Zapier, it will act on Resources that are changed from that point onwards.

For example, it won’t automatically send all previous orders to Zapier, but for certain Trigger Rules you can send data manually. For further reference see Manually Sending Data chapter.

What Data is Sent to or Received from Zapier? ↑ Back to top

Please see the Data Field Definitions for full details.

Is My Data Secure? ↑ Back to top

WooCommerce Zapier always sends and receives your WooCommerce over an HTTPS encrypted connection, which ensures the connection between your WooCommerce installation and the Zapier.com service is secure.

Your WooCommerce store require an SSL certificate for this secure connection to operate. Please see System Requirements for more details.

We also recommend familiarizing yourself with Zapier’s Terms of Service.

Please see GDPR Compliance chapter for more information on data privacy.

What Data Do You Store? ↑ Back to top

We, the developers of WooCommerce Zapier does not access, transfer or store any of your customers data whatsoever.

The WooCommerce Extension stores information of all the incoming or outgoing connections. Everything else is transferred as soon as possible from/to Zapier. The data is temporarily stored in memory and/or in a WordPress temporary table.

Please see GDPR Compliance chapter for more information on data privacy.

What Data Do You Collect? ↑ Back to top

We, the developer of the Zapier Integration (OM4) does not transfer or store any of your customers data whatsoever. In the event of support request, we request the WooCommerce status information and may request access to your WooCommerce store and Zapier account.

The WooCommerce Extension designed to collect and send (or receive) supported Resources data to (or from) the Zapier service. You can see all the data in the Field Definitions tables.

Please see GDPR Compliance chapter for more information on data privacy.

What Data Do You Share? ↑ Back to top

The WooCommerce Zapier Extension communicates directly between your WooCommerce store an Zapier. For reference, here is the Zapier Privacy Policy and Automattic (WooCommerce) Privacy Policy pages.

Please see GDPR Compliance chapter for more information on data privacy.

Troubleshooting ↑ Back to top

Troubleshooting Tips ↑ Back to top

Initial Setup

If you have issues during initial setup a Zap in Zapier, please refer to the Authentication Errors chapter below, or Zapier’s Troubleshooting documentation.

Once You’re Up and Running

Once your initial setup and configuration is completed and your WooCommerce Zapier integrations are running, most of the time if a problem occurs, it will be shown in your Zapier.com Task History screen.

If you experience stopped or halted tasks, please view the task details to decide whether what to do next. For further information, see the Task History chapter.

If it is an error, you can usually find the related information in the your WordPress Dashboard’s Task History screen. From there you can navigate to the actual Resource and inspect its WooCommerce Zapier History box, or you can review the Logs in your WordPress dashboard.

Issues with Zaps

If you are having other problems with a Zap that you have created, we recommend contacting Zapier Support. They are usually the best people to help you with any issues that you have within the Zapier dashboard, Zap configuration and/or behaviour.

General WooCommerce Issues

If you encounter errors or issues in WooCommerce, first visit the WooCommerce Status Screen to identify and troubleshoot errors, or look at the Logs.

If you need further support, please don’t hesitate to Contact Us and send a support request.

Enabling Detailed Logging

To help troubleshoot and identify the exact cause of an issue, our support team may ask you to do the following:

  1. Please go to your WordPress Dashboard —> Side Menu —> WooCommerce —> Settings screen —> Zapier tab, and then tick the Enable Detailed Logging checkbox and Save changes.
  2. Please install and activate the REST API Log plugin by going to your WordPress Dashboard —> Side Menu —> Plugins —> Add New, and searching for REST API Log and then click Install Now then Activate.

This allows our support team to see detailed information about your store, and will usually help us resolve an issue.

Zapier.com interface ↑ Back to top

Below are some common errors and issues that can occur when you are using the Zapier.com Zap Editor interface.

Authentication Errors

The authentication process involves the Zapier.com service connecting to your WooCommerce store using your WordPress username and password.

If you encounter an error when authenticating then please make a note of the red error message that you see in the Zapier Authentication popup window, and then look for that error message in the table below for the next steps.

Common Authentication Error Messages
Error message Reason Possible Solution(s)
‌You must use HTTPS (secure) connection! Not using a secure connection. Make sure you’re communicating to your WooCommerce store via HTTPS, and the URL you enter starts with https://.
If your WooCommerce store does not support HTTPS, please contact your website host or web developer.
‌The username and/or password you supplied is incorrect. Could not connect to WooCommerce, because the username or password is not valid. Make sure you’re using the correct username and password (the one you use to log into your WordPress Dashboard).
Check for conflicting plugins.
Use detailed logging to determine the reason for the authentication failure.
‌Sorry, this user does not have the correct permissions. The user used to authenticate with WooCommerce lacks the necessary permission. Connect with a user that has the “Administrator” role. The “Store Manager” role isn’t enough. Refer to WooCommerce’s documentation on Roles and Capabilities.
Check for conflicting plugins.
The WooCommerce Zapier plugin is missing or WordPress pretty permalinks not configured properly. The WooCommerce Zapier plugin is not installed on your WooCommerce store, or the WordPress permalinks are not configured correctly. Make sure you have installed the WooCommerce Zapier plugin.
Ensure that you have the latest version installed.
Ensure you have your WordPress permalink settings other than the default (see the requirements the System Requirements chapter).
Go to your WordPress Dashboard —> Side Menu —> Settings —> Permalinks screen and click Save to flush your permalinks.
‌Communication error. 400 Bad Request. Network issue between Zapier and WooCommerce, or incompatible plugin installed. Make sure you can access your website without any error.
Look around the WooCommerce’s Status page.
Disable any third-party plugins.
Use detailed logging to determine the reason for the authentication failure.
Unable to authenticate. Please check your username and password and try again. If the problem persists, please contact support. You entered an invalid username or password, or your website has a configuration issue that caused it to return a response that was not valid JSON data. Make sure you’re using the correct username and password (the one you use to log into your WordPress Dashboard).
Check for conflicting plugins.
Disable any plugins that interact or change with WordPress’ login procedures (such as custom login pages).
Ensure your website is publicly accessible, including disabling any “Coming Soon” or “Maintenance Mode” plugins.
Review our Troubleshooting REST API Issues guide.
Please contact support for further assistance.
Got 401 calling GET https://example.com/wp-json/wc-zapier/v1/ping, triggering auth refresh. WooCommerce accepted your username and password, however there is an issue authenticating with the WooCommerce REST API. Ensure that your website’s SSL Check is ok.
Check for conflicting plugins.
Use detailed logging to determine the reason for the authentication failure.
Please contact support for further assistance.
Unexpected token < in JSON at position 0 Your WooCommerce store’s WooCommerce REST API isn’t responding as expected. Ensure your website is publicly accessible, including disabling any “Coming Soon” or “Maintenance Mode” plugins.
Review our Troubleshooting REST API Issues guide.
Please contact support for further assistance.

<!–| Got 403 calling GET https://example.com/wp-json/wc-zapier/v1/ping, triggering auth refresh. | WooCommerce accepted your username and password, however your user account does not have permissions to read and access WooCommerce webhooks. | Add a brand new Administrator account to your store, and try authenticating with that account.
Avoid using any plugins or custom code that overrides/customises WordPress’ user roles and capabilities. | –>

If Your Username and Password are Correct but you Still Can’t Authenticate

If you continue to encounter an authentication error, and you are sure your username and password is correct, then it is likely you have a security-related plugin or service on your website that is preventing Zapier from authenticating with your WooCommerce store. For example:

If you are using one of these security plugins or services, please try temporarily disabling it, then authenticating, and then re-enabling the security feature(s) once you have successfully authenticated.

If you are using Two Factor Authentication (2FA) when logging in to WordPress, please consult the security plugin’s documentation on how to generate an application-specific password, and use that when authenticating WooCommerce with Zapier:

It isn’t usually feasible or practical to whitelist Zapier’s IP addresses, because they use Amazon AWS, which means the authentication attempts come from IP addresses are regularly changing.

Tip: Check for Conflicting Plugins: Please review our list of conflicting plugins to ensure one of those isn’t causing your authentication issues.

Using Detailed Logging to Determine the Reason for an Authentication Failure

If you still are unable to identify the cause of your authentication issues, please try the following:

  1. Ensure that you have the latest version of WooCommerce Zapier installed.
    You will need to be running version 2.0.2 or newer to complete the following steps.
  2. Enable detailed logging by going to your WordPress Dashboard —> Side Menu —> WooCommerce —> Settings screen —> Zapier tab, and then tick the Enable Detailed Logging checkbox and Save changes.
  3. Return the to Zap Editor on Zapier.com, and try and re-authenticate.
  4. The authentication attempt will likely fail again, however this time a detailed reason why it failed will be recorded in your WooCommerce logs.
  5. Go to your WordPress Dashboard —> Side Menu —> WooCommerce —> Status screen —> Logs tab and select the newest log whose name starts with woocommerce-zapier. Press the View button.
  6. The log should contain an Authentication attempt failed or Authentication validation failed message, along with a detailed reason that should help you determine the problem.

If you are able to solve the issue, that’s great!

If you’re not able to solve the issue yourself, please contact support and be sure to include the red error message from step 3 and the logged error message from step 6.

Tip: Please be sure to disable detailed logging once you have successfully authenticated.

Task History

You can see previously sent information to Zapier in the Zappier.com Task History page.

If the task encounters a problem, will be stopped. Zapier can distinguish between different types of problems, and stops affected task(s) automatically.

If the problem prevents not just that specific task, but any later task as well, then the task will be stopped and marked as “Errored.” If repeated errors occur then the corresponding Zap is also disabled.

Alongside the above error, Zapier can stop and mark a task as “Halted” if the problem will not affect future tasks from completing successfully.

Please consult the Troubleshoot Zaps documentation for more troubleshooting tips.

Tip:

If you need, you can resubmit halted or errored tasks in this page.

You can find more information in the Task History Help page in Zapier.

Errored Tasks

Tasks errors can occur for a wide variety of reasons, but you can always see the exact reason when you open your task history and look the error message. Here is an example of a task error:

Example Errored Task

The most common errors related to the WooCommerce Zapier plugin:

Error message Reason Solution
Coupons are not enabled… Coupons are not enabled in WooCommerce. Please enable Coupons in the WooCommerce Settings by following those instructions.
Subscriptions are not enabled… The Subscriptions plugin not installed or enabled If you want to use the Subscription Resource, install and activate the WooCommerce Subscriptions plugin.

Halted Tasks

Most of the time when a Zapier task is halted, is the expected behaviour. For example if you use a filter and the incoming data not matches what you filter for.

Another common reasons why a task is halted is that WooCommerce could not perform the specific task on the Resource. Every halted task has a detailed reason that you can refer in the task details page.

For example for the latter, the task will be halted if you trying to create a new coupon with a coupon code that already exists:

Example Halted Task

Example Reason in Halted Task Detail

Info: There are many possible reasons why a Zapier task can’t be completed. The WooCommerce Zapier plugin handles these cases for you to prevent introducing a problem in WooCommerce and always provide a detailed explanation in the task details page.

Zapier Service Outages

From time to-time, the Zapier.com service may have an outage or period of downtime. This can cause delays or occasionally skipped or errored tasks. Please be patient, up until the issue is resolved by Zapier and do not attempt to resubmit data.

If all Zapier services are working normal, you can start collecting information on what data missing.

To identify which data that you need to resubmit, first look the Zapier’s Task History page, and search for any errors. You can replay a task from this page.

If you still have missing data, because of they not arrived to Zapier at all, you can resend them with specific triggers. For further reference see Manually Sending Data chapter.

Tip: For the current Zapier service status information, please visit the Zapier Status page.

WooCommerce Store ↑ Back to top

If you are having any problems in your WooCommerce store, first please ensure that you have updated to the latest version of the WooCommerce Zapier plugin.

No Data is Being Sent to Zapier

WooCommerce Zapier uses Action Scheduler (which is integrated in WooCommerce core) to send data for Triggers.

This means that data is not sent immediately to Zapier. Instead the data is queued to be sent asynchronously in the background.

This helps ensure that your customers don’t experience a slow checkout process, and it also allows the extension to retry sending the data if there is an error communicating with Zapier.

A typical delay is between ten seconds and one minute, but in staging/testing/development environment or sites with extremely low traffic can be much longer.

Tip: Updating your WooCommerce to version 4.0 (or newer) will improve queue processing times and reduce delays in data delivery from WooCommerce to Zapier.

To check for Pending tasks, go to your WordPress Dashboard —> Side Menu —> WooCommerce —> Status screen —> Scheduled Actions tab, then click on the Pending filter. Look for tasks with a hook name of woocommerce_deliver_webhook_async. If you have one or more of these with a Pending status, it means that queued trigger data hasn’t been sent yet.

The scheduled actions queue is a WooCommerce core feature that needs to be working correctly in order for WooCommerce Zapier to send data to Zapier.

You can manually run Pending tasks from that screen, but if tasks remain Pending then you will need to identify why the action scheduler queue isn’t being processed automatically. Please see this article for some ideas on how to troubleshoot the issue.

If the problem persists, go to your logs screen and look for any errors in the recent Zapier log. For further information see the Logs chapter.

Resource Sent with Wrong Status

WooCommerce Zapier uses Action Scheduler (which is integrated in WooCommerce core) to send data for Triggers.

This means that data is not sent immediately to Zapier. Instead the data is queued to be sent asynchronously in the background.

This helps ensure that your customers don’t experience a slow checkout process, and it also allows the extension to retry sending the data if there is an error communicating with Zapier.

A typical delay is between ten seconds and one minute, but in staging/testing/development environment or sites with extremely low traffic can be much longer.

If a Resource status changing during scheduling and actually sending to Zapier, WooCommerce will send the Resource with the new status information to Zapier. Furthermore if you are using the Order status changed or the Subscription status changed triggers, in this case Zapier will receive the same data multiple times.

Info: There is an automatic de-duplication implemented in the Zapier platform, to prevent fire multiple tasks. Please Contact Us if you experiencing the above problem.

“Order Paid” Triggering Twice

There was a bug in previous WooCommerce versions, if you use the PayPal payment processor, the orders are completed twice. This bug was fixed in WooCommerce version 3.8. Please update your WooCommerce to version 3.8.0 or newer.

Note: If you want to validate this WooCommerce bug impacts you, look the affected orders, and in the sidebar look at the bottom of any order notes, you can see the WooCommerce status change is triggered twice. In both cases from “pending payment” to “completed”. Once for IPN, once for PDT.

Manually Sending Data

You can send data manually to Zapier for specific Trigger Rules, but not for all:

Trigger Name Manual Sending Support
Coupon created No
Coupon deleted No
Coupon restored No
Coupon updated Yes
Customer created No
Customer deleted No
Customer updated Yes
Order created No
Order deleted No
Order paid No
Order restored No
Order status changed Yes
Order updated Yes
Product created No
Product deleted No
Product restored No
Product updated Yes
Subscription Created No
Subscription Deleted No
Subscription renewal failed No
Subscription renewed No
Subscription status changed Yes
Subscription Switched No
Subscription Updated Yes

For Order status changed and Subscription status changed trigger rules, all you have to do to change the Order or Subscription status in the WooCommerce admin area. If you want to preserve the current status of, we recommend the following process: Disable the corresponding Zap, change the status of the affected items, enable the Zap and change the status back to the current state.

Warning: Don’t forget to disable automatic emails in WooCommerce (Side Menu —> WooCommerce —> Settings screen —> Email tab) before you start switching Order or Subscription statuses to avoid alerting customers. Also, keep in mind, customers will not receive emails for their new orders while automatic mails disabled. Try to do in a low sales volume time or put your store in maintenance mode (for example installing a plugin for that).

For all five updated Triggers, all you have to do to edit/change the specific resource.

If you want to keep your WooCommerce store’s data in sync with another system, for triggers that don’t support manually sending data, you will need to enter them in the target system manually.

Troubleshooting WooCommerce REST API Issues

The REST API is how Zapier communicates with your WooCommerce store to send and receive data, so your WooCommerce store’s REST API must be operational and working correctly.

We have listed some of the most common error messages that you may encounter when using WooCommerce Zapier with a WooCommerce store with REST API configuration issues:

  • Unexpected token < in JSON at position 0
  • Unhandled error: Error: Unable to authenticate. Please check your username and password and try again. If the problem persists, please contact support.

Coming Soon or Maintenance Mode

The most common cause is a simple one: your WooCommerce store isn’t publicly accessible because you have a “Coming Soon” or “Maintenance Mode” plugin active. Please try deactivating it, and ensure that people can view/visit your website without needing to log in to WordPress.

Invalid or Untrusted SSL Certificates

Your website must also have a valid and trusted SSL certificate installed Zapier to communicate with your WooCommerce store.

If you encounter an error message such as certificate verify failed, it usually means that the Zapier service isn’t able to successfully connect to your WooCommerce store because it uses an SSL certificate that was issued from a Certificate Authority that Zapier doesn’t trust.

Please consult this Zapier guide and this Zapier guide for further instructions, and if the problem persists please contact Zapier support for assistance.

Special Characters

Another common cause is that your website has at least one file in your WordPress website that has a strange character in it, such as a special byte-order mark (BOM) character. This causes every request to your website to contain a very rare and mostly invisible BOM character at the beginning of every response.

This invalid character doesn’t usually cause an issue for web browsers, however, it does cause an issue for apps (such as WooCommerce Zapier) that use the WooCommerce REST API for communicating with your website.

In our experience, the most likely cause is that the offending character is at the very beginning (or end) of your wp-config.php file. Or possibly it is at the very beginning and end of a plugin or theme file that you have installed.

The BOM character article above has some suggestions on which text editors you can use to help you find this character. It may also be necessary to temporarily switch to a default WordPress theme and deactivate all plugins (except WooCommerce and WooCommerce Zapier), and then reactivate them one-by-one to determine which one is causing the problem.

These general WordPress/WooCommerce configuration issues need to be solved for WooCommerce Zapier (and other REST API based integrations) to work correctly.

SSL Check Failing

In order for the WooCommerce REST API authentication process to work correctly, your website must be configured to use SSL correctly.

If your status screen shows SSL as red (No), then you will be unable to authenticate your WooCommerce store with Zapier:

SSL Check Failing Example

Often this results in a Got 401 calling GET https://example.com/wp-json/wc-zapier/v1/ping, triggering auth refresh error when you authenticate your WooCommerce store with Zapier.

If you review your WooCommerce Zapier logs, you will likely see the following error message:

CRITICAL: WooCommerce REST API Basic Authentication was not performed during ping because is_ssl() returned false. A HTTP 401 response occurred.

To resolve this issue, you will need to contact your web host and let them know that WordPress core’s is_ssl() function is returning false during WooCommerce REST API requests, and ask them to resolve this for you. Often it is an indication that your website’s SSL/HTTPS configuration isn’t correct.

Other Resources to Assist With REST API Issues

Here are some other great resources that may also be helpful:

Plugin Compatibility ↑ Back to top

With thousands of WooCommerce extensions, addons and plugins available for WooCommerce, it can be difficult to know if they are compatible with WooCommerce Zapier.

Below is a list of WooCommerce Extensions that we have tested with WooCommerce Zapier.

Note: If a plugin that you are using isn’t listed below, it doesn’t necessarily mean it is or isn’t compatible. You can always purchase the WooCommerce Zapier extension and use the 30-day money back guarantee to try it for yourself.

Tip: If you are a WooCommerce extension/plugin developer, please consult our Developer Documentation for details on how you can make your extension/plugin compatible with WooCommerce Zapier.

Compatible Plugins ↑ Back to top

Below is a list of WooCommerce extensions that are compatible with WooCommerce Zapier.

WooCommerce Subscriptions

Compatibility with the WooCommerce Subscriptions plugin was added in version 1.6 of WooCommerce Zapier. You must be running at WooCommerce Subscriptions version 2.4.3 or later.

If you have WooCommerce Subscriptions installed, you can use Subscriptions data in your Zaps (Triggers and Actions).

You may also wish to view the WooCommerce Subscriptions documentation.

Checkout Field Editor

Compatibility with the WooCommerce Checkout Field Editor plugin was added in version 1.1 of WooCommerce Zapier.

Any additional checkout fields added to your store by the WooCommerce Checkout Field Editor plugin will be sent to Zapier , allowing you to use your custom checkout fields in your Zaps that use any Order trigger events.

You may also wish to view the Checkout Field Editor documentation.

Sequential Order Numbers Pro

Compatibility with the WooCommerce Sequential Order Numbers Pro plugin was added in version 1.1 of the Zapier Integration plugin.

If using the WooCommerce Sequential Order Numbers Pro plugin, we recommend using the number data field (not the id data field) in your Zap Triggers. See the Order Data Fields documentation for full details on the number field.

You may also wish to view the Sequential Order Numbers Pro documentation.

WooCommerce Order Status Manager

Custom order statuses are supported, including ones created with the Order Status Manager extension.

We’d recommend using the Order status changed trigger rule, which triggers every time an order changes status (including changing to or from a custom order status).

WooCommerce Pre-Orders

Compatibility with the WooCommerce Pre-Orders plugin is included.

You typically need to use the Order status changed trigger rule, which will fire whenever an order changes status.

You can use this together with a filter to act only when an order changes status to pre-ordered:

Pre-Order Filter Example

See the documentation on filters for more information.

You may also wish to view the WooCommerce Pre-Orders documentation.

Groups for WooCommerce

Whilst we haven’t extensively tested these plugins together, we do know of users that are using them successfully.

If you are encountering memory exhausted errors when using WooCommerce Zapier and Groups for WooCommerce, please update to version 1.7.3 which includes a fix that prevents an infinite recursion bug in WooCommerce core.

You may also wish to view the Groups for WooCommerce documentation.

WooCommerce Gravity Forms Add-Ons

WooCommerce Zapier includes support for the Gravity Forms Add-Ons extension.

The Gravity Forms Add-Ons data is sent to Zapier as part of the line_items meta_data field, allowing it to be used in Zap filters.

Note: Please keep in mind that the Zapier Zap editor won’t be aware of your additional Gravity Forms product fields up until an order is placed on your WooCommerce store for that product. After that, you can open the Zap Editor and you should see your Gravity Forms fields along with the standard fields.

URL Coupons

WooCommerce Zapier lets you create new Coupons in Zaps (using the Create Coupon action).

If you are using the URL Coupons Extension, you can automatically configure the URL Coupons settings (such as Unique URL and Page Redirect) for the coupon when it is created via a Zap:

The Resulting Coupon in WooCommerce

To achieve this, in your Zap’s Create Coupon action, use the Meta Data field to set the _wc_url_coupons_unique_url metadata field. You would typically set it to the Slug output from the suggested Code by Zapier step:

Set Coupon Unique URL Meta Data

Important: Please be sure to read the URL Coupons documentation which describes important things to consider when setting Coupon URLs.

If you would also like to set the Page Redirect attribute for the coupon, you can do so by adding a subsequent Update Coupon action to your Zap, and using the Meta Data field to set the _wc_url_coupons_redirect_page meta data field to the page ID of your choice:

Set Coupon Page Redirect Page ID Metadata

And then adding another Update Coupon action to your Zap, and using the Meta Data field to set the _wc_url_coupons_redirect_page_type meta data field to page:

Set Coupon Page Redirect Page Type Metadata

Partially Compatible Plugins ↑ Back to top

Below is a list of WooCommerce extensions that are partially compatible with WooCommerce Zapier.

WooCommerce Product Add-Ons

WooCommerce Zapier includes support for the Product Add-Ons extension.

The Product Add-Ons data is sent to Zapier as part of the line_items and meta_data fields, allowing them to be used in Zap filters.

We don’t recommend using the Product Add-Ons data in Zap templates, unless all of your products have the same add-on fields available. This is because a Zap requires a predictable set of data fields coming through for each and every order line item.

Warning: The Product Add-Ons extension stores addon price information in the meta key field, which can result in a different key value from order to order, making the key name unpredictable and difficult to use in Zap actions.

Fancy Product Designer

Some WooCommerce Zapier users have reported success when using the Fancy Product Designer plugin, whereas others have encountered issues.

The Fancy Product Designer data is sent to Zapier as part of the line_items —> meta_data fields, allowing them to be used in Zaps.

Warning:

This plugin is prone to store vast amounts of information, which can lead to the data exceeding the current limitation of Zapier platform (6MB) for Order or Product triggers. When this happens, you may be unable to create a Zap, or the corresponding task will fail.

One possible solution for preventing this to happen that filtering out the outgoing data in WooCommerce, as described in the Modifying or Extending Data and Fields chapter.

Incompatible Plugins ↑ Back to top

Below is a list of WooCommerce extensions that are not currently compatible with WooCommerce Zapier.

WooCommerce Bookings

At this stage the WooCommerce Zapier extension does not support Booking information.

If you would like to see this featured added, we suggest following these instructions on how to request a new feature.

Conflicting Plugins ↑ Back to top

Below is a list of plugins that our users have reported having conflicts or issues with when using them with WooCommerce Zapier.

If you are using one of these plugins and can’t authenticate, then please deactivate the plugin and try again.

Uncanny LearnDash Toolkit

The Front End Login feature in this plugin causes issues when authenticating.

Please deactivate this feature (or the entire plugin) and try again.

WooCommerce Real-time Notifications for new orders

This plugin is known to cause issues when authenticating, with the following error message:

Got 401 calling GET https://example.com/wp-json/wc-zapier/v1/ping, triggering auth refresh.

Please deactivate the plugin and try again.

WP Content Copy Protection & No Right Click (premium)

This plugin is known to cause issues when authenticating.

Please deactivate the plugin and try again.

WP-SpamShield

The WP-SpamShield plugin is known to cause issues when authenticating.

Having this plugin active may cause you to receive either of the following error messages:

  • Sorry, this user does not have the correct permissions.
  • ERROR: Sorry, there was an error. Please be sure JavaScript and Cookies are enabled in your browser and try again.

Please deactivate the plugin and try again.

GDPR Compliance ↑ Back to top

WooCommerce Extension and Zapier App

You can typically achieve General Data Protection Regulation (GDPR) compliance whilst using WooCommerce Zapier, and we have provided some information below to help get you started.

Zapier Integration consists of a WooCommerce plugin (installed on your website) and a Zapier App (hosted on Zapier.com), working together to connect WooCommerce to Zapier and Zapier to WooCommerce.

WordPress ↑ Back to top

The Zapier Integration is a WordPress plugin, and to operate needs WordPress WooCommerce to be installed.

If you need GDPR compliance, you can usually achieve it with your WordPress installation. For reference see the Your WordPress.com Site and the GDPR page in wordpress.com, which can be adopted to self-hosted WordPress sites as well.

WooCommerce ↑ Back to top

Here is the WooCommerce’s GDPR Guide for related settings, and you can read the compliance in their blog post.

Tip: If you are using WordPress version 4.9.6 or newer, we provide a snippet about the integration and Zapier service, that you can include in your privacy policy page. Go to your WordPress Dashboard —> Side Menu —> Settings —> Privacy screen, and follow the Check out our guide link to access it.

Zapier ↑ Back to top

You can find out Zapier’s GPR compliance information in their support documentation.

Third Party Services Used in Your Zaps ↑ Back to top

You will also need to consider the GDPR implications of the third party services that you use in your Zaps, as these may handle customer data covered by the and needs to be evaluated carefully.

The sole purpose of the Zapier Integration is to transfer data between services.

Legal Advice ↑ Back to top

Please note that the above suggestions are not legal advice, and we strongly recommend consulting with a GDPR expert to help ensure that your store and business are GDPR compliant.

Uninstall ↑ Back to top

Deactivation ↑ Back to top

Deactivating the WooCommerce Zapier plugin will prevent all existing WooCommerce Zaps from working. Your WooCommerce store will no longer send data to Zapier, and will be unable to process incoming connections from your Zaps.

Your existing Zaps stays intact, however they will not work anymore. All of your WooCommerce Triggers will not produce any new tasks, and all of your Actions will return an error the next time a Zapier task is performed.

Uninstallation ↑ Back to top

The default behaviour for uninstalling (deactivating and deleting) the plugin is to keep your WooCommerce Zapier data in the WooCommerce store.

If you like, you can delete and reinstall the WooCommerce Extension many times. Your WooCommerce Zapier settings and data will not be lost. This especially helpful while troubleshooting your WooCommerce store.

If you decide to uninstall the WooCommerce Zapier plugin and you don’t plan to use it anymore, the recommended order of action is to go to Zapier.com and delete all WooCommerce Zaps in Zapier first and then uninstall the plugin. Also, you can permanently remove all WooCommerce Zapier data from WooCommerce too (see below).

Remove All Data

If you want, you can completely remove all WooCommerce Zapier data during uninstall. This includes settings, Task History, scheduled actions, and every registered WooCommerce Zapier Webhooks and REST API Authentication keys.

In order to permanently delete all plugin data upon uninstall, you need to add a following line to your wp-config.php file:

define("WC_ZAPIER_REMOVE_ALL_DATA", true);

After you have done this, go to your WordPress Dashboard —> Side Menu —> Plugins screen and deactivate and delete the WooCommerce Zapier plugin.

Once done, you can remove the WC_ZAPIER_REMOVE_ALL_DATA line from your wp-config.php file.

Refer to WordPress’ Editing wp-config.php documentation for further information how to edit your config.

Note: Uninstalling the WooCommerce Extension will not remove your Zaps and data on Zapier, even if you choose to delete all data from WooCommerce.

Glossary ↑ Back to top

Resource
Represents a specific type of WooCommerce data. For example, an Order, a Product, a Customer.
Connection
An actual communication between your WooCommerce store and a Zapier Zap. In this documentation we are using a couple of related terms of connection.
Connection Types
Incoming or Outgoing. Describes the direction of the data flow observed from the WooCommerce store perspective. Incoming connections are referred to as Actions, outgoing connections are referred to as Triggers.
Action
Incoming connection. See Connection Types.
Trigger
Outgoing connection. See Connection Types.
Trigger Rule
A rule that defines an event (or multiple events) that will cause WooCommerce data to be sent to a Zapier Zap.
WooCommerce Extension
Part of the integration which lives inside a WooCommerce store. This it the WooCommerce Zapier plugin that you have installed on your WooCommerce store.
Zapier App
Part of the integration which lives inside the zapier.com. This is the interface you see when using the WooCommerce app in a Zap.
Zapier Feed
Legacy term used to describe a specific connection between Zapier and WooCommerce before version 2.

  1. Only available if the WooCommerce Subscriptions plugin is installed. ↩︎ ↩︎ ↩︎ ↩︎ ↩︎ ↩︎ ↩︎ ↩︎ ↩︎ ↩︎ ↩︎ ↩︎ ↩︎ ↩︎ ↩︎
  2. Not required, but recommended for better performance and security. ↩︎
  3. See WooCommerce documentation for Roles and Capabilities↩︎
  4. Certain Zapier functionality, for example Filter, Paths and Multi-step Zaps are only available with a paid Zapier plan. For pricing information, please refer to the Zapier’s Plans & Pricing page↩︎ ↩︎ ↩︎
  5. Name is dynamically generated based on the Resource, what you selected in the Choose App & Event step. ↩︎ ↩︎
  6. Only available if the Coupon functionality is enabled in your WooCommerce store. (Enabled by default). ↩︎ ↩︎ ↩︎ ↩︎ ↩︎ ↩︎ ↩︎ ↩︎ ↩︎ ↩︎ ↩︎
  7. Only available as a trigger. ↩︎ ↩︎
  8. Available for both Order and Line Item in an Order↩︎ ↩︎ ↩︎ ↩︎ ↩︎ ↩︎

WooCommerce - the most customizable eCommerce platform for building your online business.

Back to the top