The tap-woocommerce extractor pulls data from WooCommerce that can then be sent to a destination using a loader.
Alternate Implementations
- Airbyte 🥉
- Hotglue (default)🥈
- Stitch Data 🥉
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-woocommerce extractor to your
project using
:meltano add
-
Configure the tap-woocommerce
settings using
:meltano config
-
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-woocommerce
meltano config tap-woocommerce set --interactive
meltano config tap-woocommerce test
Next steps
Follow the remaining steps of the Getting Started guide:
If you run into any issues, learn how to get help.
Capabilities
The current capabilities for
tap-woocommerce
may have been automatically set when originally added to the Hub. Please review the
capabilities when using this extractor. If you find they are out of date, please
consider updating them by making a pull request to the YAML file that defines the
capabilities for this extractor.
This plugin has the following capabilities:
- catalog
- discover
- state
You can
override these capabilities or specify additional ones
in your meltano.yml
by adding the capabilities
key.
Settings
The
tap-woocommerce
settings that are known to Meltano are documented below. To quickly
find the setting you're looking for, click on any setting name from the list:
You can also list these settings using
with the meltano config
list
subcommand:
meltano config tap-woocommerce list
You can
override these settings or specify additional ones
in your meltano.yml
by adding the settings
key.
Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.
Consumer Key (consumer_key)
-
Environment variable:
TAP_WOOCOMMERCE_CONSUMER_KEY
WooCommerce API Consumer Key
Configure this setting directly using the following Meltano command:
meltano config tap-woocommerce set consumer_key [value]
Consumer Secret (consumer_secret)
-
Environment variable:
TAP_WOOCOMMERCE_CONSUMER_SECRET
WooCommerce API Consumer Secret
Configure this setting directly using the following Meltano command:
meltano config tap-woocommerce set consumer_secret [value]
Site URL (site_url)
-
Environment variable:
TAP_WOOCOMMERCE_SITE_URL
WooCommerce Site URL
Configure this setting directly using the following Meltano command:
meltano config tap-woocommerce set site_url [value]
Start Date (start_date)
-
Environment variable:
TAP_WOOCOMMERCE_START_DATE
Determines how much historical data will be extracted. Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.
Configure this setting directly using the following Meltano command:
meltano config tap-woocommerce set start_date [value]
Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-general
channel.