Back to source list
Official
Premium
Shopify
The CloudQuery Shopify plugin pulls data from Shopify and loads it into any supported CloudQuery destination
Loading plugin documentation
The CloudQuery Shopify plugin pulls data from Shopify and loads it into any supported CloudQuery destination
Loading plugin documentation
We use tracking cookies to understand how you use the product and help us improve it. Please accept cookies to help us improve. You can always opt out later via the link in the footer.
cloudquery needs to be authenticated. Either an API key and password (in the case of basic custom/private apps) or an access token (for OAuth apps) is required for authentication.api_key and api_secret.access_token and remove api_key and api_secret sections. For more information, refer to Shopify.dev on the subject.backend_options must be set in the spec (as shown below). This is documented in the Managing Incremental Tables section.cq_state_shopify table by default.kind: source
# Common source-plugin configuration
spec:
name: shopify
path: cloudquery/shopify
registry: cloudquery
version: "v8.5.1"
tables: ["*"]
destinations: ["postgresql"]
backend_options:
table_name: "cq_state_shopify"
connection: "@@plugins.postgresql.connection"
# Shopify specific configuration
# Learn more about the configuration options at https://cql.ink/shopify_source
spec:
# required, or alternatively use access_token
api_key: "${SHOPIFY_API_KEY}"
# required, or alternatively use access_token
api_secret: "${SHOPIFY_API_SECRET}"
# required, e.g. https://mystore.myshopify.com
shop_url: "${SHOPIFY_SHOP_URL}"
api_key (string) (required if access_token isn't used)api_secret (string) (required if access_token isn't used)access_token (string) (required if api_key & api_secret aren't used)shop_url (string) (required)https://mystore.myshopify.com.api_version (string) (optional) (default: 2023-10)timeout_secs (integer) (optional) (default: 10)max_retries (integer) (optional) (default: 30)page_size (integer) (optional) (default: 50)max_pages (integer) (optional)concurrency (integer) (optional) (default: 1000)scheduler (string) (optional) (default: dfs)
The scheduler to use when determining the priority of resources to sync.
Supported values are dfs (depth-first search), round-robin, shuffle and shuffle-queue.SELECT * FROM shopify_products WHERE status='active' AND 'your-tag' = ANY(tags);