Singer Tap for Shopify

This Shopify tap produces JSON-formatted data following the Singer spec.

tap-shopify is a Singer tap for the Shopify REST API built with the Meltano Tap SDK for Singer Taps.

Configuration

How to get your access_token: Shopify Docs.

• access_token String (required) - The access token to authenticate with the Shopify API.
• store String (required) - Shopify store id, use the prefix of your admin url. e.g. https://[your store].myshopify.com/admin.
• start_date String (optional) - The earliest record date to sync.
• admin_url String (optional) - The full admin url for your Shopify store (overrides 'store' property).
• is_plus_account Boolean (optional) - Enable Shopify plus account end points.

If you plan on using environment variables to declare these settings then you will be using:

• TAP_SHOPIFY_ACCESS_TOKEN
• TAP_SHOPIFY_STORE
• TAP_SHOPIFY_START_DATE
• TAP_SHOPIFY_ADMIN_URL
• TAP_SHOPIFY_IS_PLUS_ACCOUNT

Supported Streams

Default Streams

• Abandoned Checkouts
• Collects
• Custom Collections
• Customers
• Inventory Item
• Inventory Levels
• Locations
• Metafields
• Orders
• Products
• Transactions

Shopify Plus Streams

• User

Roadmap

• Add OAuth support w/ tests
• Update schema format for 'date-time' fields and 'singer.decimal'

Installation

Use pip to install a release from GitHub

pip install git+https://github.com/Matatika/[email protected]

Configuration

Accepted Config Options

A full list of supported settings and capabilities for this tap is available by running:

tap-shopify --about

Source Authentication and Authorization

To read data from your store, you need a Shopify access token.

For a single store, Shopify recommends you create a Custom App

1. Log in to your Shopify store admin at https://.myshopify.com/admin

2. Click “Apps” in the menu

3. Click “Develop apps for your store” in the "Build custom apps for your unique needs" section

4. Click the “Create an app” button and give you app a name.

5. Next you need to "Configure Admin API scopes" with read access to all resources you require. e.g. read_locales,read_products,read_orders,read_locations,read_inventory,read_fulfillments,read_customers,

6. Finally, in "API credentials" tab, click "Install app" button. Copy the Admin API access token

Usage

You can easily run tap-shopify by itself or in a pipeline using Meltano.

Executing the Tap Directly

tap-shopify --version
tap-shopify --help
tap-shopify --config CONFIG --discover > ./catalog.json

Developer Resources

Initialize your Development Environment

pipx install poetry
poetry install

Create and Run Tests

Create tests within the tap_shopify/tests subfolder and then run:

poetry run pytest

You can also test the tap-shopify CLI interface directly using poetry run:

poetry run tap-shopify --help

Testing with Meltano

Note: This tap will work in any Singer environment and does not require Meltano. Examples here are for convenience and to streamline end-to-end orchestration scenarios.

Your project comes with a custom meltano.yml project file already created. Open the meltano.yml and follow any "TODO" items listed in the file.

Next, install Meltano (if you haven't already) and any additional plugins:

# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-shopify
meltano install

Now you can test and orchestrate using Meltano:

# Test invocation:
meltano invoke tap-shopify --version
# OR run a test `elt` pipeline:
meltano elt tap-shopify target-jsonl

Cloud hosting and SaaS

Our team would be happy to help www.matatika.com

License

AGPLv3 License

It is our intention that all subsequent changes to this software are made available to the community. Under the terms of this license, you must open source your platform code if you distribute this software-as-a-service. Applications that reside inside an organization’s network do not trigger the release of the source code.

Helpful commands for local testing

pip install poetry

poetry install

Get every catalog

poetry run tap-shopify --config config.json --discover > all_catalogs.json

Get a specific catalog (e.g. products)

jq '.streams = [.streams[] | select(.stream == "products")]' all_catalogs.json > products_catalog.json

Run tap for a specific catalog (e.g. products)

poetry run tap-shopify --config config.json --catalog products_catalog.json > products_output.jsonl

---

Copyright © 2022 Matatika