Skip to main content


This connector captures data from WooCommerce into Flow collections.

It is available for use in the Flow web application. For local development or open-source workflows, provides the latest version of the connector as a Docker image. You can also follow the link in your browser to see past image versions.


To set up the WooCommerce source connector with: you need:

  • WooCommerce 3.5+
  • WordPress 4.4+
  • Pretty permalinks in Settings > Permalinks so that the custom endpoints are supported. e.g. /%year%/%monthnum%/%day%/%postname%/
  • A new API key with read permissions and access to Customer key and Customer Secret.


Follow the steps below to set up the WooCommerce source connector.

Set up WooCommerce

  1. Generate a new Rest API key.
  2. Obtain Customer key and Customer Secret.

Set up the WooCommerce connector in Estuary Flow

  1. Log into your Estuary Flow account.
  2. In the left navigation bar, click on "Captures". In the top-left corner, click "Connector Search".
  3. Enter the name for the WooCommerce connector and select "WooCommerce" from the dropdown.
  4. Fill in "Customer key" and "Customer Secret" with the data from Step 1 of this guide.
  5. Fill in "Shop Name". For example, if your shop URL is, the shop name is ''.
  6. Choose the start date you want to start syncing data from.


You configure connectors either in the Flow web app, or by directly editing the catalog specification file. See connectors to learn more about using connectors. The values and specification sample below provide configuration details specific to the WooCommerce source connector.



/customer_keyCustomer KeyCustomer Key for API in WooCommerce shopstringRequired
/customer_secretCustomer SecretCustomer Secret for API in WooCommerce shopstringRequired
/shop_nameShop NameThe name of the store.stringRequired
/start_dateStart DateThe date you would like to replicate data from. Format: YYYY-MM-DDstringRequired


/streamStreamResource of your WooCommerce project from which collections are captured.stringRequired
/syncModeSync ModeConnection method.stringRequired


"properties": {


Supported Streams

The WooCommerce source connector in Estuary Flow supports the following streams:

  • Coupons (Incremental)
  • Customers (Incremental)
  • Orders (Incremental)
  • Order notes
  • Payment gateways
  • Product attribute terms
  • Product attributes
  • Product categories
  • Product reviews (Incremental)
  • Product shipping classes
  • Product tags
  • Product variations
  • Products (Incremental)
  • Refunds
  • Shipping methods
  • Shipping zone locations
  • Shipping zone methods
  • Shipping zones
  • System status tools
  • Tax classes
  • Tax rates

Connector-Specific Features & Highlights

Useful links:

WooCommerce Rest API Docs.