> For the complete documentation index, see [llms.txt](https://ajuda.consistem.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ajuda.consistem.com.br/consistem-integracoes/areas-de-negocio/comercial/vtex.md).

# VTEX

### Visão geral

Esta integração tem como objetivo principal a automação do fluxo de importação de pedidos, controle de estoque e envio de dados de faturamento (emissão de nota fiscal) entre o Consistem ERP e a plataforma de e-commerce VTEX. O cenário arquitetural utiliza o sistema Bling como um *hub* (meio de campo) para centralizar a recepção dos pedidos vindos do e-commerce, enquanto o Consistem ERP executa uma comunicação híbrida: recebe os pedidos via Bling e realiza chamadas diretas de retorno para a API da VTEX para atualizar os status logísticos e fiscais.

{% hint style="info" %}
**Nova Abrangência do Negócio**

A integração do Consistem ERP com a VTEX foi adaptada para abranger também o segmento de PPCP Industrial. Esse processo expande o atendimento da ferramenta, que anteriormente contemplava apenas os clientes do segmento de Confecção.
{% endhint %}

<table><thead><tr><th width="462">Consistem ERP</th><th>VTEX</th></tr></thead><tbody><tr><td><p><strong>Compatibilidade:</strong> 7.5 ou superiores do Consistem ERP.<br><strong>Módulos:</strong> Comercial e PPCP (Confecção ou Industrial, dependendo do segmento da empresa)<br><strong>Licença:</strong> <a href="https://movidesk.consistem.com.br/form/5801/">Aquisição de licença</a> <strong>VTEX</strong> ativa junto à Consistem.</p><p><br>Orientamos o acompanhamento da nossa equipe de consultores.</p></td><td>Aquisição de licença e implantação deve ser verificada com a empresa fornecedora.<br><a href="https://vtex.com/">Saiba mais</a></td></tr><tr><td></td><td><strong>Credenciais de API:</strong> Geração de chaves de autenticação de segurança (<code>AppKey</code> e <code>AppToken</code>) no painel administrativo da VTEX.</td></tr><tr><td></td><td><strong>Intermediador (Hub):</strong> Conta ativa e configurada no Bling, atuando como o canal de entrada dos pedidos.</td></tr></tbody></table>

### Configuração da integração

#### No Consistem ERP:

1. **Parametrização Base:** Acesse o programa [Integração (CSINTEGRACAO010)](/componentes/manuais-de-telas/cadastros-gerais-de-componentes/integracao.md) para realizar a amarração das lojas e canais de venda.
2. **Cadastro da Integração:** Localize a *Integração API VTEX* e clique em **Editar** para executar o [Cadastro de Integração (CSINTEGRACAO010A)](/componentes/manuais-de-telas/cadastros-gerais-de-componentes/cadastro-de-integracao.md).<br>

   <figure><img src="/files/uMCI5TVvjnlMCc3bhFDB" alt=""><figcaption></figcaption></figure>
3. **Credenciais e Adequação para a API v3 do Bling (Obrigatório):** Defina os parâmetros de *endpoint* e as credenciais necessárias para a comunicação via API. Configure os campos de autenticação OAuth 2.0 (`Client ID` e `Secret ID`), gerando os *Access/Refresh Tokens*, e realize o mapeamento manual "de/para" das Naturezas de Operação entre os códigos internos do Consistem e os códigos criados no Bling.
4. **Ativação:** No campo **Situação**, selecione a opção *Ativo*.<br>

   <figure><img src="/files/fnezWNIwngaEh19F1oQh" alt=""><figcaption></figcaption></figure>
5. **Configuração de Múltiplas Lojas e Regras de Negócio:** Através do botão **Específico**, execute o programa [Cadastro de Lojas VTEX (CCPVH080)](/componentes/manuais-de-telas/cadastros-gerais-de-componentes/cadastro-de-lojas-vtex.md) para inserir o ID do canal de venda (gerado no Bling para a VTEX) dentro dos parâmetros do Consistem. Isso permite separar e direcionar corretamente os pedidos da VTEX de outros marketplaces.<br>

   <figure><img src="/files/rIT8HGkFq6oleWKVulQO" alt=""><figcaption></figcaption></figure>
6. **Amarração de Parâmetros:** Informe o "código da loja" no campo de descrição de integração no Consistem e vincule o ID da loja cadastrado às respectivas tabelas de preço, naturezas de operação (CFOP) e representantes comerciais padrão para o e-commerce.

#### Na VTEX / Bling:

1. No painel da VTEX, gere o `AppKey` e `AppToken` para liberar o acesso direto do ERP.
2. No Bling, configure a integração com a VTEX e certifique-se de obter o ID do canal de venda (ID da loja) que será informado no Consistem ERP.
3. Configure as naturezas de operação no painel do Bling para que correspondam ao mapeamento que será feito dentro do ERP.

### Como a integração funciona

A comunicação funciona através de um modelo de APIs (REST/JSON) que seguem o padrão estrutural (leiaute) da Consistem:

* **Comunicação de Entrada (Via Bling):** O Consistem consome a API do Bling para ler e importar os pedidos que foram realizados na VTEX.
* **Comunicação de Saída Direta (Consistem → VTEX):** O Consistem utiliza os *endpoints* diretos da API da VTEX (autenticados via `AppKey` e `AppToken`) para realizar o bypass no Bling em etapas críticas onde o *hub* possui limitações de atualização.

#### O que o Consistem Recebe?

* **Dados do Pedido:** Importa do Bling as informações consolidadas do pedido (itens, valores, frete, descontos). Os dados cadastrais do cliente vêm embutidos no arquivo do pedido e são gravados automaticamente no banco de dados do Consistem no momento da importação.

#### O que o Consistem Envia?

* **Para o Bling:** Cadastro base de produtos, amarração de produtos pai/filho (grades), tabelas de preço vigentes e as atualizações de saldo de estoque.
* **Direto para a VTEX:** Comandos de alteração de status de logística (*Em Manuseio*) e o envio de dados de faturamento juntamente com o arquivo XML da nota.

### Fluxo do processo

O fluxo de trabalho segue o leiaute padrão da Consistem e é dividido nas seguintes etapas sequenciais:

1. **Geração do Pedido:** O cliente final conclui a compra na plataforma VTEX. O pedido é enviado automaticamente da VTEX para o Bling.
2. **Reserva de Estoque (Aguardando Pagamento):** Se o pedido entrar na VTEX com pagamento pendente (status *Em andamento*), o Consistem ERP realiza a leitura do leiaute de pedidos e o importa com a situação *Bloqueado*. Isso garante a reserva imediata do estoque físico.
3. **Liberação do Pedido:** Assim que o pagamento é autorizado na VTEX, o status muda no Bling. O Consistem monitora a alteração e atualiza internamente a situação do pedido para *Liberado/Sugerido*, disponibilizando-o para faturamento.
4. **Início de Manuseio (Via Direta):** Assim que o pedido atinge a situação *Liberado* no Consistem, o ERP dispara uma requisição direta para a API da VTEX, alterando o status do pedido na plataforma para *Início de Manuseio*.
5. **Faturamento e Envio Fiscal (Via Direta):** Após a emissão e autorização da Nota Fiscal Eletrônica no Consistem ERP, o sistema envia a atualização para o Bling e, simultaneamente, transmite os dados de faturamento e o XML da nota diretamente para a VTEX. Esse gatilho encerra o fluxo na VTEX e dispara os e-mails de acompanhamento ao cliente final.
6. **Movimentação de PPCP (Segmento Industrial / Confecção):** A confirmação e liberação do pedido geram as demandas correspondentes no módulo de PPCP Industrial ou Confecção para controle de empenhos, geração de ordens de produção ou baixas de estoque manufaturado.

### Como consultar e monitorar a integração

Para apoiar as equipes de suporte e implantação no monitoramento da importação de pedidos e emissão de notas fiscais, o diagnóstico de falhas é realizado através de três telas específicas no Consistem ERP:

* **Logs de Erro e Requisições:** Tela de monitoramento [Consulta Logs de Integração (CSINTEGRACAO100)](/componentes/manuais-de-telas/consulta-de-componentes/consulta-logs-de-integracao.md) onde ficam gravados os históricos de erros e o corpo (payload) completo das requisições (XML/JSON) de todos os *endpoints*. Caso um produto ou pedido não integre, o motivo exato retornado pela API estará nesta tela.
* **Monitoramento de Produtos:** Na [Importação e Manutenção do Código de Automação do Produto (CCCGI910)](/entradas/manuais-de-telas/entradas-estoques/itens/importacao-e-manutencao-do-codigo-de-automacao-do-produto.md) é permitido avaliar visualmente o relacionamento de códigos ("de/para") entre as referências de produtos do Consistem e do Bling. Utilizada para auditar divergências de saldos de estoque ou identificar vínculos quebrados.
* [**Monitor de Pedidos de Integração (CCPV990)**](/comercial/manuais-de-telas/comercial-carteira-de-pedidos/pedidos/monitor-de-pedidos-de-integracao.md)**:** Painel que compara de forma analítica a situação do pedido dentro do Bling versus a situação real interna no Consistem. Permite que o operador execute ações manuais de contingência, tais como: forçar a importação de um pedido travado, registrar cancelamentos ou reenviar atualizações de status pendentes.

<p align="center">Esse conteúdo foi útil?</p>

<p align="center"><a href="https://movidesk.consistem.com.br/form/10395/" class="button primary" data-icon="thumbs-up">Sim</a> <a href="https://movidesk.consistem.com.br/form/10395/" class="button primary" data-icon="thumbs-down">Não</a></p>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://ajuda.consistem.com.br/consistem-integracoes/areas-de-negocio/comercial/vtex.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
