Atualização de Tracking na VTEX via API Externa – Nordware

Como configurar e acompanhar a atualização de rastreio na VTEX

Este artigo orienta sobre a configuração necessária para garantir que os pedidos na VTEX sejam atualizados automaticamente com as informações de rastreio, utilizando a API Externa como fonte de dados. Essa configuração assegura que os eventos de envio e entrega sejam comunicados corretamente.

Sobre a API Externa

Nos casos em que a API Externa é utilizada como fonte de rastreio, o cliente deve garantir a alimentação correta dos dados por meio de integração com essa API.

Essas informações ficam armazenadas na base da API e são utilizadas para:

Envio aos e-commerces (como a VTEX).
Atualização do status dos pedidos no Bahn.

Outras fontes de rastreio (informativo)

Este artigo trata exclusivamente da configuração utilizando a API Externa. No entanto, o Bahn possui suporte a outras fontes, utilizadas em contextos diferentes:

Sigur: utilizado em projetos integrados com o Sigur. O Bahn consulta a API do Sigur para obter os dados de rastreio.
Tabelas de Usuário no SAP: utilizado em projetos onde a fonte de consulta são utilizadas tabelas de usuário no SAP como U_NW_BAHNTRACKING ou U_BCE_TRCK.
XSOData: consulta o pedido via integração XS, onde é previamente cadastrada no cliente.

ℹ️ Essas fontes não são utilizadas neste cenário com API Externa.

Configurações iniciais necessárias no Bahn

Para que a atualização do código de rastreio ocorra corretamente, é necessário garantir as seguintes configurações:

Status “Faturado”, “Expedido” e/ou “Entregue” devidamente configurados
Verifique se os status configurados no Bahn estão de acordo com o fluxo desejado:
- Faturado: envia os dados da nota fiscal para a VTEX. Obrigatório.
- Expedido: envia os dados de rastreio para a VTEX.
- Entregue: (opcional) envia dados de entrega, caso configurado.
ℹ️ Importante: o status “Completo” é interno no Bahn e não envia informações para a VTEX.
Fonte de consulta do Rastreio (Tracking) configurada como "API Externa"
Essa configuração define de onde o Bahn buscará o código de rastreio a ser enviado para a VTEX.
Ativar a Sincronização de Status
Acesse o menu Agendamentos e ative a opção Sincronizar Status. Isso permite que o Bahn execute automaticamente as rotinas de atualização.

Como funciona o fluxo de captação do Tracking

Para pedidos com status Faturado, o Bahn realiza tentativas de captação do código de rastreio com base na fonte configurada (API Externa) sempre que há atualização de status.

A mudança de status de Faturado para Expedido só acontece quando o rastreio é captado com sucesso.

Enquanto a informação de rastreio não estiver disponível, o pedido permanece com o status Faturado.

Quando o código de rastreio é captado, o Bahn:

Envia os dados para a VTEX:
- URL de rastreio
- Código de rastreio
- Data de envio
- Número da nota fiscal
Exibe as informações na tela de detalhes do pedido no Bahn.

Resumo do fluxo de integração Bahn x VTEX

Entrada de dados no Bahn:
- Via API Externa:
  - Dados fiscais: número da nota, chave de acesso, XML
  - Dados de envio/despacho: código e URL de rastreio, data de envio
  - Dados de entrega: data da entrega
- Via SAP (Add-on Fiscal):
  - Número da nota fiscal
  - Valor da nota
  - Chave de acesso
Envio de informações para a VTEX:
- Atualização de Status na VTEX:
  - Dados fiscais enviados:
    - Número da nota fiscal (via SAP)
    - Chave de acesso (via SAP)
    - XML da nota fiscal (via API Externa)
  - Dados de envio/despacho enviados:
    - Código de rastreio (via API Externa)
    - URL de rastreio (via API Externa)
    - Data de envio (via API Externa)
    - Nome do transportador
- Registro de eventos na VTEX:
  - Evento de envio/despacho:
    - Data de envio
    - Número da nota fiscal
    - Cidade e estado de destino
  - Evento de entrega realizada:
    - Data da entrega
    - Número da nota fiscal
    - Cidade e estado da entrega
    - Confirmação de entrega finalizada (flag)

Conclusão

Após realizar essas configurações e compreender o fluxo de integração, será possível garantir que os pedidos enviados pela VTEX contenham as informações de rastreio de forma automática e correta.

Dica: mantenha a API Externa atualizada e monitorada para evitar falhas na captação do código de rastreio.