The tap-shopify Meltano extractor pulls data from the Shopify API that can then be sent to a destination using a loader.

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

Using the Command Line Interface

  1. Add the tap-shopify extractor to your project using meltano add :

    meltano add extractor tap-shopify --variant singer-io
  2. Configure the settings below using meltano config .

Using Meltano UI

  1. Start Meltano UI using meltano ui:

    meltano ui
  2. Open the Extractors interface at http://localhost:5000/extractors.
  3. Click the “Add to project” button for “Shopify”.
  4. Choose "Add variant 'singer-io'".
  5. Configure the settings below in the “Configuration” interface that opens automatically.

Next steps

Follow the remaining steps of the Getting Started guide:

  1. Select entities and attributes to extract
  2. Add a loader to send data to a destination
  3. Run a data integration (EL) pipeline

If you run into any issues, learn how to get help.

Settings

These and other supported settings are documented below. To quickly find the setting you're looking for, use the Table of Contents at the top of the page.

Store Subdomain (shop)

How to use

Manage this setting using Meltano UI, meltano config, or an environment variable:

meltano config tap-shopify set shop <shop>

export TAP_SHOPIFY_SHOP=<shop>

Private App API Password (api_key)

How to use

Manage this setting using Meltano UI, meltano config, or an environment variable:

meltano config tap-shopify set api_key <api_key>

export TAP_SHOPIFY_API_KEY=<api_key>

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.

How to use

Manage this setting using Meltano UI, meltano config, or an environment variable:

meltano config tap-shopify set start_date YYYY-MM-DDTHH:MM:SSZ

export TAP_SHOPIFY_START_DATE=YYYY-MM-DDTHH:MM:SSZ

Looking for help?

If you're having trouble getting the tap-shopify extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the #plugins-general channel.

Found an issue on this page?

This page is generated from a YAML file that you can contribute changes to!