The tap-shopify extractor pulls data from Shopify that can then be sent to a destination using a loader.
Available Variants
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-shopify extractor to your project
using
:meltano add
-
Configure the tap-shopify settings using
:meltano config
-
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-shopify --variant matatika
meltano config tap-shopify set --interactive
meltano config tap-shopify 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-shopify
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:
- about
- catalog
- discover
- state
- stream-maps
You can
override these capabilities or specify additional ones
in your meltano.yml
by adding the capabilities
key.
Settings
The
tap-shopify
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-shopify 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.
Access Token (access_token)
-
Environment variable:
TAP_SHOPIFY_ACCESS_TOKEN
Your access token to authenticate with the Shopify API.
Configure this setting directly using the following Meltano command:
meltano config tap-shopify set access_token [value]
Store (store)
-
Environment variable:
TAP_SHOPIFY_STORE
Your Shopify store id, use the prefix of your admin url. e.g. https://[store].myshopify.com/admin.
Configure this setting directly using the following Meltano command:
meltano config tap-shopify set store [value]
Admin URL (admin_url)
-
Environment variable:
TAP_SHOPIFY_ADMIN_URL
Optional - The full admin url for your Shopify store (overrides 'store' property).
Configure this setting directly using the following Meltano command:
meltano config tap-shopify set admin_url [value]
Start Date (start_date)
-
Environment variable:
TAP_SHOPIFY_START_DATE
Optional - Start date to sync from.
Configure this setting directly using the following Meltano command:
meltano config tap-shopify set start_date [value]
Is Plus Account (is_plus_account)
-
Environment variable:
TAP_SHOPIFY_IS_PLUS_ACCOUNT
Optional - Enable Shopify plus account end points.
Configure this setting directly using the following Meltano command:
meltano config tap-shopify set is_plus_account [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.