WooCommerce

Availability:

Airbyte Cloud Airbyte OSS PyAirbyte

Support Level:

Airbyte Connector

Connector Version:

0.4.9(Last updated 2 days ago)

CDK Version:

4.6.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:

• Full Refresh - Overwrite
• Full Refresh - Append
• Incremental - Append
• Incremental - Append + Deduped

Supported 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

Data type map

Integration Type	Airbyte Type	Notes
string	string
integer	integer
number	number
array	array
object	object
boolean	boolean

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

Version	Date	Pull Request	Subject
0.4.9	2024-09-21	45776	Update dependencies
0.4.8	2024-09-14	45534	Update dependencies
0.4.7	2024-09-07	45230	Update dependencies
0.4.6	2024-08-31	44957	Update dependencies
0.4.5	2024-08-24	44627	Update dependencies
0.4.4	2024-08-19	44388	Update the CDK version to support RFR for Low-Code substreams
0.4.3	2024-08-17	44228	Update dependencies
0.4.2	2024-08-12	43786	Update dependencies
0.4.1	2024-08-10	43487	Update dependencies
0.4.0	2024-08-06	43323	Update CDK to v4, Python 3.10
0.3.1	2024-08-03	43054	Update dependencies
0.3.0	2024-07-26	42551	Make builder compatible
0.2.13	2024-07-27	42637	Update dependencies
0.2.12	2024-07-20	42157	Update dependencies
0.2.11	2024-07-13	41731	Update dependencies
0.2.10	2024-07-10	41581	Update dependencies
0.2.9	2024-07-09	41161	Update dependencies
0.2.8	2024-07-06	40814	Update dependencies
0.2.7	2024-06-25	40375	Update dependencies
0.2.6	2024-06-22	40094	Update dependencies
0.2.5	2024-06-06	39270	[autopull] Upgrade base image to v1.2.2
0.2.4	2024-05-21	38544	[autopull] base image + poetry + up_to_date
0.2.3	2023-06-02	26955	Added block_context and author properties to the Products stream
0.2.2	2023-03-03	23599	Fix pagination and removed lookback window
0.2.1	2023-02-10	22821	Specified date formatting in specification
0.2.0	2022-11-30	19903	Migrate to low-code; Certification to Beta
0.1.1	2021-11-08	7499	Remove base-python dependencies
0.1.0	2021-09-09	5955	Initial Release. Source WooCommerce