---
title: VTEX
slug: vtex
docTags: 
createdAt: 2025-07-02T18:56:55.842Z
---

# Objetivo

O conector VTEX na plataforma Fluid permite integrar sistemas externos ao ambiente VTEX, facilitando a comunicação e automação de processos como cadastro de produtos, atualização de estoque, emissão de pedidos, entre outros.

A integração é realizada por meio de requisições HTTP autenticadas, com dados trafegando em formato JSON. O conector é configurado com parâmetros de autenticação específicos para garantir segurança e controle.

:::hint{type="info"}
Recomendação: Para detalhes técnicos completos dos recursos, campos obrigatórios e exemplos de payloads, acesse a documentação oficial da [API VTEX](https://developers.vtex.com/docs/api-reference).
:::

## Como configurar a Conexão com a VTEX

### 1. Acessar o Painel Principal

- Faça login na plataforma Fluid.
- No menu lateral, vá em **Criar & Executar** > **Conexões**.

### 2. Iniciar Nova Conexão

- No canto superior direito da tela de Conexões, clique em **Nova Conexão**.

### 3. Seleção do Tipo de Conexão

- Selecione a opção **VTEX** na lista de conectores disponíveis.

### 4. Nome e Descrição da Conexão

- **Nome da Conexão:** Insira um nome descritivo, como “Conexão VTEX Loja X”.
- **Descrição:** Adicione uma breve explicação sobre o uso desta integração.

### 5. Parâmetros da Conexão

Preencha os seguintes campos:

::Image[]{src="https://api.archbee.com/api/optimize/G1NTw6yAi4RDUYbsU8csp/c2piZ6vwZUsyx8rNosuAu_image.png" size="70" width="808" height="762" position="center" showCaption="false"}

| Campo       | Descrição                                 | Exemplo                    |
| ----------- | ----------------------------------------- | -------------------------- |
| environment | Domínio da loja na VTEX                   | nomeloja.myvtex.com        |
| appKey      | Chave de autenticação fornecida pela VTEX | vtexappkey-nomeloja-ABCDEF |
| appToken    | Token de aplicação associado à appKey     | (campo sensível)           |

:::hint{type="info"}
Os valores `appKey `e `appToken `são utilizados nos headers das requisições para autenticação junto à API da VTEX.
:::

## Criando um Fluxo utilizando o Conector VTEX

**Passo 1: Criar um Fluxo**

- Crie um novo fluxo na plataforma e arraste o conector **VTEX** para o canvas.

### Passo 2: Parametrizações

- Selecione o conector e vá até a aba **Parametrizações**.
- Configure os campos com base no recurso e operação desejados.

### Passo 3: Escolher o Recurso

Os recursos disponíveis no conector VTEX são:

- Produtos
- SKUs de Produto
- Especificações de Produtos / SKU
- Estoques
- Clientes
- Pedidos
- Status de Pedidos
- Marcas
- Categorias

### Passo 4: Escolher a Operação

Cada recurso possui uma ou mais operações disponíveis. Exemplos:

### Produtos

- Criar um Produto
- Atualizar um Produto
- Consultar Produto por ID
- Consultar Produto por Reference ID

### SKUs

- Criar um SKU
- Atualizar um SKU
- Consultar SKU por RefID
- Consultar SKU por ID

### Especificações

- Enviar ou Deletar Imagem do SKU
- Enviar ou Deletar Especificação
- Associar/Remover Política Comercial
- Criar/Deletar EAN de SKU

### Estoques

- Atualizar Estoque por SKU e Warehouse
- Listar Estoque por Warehouse

### Clientes

- Criar ou Atualizar Cliente
- Buscar Cliente por CPF/CNPJ ou E-mail
- Criar ou Atualizar Endereço
- Buscar Endereço por UserID

### Pedidos

- Consultar Pedido por ID
- Listar Pedidos com filtros

### Status de Pedidos

- Alterar Status
- Enviar NF
- Atualizar Rastreamento

### Marcas

- Criar, Atualizar ou Buscar Marca

### Categorias

- Criar, Atualizar ou Buscar Categoria

### Exemplo de Configuração

**Recurso:** Produtos

**Operação:** Criar Produto

**Parâmetros:**

- body: Template com os dados do produto em formato JSON

## Observações Técnicas

- Todas as requisições são realizadas com cabeçalhos:&#x20;
  - X-VTEX-API-AppKey: chave da aplicação
  - X-VTEX-API-AppToken: token da aplicação
- A API da VTEX pode retornar mensagens de erro com códigos HTTP padrão (400, 404, 500, etc).
- Os payloads devem seguir o padrão de schemas definidos na documentação oficial da VTEX.

## Conclusão

Com o conector VTEX, a Fluid oferece uma forma simples e segura de integrar sistemas externos com o ecossistema VTEX. Através da configuração da conexão e do uso adequado dos recursos disponíveis, é possível automatizar o ciclo completo de operações de e-commerce com segurança e flexibilidade.
