Skip to main content

WooCommerce

Availability:
Available Airbyte CloudAvailable Airbyte OSSAvailable PyAirbyte
Support Level:
Airbyte Connector
Connector Version:
0.4.2(Last updated 4 days ago)
CDK Version:
4.3.2
Sync Success Rate:
Usage Rate:

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

Prerequisites​

To set up the WooCommerce source connector with Airbyte, you must be using:

  • WooCommerce 3.5+
  • WordPress 4.4+
  • Pretty permalinks in Settings > Permalinks so that the custom endpoints are supported. e.g. /%year%/%monthnum%/%day%/%postname%/

You will need to generate new API key with read permissions and use Customer key and Customer Secret.

Setup guide​

Step 1: Set up WooCommerce​

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

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. On the Set up the source page, enter the name for the WooCommerce connector and select WooCommerce from the Source type dropdown.
  4. Fill in Customer key and Customer Secret with data from Step 1 of this guide.
  5. Fill in Shop Name. For https://EXAMPLE.com, the shop name is 'EXAMPLE.com'.
  6. Choose start date you want to start sync from.
  7. (Optional) Fill in Conversion Window.

For Airbyte OSS:​

  1. Navigate to the Airbyte Open Source dashboard.
  2. Set the name for your source.
  3. On the Set up the source page, enter the name for the WooCommerce connector and select WooCommerce from the Source type dropdown.
  4. Fill in Customer key and Customer Secret with data from Step 1 of this guide.
  5. Fill in Shop Name. For https://EXAMPLE.com, the shop name is 'EXAMPLE.com'.
  6. Choose start date you want to start sync from.
  7. (Optional) Fill in Conversion Window.

Supported sync modes​

The WooCommerce source connector supports the following sync modes:

Supported Streams​

Connector-specific features & highlights​

Useful links:

Data type map​

Integration TypeAirbyte TypeNotes
stringstring
integerinteger
numbernumber
arrayarray
objectobject
booleanboolean

Limitations & Troubleshooting​

Expand to see details about WooCommerce connector limitations and troubleshooting.

Connector limitations​

Rate limiting​

The WooCommerce API allows to set custom rate limits to protect your store. If you set a custom rate limit, specify it in seconds in the maxSecondsBetweenMessages field in the metadata.yaml file. This value should be the maximum number of seconds between API calls.

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.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?