Skip to content

Shopify Admin Input

Orders, products, and store metadata from the Shopify Admin GraphQL API.

Configuration

yaml
data_sources:
  shopify:
    ShopifyAdmin:
      shop_domain: my-store.myshopify.com
      start_date: "2024-01-01"
      stream_profile: full
      lookback_days: 7
      oauth_access_token: ${SHOPIFY_ACCESS_TOKEN}
FieldDefaultDescription
shop_domain(required)Shop hostname (with or without https://)
start_date(required)First order sync date (YYYY-MM-DD)
lookback_days7Order window lookback
stream_profilefullminimal, standard, or full
streamsprofile setExplicit namespace list
api_versionAdmin API version override
min_query_interval_ms500Minimum delay between GraphQL calls
max_queries_per_run200GraphQL query budget per sync
use_bulk_operationsfalseUse bulk operation API for large backfills
oauth_client_idCustom app client ID
oauth_client_secretCustom app client secret
oauth_access_tokenAdmin API access token

Pipeline wiring

yaml
pipelines:
  commerce:
    data_source: data_sources.shopify
    data_sink: data_sinks.landing

Authentication

Use a custom app Admin API access token (SHOPIFY_ACCESS_TOKEN). Optional oauth_client_id / oauth_client_secret apply when you mint tokens yourself. The token needs read access to orders and products for the selected streams.

This site is source-available under PolyForm Shield 1.0.0