Skip to content

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

Updated on 2026-10-04

VTEX — connector

Reads orders from the OMS and the public product catalog from the VTEX API and loads into the Bronze layer.

On this page (15)

Leia antes: ../conectores.md (mapa de estados) e fichas.md (índice das fichas).


What it is#

Reads orders from the OMS and the public product catalog from the VTEX API and loads into the Bronze layer.

Supported ingestion modes:

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

What it's for#

Bring VTEX 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, with isolation 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 a subscription overdue, suspended or cancelled, the run is blocked.
  • Shutdown: the ingestion run can be turned off temporarily (maintenance or incident). When this happens, the screen indicates the feature is unavailable at the moment.

Prerequisites#

  • A VTEX account with access to the data you want to ingest.
  • In VTEX Admin, go to Account settings → Application keys, create a key with the OMS - Full access (read orders) and Catalog (read products) access profiles and paste the AppKey and AppToken here. The AppToken is encrypted (AES-256-GCM) and never shown again.

Credentials#

Authentication method: API Key generated in the provider panel, sent in header/parameter.

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

  • AppToken (appToken) — Application key secret (X-VTEX-API-AppToken).

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

Form fields#

FieldLabelTypeRequiredNotes
accountNameAccount nametextyesThe VTEX account name — the prefix of https://minhaloja.vtexcommercestable.com.br.
environmentEnvironmenttextnodefault: vtexcommercestable; Almost always vtexcommercestable; change only if VTEX indicated a different environment.
appKeyAppKeytextyesPublic identifier of the application key (X-VTEX-API-AppKey).
appToken 🔒AppTokenpassword/secretyessecret (encrypted; external vault optional); Application key secret (X-VTEX-API-AppToken).

Step-by-step#

  1. In the menu Dados → Conexões, use Nova conexão.
  2. Choose VTEX in the catalog.
  3. Fill in the form fields (see 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 review, Publicar (agenda desligada) creates version 1 without running anything. Afterwards, Ativar agenda and Executar agora are separate actions.

Example — connection test#

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

text
# Exemplo sintético (valores fictícios — não são credenciais reais)
accountName = <accountName>
environment = vtexcommercestable
appKey = 1234567890123
appToken = •••••• (cifrado — nunca exibido)

Expected result#

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

Limits and costs#

  • Pagination: hard ceiling 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#

  • Scope by workspace: 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 written. The external credential vault is optional and enabled per connection; without it, the encrypted value is stored in the database. Changing the value here DOES NOT revoke the credential at the source.
  • Redaction: all errors/logs go through secret redaction (raw, URL-encoded and in JSON).
  • Production does not fake: a path that would fall into 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 missing required permission. Reconnect the source (the source and history are preserved; do not recreate the source).
  • Rate limit (429) — the provider asked to wait. The extraction respects Retry-After and retries; if repeated, wait and reduce the schedule frequency.
  • Resource not found — check the resource identifier (account, object, report) and the granted permissions.
  • Pagination cursor stuck — the extraction stops 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 record 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 problems 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. Card automatically generated from the product connectors catalog.

Related links