tap-shopify is a Singer tap for Shopify that uses the GraphQL API. This tap is currently in beta. The schema
definition is dynamic and retrieves all nested fields that are not connections to other objects. However, it
may require adjustments. Since we don’t have a real use case for the tap yet, we couldn’t determine the best
approach. We welcome contributions and feedback
Built with the Meltano Tap SDK for Singer Taps.
Install from GitHub:
pipx install git+https://github.com/sehnem/tap-shopify.git@mastercatalogstatediscoveraboutstream-mapsschema-flatteningbatch
| Setting | Required | Default | Description |
|---|---|---|---|
| auth_token | True | None | The token to authenticate against the API service |
| shop | True | None | The shopify shop name |
| api_version | False | 2023-04 | The version of the API to use |
| start_date | False | None | The earliest record date to sync |
| bulk | False | false | To use the bulk API or not |
| stream_maps | False | None | Config object for stream maps capability. For more information check out Stream Maps. |
| stream_map_config | False | None | User-defined config values to be used within map expressions. |
| flattening_enabled | False | None | 'True' to enable schema flattening and automatically expand nested properties. |
| flattening_max_depth | False | None | The max depth to flatten schemas. |
| batch_config | False | None |
A full list of supported settings and capabilities is available by running: tap-shopify --about
A full list of supported settings and capabilities for this tap is available by running:
tap-shopify --aboutThis Singer tap will automatically import any environment variables within the working directory's
.env if the --config=ENV is provided, such that config values will be considered if a matching
environment variable is set either in the terminal context or in the .env file.
To get the access token for your store use the folowing guide.
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.jsonFollow these instructions to contribute to this project.
pipx install poetry
poetry installCreate tests within the 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.
Next, install Meltano (if you haven't already) and any needed 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-jsonlSee the dev guide for more instructions on how to use the SDK to develop your own taps and targets.