Shopify

tap-shopify from singer-io

Ecommerce platform

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:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

  1. Add the tap-shopify extractor to your project using
    meltano add
    :
  2. meltano add extractor tap-shopify
  3. Configure the tap-shopify settings using
    meltano config
    :
  4. meltano config tap-shopify set --interactive
  5. Test that extractor settings are valid using
    meltano config
    :
  6. meltano config tap-shopify test

Next steps

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:

  • catalog
  • discover
  • state

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

Store Subdomain (shop)

  • Environment variable: TAP_SHOPIFY_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)

  • Environment variable: TAP_SHOPIFY_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)

  • Environment variable: TAP_SHOPIFY_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.

Commands

The tap-shopify extractor supports the following commands that can be used with
meltano invoke
:

Something missing?

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

Edit it on GitHub!

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.

Install

meltano add extractor tap-shopify

Maintenance Status

  • Maintenance Status
  • Stars
  • Forks
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Stitch Data

Meltano Stats

  • Total Executions (Last 3 Months)
  • Projects (Last 3 Months)

PyPI Stats

  • PyPI Downloads
  • PyPI Package Version

Keywords

  • api