Skip to content

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

Updated on 2026-10-04

WooCommerce — connector

Reads orders, products, and customers from the WooCommerce REST API v3 (Basic auth with REST key) and loads into the Bronze layer.

On this page (15)

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


What it is#

Reads orders, products, and customers from the WooCommerce REST API v3 (Basic auth with REST key) and loads into the Bronze layer.

Supported ingestion modes:

  • Nós buscamos — Nós buscamos os dados na sua fonte.

What it's for#

Bring WooCommerce 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 per 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 of the product (connectors are part of all plans; the limit is the number of sources in the plan).
  • Access: requires an active workspace — with the subscription overdue, suspended, or canceled, the run is blocked.
  • Shutdown: the ingestion run can be temporarily turned off (maintenance or incident). When this happens, the screen indicates that the feature is unavailable at the moment.

Prerequisites#

  • A WooCommerce account with access to the data you want to ingest.
  • In WordPress, go to WooCommerce → Settings → Advanced → REST API, add a key with Read permission and copy the consumer key (ck_…) and the consumer secret (cs_…). The store must be on HTTPS. The secret is encrypted (AES-256-GCM) and is never shown again.

Credentials#

Authentication method: Username and password (or key and secret) using Basic auth.

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.

  • Consumer secret (consumerSecret) — Secret of the REST key (Basic password).

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

Form fields#

CampoRótuloTipoObrigatórioObservação
urlLojaStore URLtextyesAddress of the WordPress/WooCommerce site (HTTPS).
consumerKeyConsumer keytextyesPublic identifier of the REST key (Basic user).
consumerSecret 🔒Consumer secretpassword/secretyessecret (encrypted; external vault optional); Secret of the REST key (Basic password).

Step-by-step#

  1. In the menu Dados → Conexões, use Nova conexão.
  2. Choose WooCommerce in the catalog.
  3. Fill in the form fields (see the table above).
  4. Use Testar conexão. The result is split by Network (server reach), Authentication (username and password) and Read (list tables) — each with OK, Failed, Not applicable or Not tested.
  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. Then, Ativar agenda and Executar agora are separate actions.

Example — connection test#

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

text
# Exemplo sintético (valores fictícios — não são credenciais reais)
urlLoja = <urlLoja>
consumerKey = <consumerKey>
consumerSecret = •••••• (cifrado — nunca exibido)

Expected result#

The Testar conexão returns the list of discovered tables/resources. After the first load, rows appear in your workspace's Bronze layer, 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.3 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 doesn't fake: 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 necessary 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 it repeats, 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 ends when the API cursor does not advance (anti-loop guard). If it happens in consecutive runs, open a support ticket specifying 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 = alert).

Related#


Last review: 2026-10-04. Entry automatically generated from the product's connector catalog.

Related links