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.
- Add support for streams Abandoned Checkouts Collects Custom Collections Customers Inventory Item Inventory Levels Locations Metafields Transactions
- Pagination support w/ tests
- Add OAuth support w/ tests
- Add admin url override configuration test
- Fix failing test_core.py::test_standard_tap_tests
404 Client Error: Not Found for path: /api/2022-01/orders.json
- CI setup, fix lint and tests.
- Update schema format for 'date-time' fields and 'singer.decimal'
Use pip to install a release from GitHub
pip install git+https://github.com/Matatika/[email protected]A full list of supported settings and capabilities for this tap is available by running:
tap-shopify --aboutTo read data from your store, you need a Shopify access token.
For a single store, Shopify recommends you create a Custom App
-
Log in to your Shopify store admin at https://.myshopify.com/admin
-
Click “Apps” in the menu
-
Click “Develop apps for your store” in the "Build custom apps for your unique needs" section
-
Click the “Create an app” button and give you app a name.
-
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, -
Finally, in "API credentials" tab, click "Install app" button. Copy the Admin API access token
You can easily run tap-shopify by itself or in a pipeline using Meltano.
tap-shopify --version
tap-shopify --help
tap-shopify --config CONFIG --discover > ./catalog.jsonpipx install poetry
poetry installCreate tests within the tap_shopify/tests subfolder and
then run:
poetry run pytestYou can also test the tap-shopify CLI interface directly using poetry run:
poetry run tap-shopify --helpTesting 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 installNow 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-jsonlOur team would be happy to help www.matatika.com
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.
Copyright © 2022 Matatika