The tap-shopify Singer tap pulls data from Shopify that can then be sent to a destination using a Singer target.

Alternative variants #

Multiple variants of tap-shopify are available. This document describes the default singer-io variant, which is recommended for new users.

Alternative variants are:

Standalone usage #

Install the package using pip: 

pip install tap-shopify

For additional instructions, refer to the README in the repository.

Usage with Meltano #

Meltano helps you manage your configuration, incremental replication, and scheduled pipelines.

View the Meltano-specific tap-shopify instructions to learn more.

Capabilities #

These capabilities can also be overriden by specifying the capabilities key in your meltano.yml file.

Settings #

The settings for tap tap-shopify that are known to Meltano are documented below. To quickly find the setting you're looking for, use the Table of Contents at the top of the page.

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 tap.

Store Subdomain (shop) #

The store subdomain, which can be derived from your Shopify admin URL.

If your admin URL starts with https://my-first-store.myshopify.com/, your store subdomain is my-first-store.

Private App API Password (api_key) #

A Private App API Password or API Key generated using OAuth

How to get #

Create private app #

First, you will need to create a Private App:

  1. Log in to your Shopify store admin at https://<store subdomain>.myshopify.com/admin
  2. Click “Apps” in the sidebar on the left
  3. On the bottom of the page, click “Manage private apps” next to “Working with a developer on your shop?”
  4. Click the “Create a new private app” button
  5. Enter a “Private app name” of your choosing, e.g. “Meltano”
  6. Enter your email address under “Emergency developer email”
  7. In the “Admin API” section, click “▼ Review disabled Admin API permissions”
  8. Choose “Read access” rather than “No access” in the access level dropdowns for the following permissions:
  9. Products, variants and collections - read_products, write_products
  10. Orders, transactions and fulfillments - read_orders, write_orders
  11. Customer details and customer groups - read_customers, write_customers
  12. Click “Save”
  13. In the modal that appears, click “I understand, create the app”
Find your API password #

Now that your app has been created, we can acquire the password Meltano will use to authenticate with the Shopify API.

  1. In the “Admin API” section on the private app details page, find the “Password” field and click “Show”
  2. The value that appears (starting with shppa_) is your API password. You can copy and paste it into the Meltano data source configuration.

Screenshot of Shopify interface showing private app API password

Start Date (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.

Looking for help? #

If you're having trouble getting the tap-shopify tap 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. Edit it on GitHub!