Skip to content

Automatic translation — the Portuguese version is the reference. View in Portuguese

Updated on 2026-10-04

Shopify — connector

Reads orders, products and customers from the Shopify Admin REST API (cursor pagination in the Link header) and loads into the Bronze layer.

On this page (15)

Read before: ../conectores.md (states map) and fichas.md (index of the datasheets).


What it is#

Reads orders, products and customers from the Shopify Admin REST API (cursor pagination in the Link header) and loads into the Bronze layer.

Supported ingestion modes:

  • We pull — We pull the data from your source.

Purpose#

Bring Shopify data into your datalake and make it available to the Bronze/Silver/Gold layers, BI models and the natural language question wizard.

When to use / when not to use#

Use when you need to consolidate this source into the datalake on a scheduled basis, isolated by workspace.

Remember that the first run with a real credential is followed by our team before the connector is fully released.

Plan and permissions#

  • Plan: core product (connectors are part of all plans; the limit is the number of sources in the plan).
  • Access: requires an active workspace — with overdue, suspended or cancelled subscription, runs are blocked.
  • Disablement: the ingestion run can be temporarily disabled (maintenance or incident). When this happens, the UI indicates the resource is unavailable at the moment.

Prerequisites#

  • A Shopify account with access to the data you want to ingest.
  • In the Shopify admin, go to Settings → Apps and sales channels → Develop apps, create a custom app with scopes read_orders (and read_all_orders for orders older than 60 days), read_products and read_customers, install it and copy the Admin API access token (shpat_…). The token is encrypted (AES-256-GCM) and never shown again.

Credentials#

Authentication method: Access token pasted by you. It is encrypted (AES-256-GCM) and never shown again, nor appears in logs or error messages.

Sensitive fields. They are encrypted (AES-256-GCM) and are never stored in the connection config, pipeline definition, export or DAG. By default the encrypted value is stored in the database; moving this connection's credential to the external credential vault is an explicit choice made per connection after saving — see ../../administracao/credenciais-e-rotacao.md.

  • Admin API access token (tokenAcesso) — Token of the custom app installed on the store.

Secrets are never re-displayed and are redacted in every error/log (raw token, URL-encoded and in JSON).

Form fields#

CampoRótuloTipoObrigatórioObservação
shopStore nametextyesThe prefix of minha-loja.myshopify.com (you can paste the full address).
apiVersionAPI versiontextnodefault: 2025-01; Quarterly Admin API version (e.g.: 2025-01). Only change if Shopify asks.
tokenAcesso 🔒Admin API access tokenpassword/secretyessecret (encrypted; external vault optional); Token of the custom app installed on the store.

Step-by-step#

  1. In the menu Dados → Conexões, use Nova conexão.
  2. Choose Shopify in the catalog.
  3. Fill the form fields (see the table above).
  4. Use Testar conexão. The result is shown broken down into Conectividade, Autenticação and Listagem/leitura — each with OK, Failed, Not applicable or Not tested. A capability with no test of its own for this connector shows as Not applicable, and Not applicable never counts as success.
  5. Use Salvar conexão. Saving DOES NOT start any ingestion.
  6. On the connection card, use Montar extração (or go to Orquestração → Pipelines and use Conectar fonte). The pipeline points to the saved connection — the credential is not copied.
  7. In the review, Publicar (agenda desligada) creates version 1 without running anything. After that, Ativar agenda and Executar agora are separate actions.

Example — connection test#

Example configuration (all values are fictitious; secrets are masked):

text
# Exemplo sintético (valores fictícios — não são credenciais reais)
shop = <shop>
apiVersion = v21.0
tokenAcesso = •••••• (cifrado — nunca exibido)

Expected result#

The Testar conexão returns the list of discovered tables/resources. After the first load, rows appear in the Bronze layer of your workspace, ready for the pipeline.

Limits and costs#

  • Pagination: hard cap per run (default 10,000 pages / 5,000,000 rows); anti-loop guard.
  • SaaS load: default batchSize 5,000, maxRows 200,000 per resource.
  • Estimated volume: ~0.5 GB/month (catalog estimate, not measurement).
  • Cost: the extraction itself is not charged by the platform; the Bronze load consumes datalake processing (billable).

Security#

  • Workspace scoped: each customer reads and writes only to their own datalake (<prefixo>_bronze / _silver / _gold); there is never leakage between workspaces.
  • Encrypted secrets: sensitive material is encrypted with AES-256-GCM before being persisted. The external credential vault is optional and enabled per connection; without it, the encrypted value stays in the database. Changing the value here DOES NOT revoke the credential at the source.
  • Redaction: every error/log goes through secret redaction (raw, URL-encoded and in JSON).
  • Production does not mock: a path that would fall into a mock triggers the production guard (explicit failure instead of simulating success).

Common errors#

  • Credential rejected (401/403) — the provider did not accept the credential: expired, revoked or lacking the necessary permission. Reconnect the source (the source and history are preserved; do not recreate the source).
  • Rate limit (429) — the provider requested a wait. The extraction respects Retry-After and retries; if it repeats, wait and reduce the schedule frequency.
  • Resource not found — check the resource identifier (account, object, report) and the granted permissions.
  • Stuck pagination cursor — the extraction terminates when the API cursor does not advance (anti-loop guard). If it happens in consecutive runs, open a support ticket indicating the connector and the resource.
  • Empty records path — the response arrived without records in the expected place. Check the selected resource and filters (period, account, status) before assuming there is no data.

Troubleshooting#

  • Use Testar conexão to isolate credential/network issues before scheduling.
  • Monitor runs in the connector observability (error rate, p50/p95, freshness).
  • A schema change at the source is signaled by schema drift (new column = info; removed column/type changed = attention).

Related#


Last review: 2026-10-04. Datasheet automatically generated from the product connectors catalog.

Related links