Skip to main content

WooCommerce

Availability
Available CoreAvailable StandardAvailable PlusAvailable ProAvailable Enterprise FlexAvailable Self-Managed EnterpriseAvailable PyAirbyte
Support Level
Airbyte
Connector Version
0.5.34 (last updated 14 days ago)
Sync Success Rate
Usage Rate
Definition ID
2a2552ca-9f78-4c1c-9eb7-4d0dc66d72df

This page contains the setup guide and reference information for the WooCommerce source connector.

Prerequisites​

To set up the WooCommerce source connector, you need:

  • WooCommerce 3.5 or later
  • WordPress 4.4 or later
  • Pretty permalinks enabled in Settings > Permalinks so that custom endpoints are supported. For example, /%year%/%monthnum%/%day%/%postname%/.

You also need a WooCommerce REST API key with read permissions. The setup process generates a Consumer key and Consumer secret that you use to authenticate.

Setup guide​

Step 1: Generate WooCommerce REST API keys​

  1. In your WordPress admin panel, go to WooCommerce > Settings > Advanced > REST API.
  2. Click Add key.
  3. Enter a description, select a user with access to your store data, and set the permissions to Read.
  4. Click Generate API key.
  5. Copy the Consumer key and Consumer secret. The consumer secret is only displayed once.

For more details, see the WooCommerce REST API authentication documentation.

Step 2: Set up the WooCommerce connector in Airbyte​

For Airbyte Cloud:​

  1. Log into your Airbyte Cloud account.
  2. In the left navigation bar, click Sources. In the top-right corner, click + New source.
  3. Select WooCommerce from the Source type dropdown and enter a name for the connector.
  4. Enter the Consumer key and Consumer secret from Step 1.
  5. Enter the Shop Name. For https://EXAMPLE.com, the shop name is EXAMPLE.com.
  6. Choose the Start Date to begin syncing data from.
  7. (Optional) Adjust the Number of Concurrent Threads to control sync parallelism. The default is 4. Higher values can speed up syncs but may cause rate limiting depending on your hosting provider. Valid range: 2-12.

For Airbyte Open Source:​

  1. Navigate to the Airbyte Open Source dashboard.
  2. Click Sources, then click + New source.
  3. Select WooCommerce from the Source type dropdown and enter a name for the connector.
  4. Enter the Consumer key and Consumer secret from Step 1.
  5. Enter the Shop Name. For https://EXAMPLE.com, the shop name is EXAMPLE.com.
  6. Choose the Start Date to begin syncing data from.
  7. (Optional) Adjust the Number of Concurrent Threads to control sync parallelism. The default is 4. Higher values can speed up syncs but may cause rate limiting depending on your hosting provider. Valid range: 2-12.

Supported sync modes​

The WooCommerce source connector supports the following sync modes:

Supported streams​

Limitations & Troubleshooting​

Expand to see details about WooCommerce connector limitations and troubleshooting.

Connector limitations​

Rate limiting​

The WooCommerce REST API does not enforce built-in rate limits. Actual rate limits depend on your hosting provider. Shared hosting environments typically allow 2-5 requests per second. The connector applies a default rate budget of 5 requests per second and handles HTTP 429 responses automatically.

If your hosting environment supports higher throughput, you can increase the Number of Concurrent Threads setting (up to 12) in the connector configuration to speed up syncs. If you experience rate limiting errors, reduce this value.

Reference​

Config fields reference

Field
Type
Property name
string
api_key
string
api_secret
string
shop
string
start_date

Changelog​

Expand to review
VersionDatePull RequestSubject
0.5.35-rc.22026-04-1276253Increase default concurrency from 4 to 5 for tuning iteration 2
0.5.35-rc.12026-04-1076205Add concurrency_level and num_workers for concurrent stream syncing
0.5.342026-03-3175853Update dependencies
0.5.332026-03-2475380Update dependencies
0.5.322026-03-1074674Update dependencies
0.5.312026-02-2473889Update dependencies
0.5.302026-02-1072988Update dependencies
0.5.292026-02-0372658Update dependencies
0.5.282026-01-2072054Update dependencies
0.5.272026-01-1471438Update dependencies
0.5.262025-12-1970708Update dependencies
0.5.252025-11-2570138Update dependencies
0.5.242025-11-1869676Update dependencies
0.5.232025-11-1369282Add client side incremental sync support for customers stream
0.5.222025-10-2968975Update dependencies
0.5.212025-10-2268591Add suggestedStreams
0.5.202025-10-2168393Update dependencies
0.5.192025-10-1467941Update dependencies
0.5.182025-10-0767328Update dependencies
0.5.172025-10-0166455Update dependencies
0.5.162025-09-0965708Update dependencies
0.5.152025-08-2465450Update dependencies
0.5.142025-08-1064822Update dependencies
0.5.132025-08-0264347Update dependencies
0.5.122025-07-2764087Update dependencies
0.5.112025-07-1963629Update dependencies
0.5.102025-07-1263207Update dependencies
0.5.92025-07-0562689Update dependencies
0.5.82025-06-2862259Update dependencies
0.5.72025-06-2161763Update dependencies
0.5.62025-06-1561474Update dependencies
0.5.52025-05-3151438Update dependencies
0.5.42024-12-2850800Update dependencies
0.5.32024-12-2150335Update dependencies
0.5.22024-12-1449382Update dependencies
0.5.12024-12-1147510Starting with this version, the Docker image is now rootless. Please note that this and future versions will not be compatible with Airbyte versions earlier than 0.64
0.5.02024-10-1646956Promoting release candidate 0.5.0-rc.1 to a main version.
0.5.0-rc.12024-10-0846575Migrate to Manifest-only
0.4.122024-10-1246806Update dependencies
0.4.112024-10-0546423Update dependencies
0.4.102024-09-2846193Update dependencies
0.4.92024-09-2145776Update dependencies
0.4.82024-09-1445534Update dependencies
0.4.72024-09-0745230Update dependencies
0.4.62024-08-3144957Update dependencies
0.4.52024-08-2444627Update dependencies
0.4.42024-08-1944388Update the CDK version to support RFR for Low-Code substreams
0.4.32024-08-1744228Update dependencies
0.4.22024-08-1243786Update dependencies
0.4.12024-08-1043487Update dependencies
0.4.02024-08-0643323Update CDK to v4, Python 3.10
0.3.12024-08-0343054Update dependencies
0.3.02024-07-2642551Make builder compatible
0.2.132024-07-2742637Update dependencies
0.2.122024-07-2042157Update dependencies
0.2.112024-07-1341731Update dependencies
0.2.102024-07-1041581Update dependencies
0.2.92024-07-0941161Update dependencies
0.2.82024-07-0640814Update dependencies
0.2.72024-06-2540375Update dependencies
0.2.62024-06-2240094Update dependencies
0.2.52024-06-0639270[autopull] Upgrade base image to v1.2.2
0.2.42024-05-2138544[autopull] base image + poetry + up_to_date
0.2.32023-06-0226955Added block_context and author properties to the Products stream
0.2.22023-03-0323599Fix pagination and removed lookback window
0.2.12023-02-1022821Specified date formatting in specification
0.2.02022-11-3019903Migrate to low-code; Certification to Beta
0.1.12021-11-087499Remove base-python dependencies
0.1.02021-09-095955Initial Release. Source WooCommerce
Was this page helpful?