Availability

Airbyte Cloud Airbyte OSS PyAirbyte

Support Level

Community

Latest Version

0.2.3

WooCommerce

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

Reference

Config fields reference

Field

Type

Property name

string

api_key

string

api_secret

string

shop

string

start_date

Changelog

Version	Date	Pull Request	Subject
0.2.5	2024-04-15	37289	Base image migration: remove Dockerfile and use the python-connector-base image
0.2.4	2024-04-12	37289	schema descriptions
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