Skip to main content

WooCommerce

Availability
Available Airbyte Cloud Available Airbyte OSS
Support Level
Community
Latest Version
0.2.3
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 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

Changelog​

VersionDatePull RequestSubject
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?