{"section":"tutorials","requestedLocale":"pt","requestedSlug":"como-instalar-e-configurar-a-app-vtex-tracking-no-seu-admin-vtex","locale":"pt","slug":"como-instalar-e-configurar-a-app-vtex-tracking-no-seu-admin-vtex","path":"docs/pt/tutorials/vtex-tracking/vtex-tracking---todos-os-artigos/como-instalar-e-configurar-a-app-vtex-tracking-no-seu-admin-vtex.md","branch":"main","content":"VTEX Tracking é uma solução da VTEX voltada ao monitoramento de entregas. A app traz informações em tempo real sobre o status das entregas, otimizando os custos logísticos para empresas e transportadoras, além de aumentar a satisfação do cliente. \n\nEste artigo explica todos os passos para instalar e configurar a integração entre uma loja VTEX e a app VTEX Tracking. Os passos abaixo são realizados após o contrato de utilização dos serviços VTEX Tracking ser assinado, e a plataforma web habilitada.\n\nPara clientes VTEX Tracking que não possuem ambiente VTEX, a integração entre sua loja e a app é feita através de nossas rotas de API. Saiba mais sobre [como funciona o VTEX Tracking](/pt/docs/tutorials/visao-geral-vtex-tracking), e confira a [documentação de API](https://developers.vtex.com/docs/api-reference/tracking).\n\n## Como instalar a app\n\nPara instalar a app, siga os passos abaixo:\n\n1. No Admin VTEX, acesse **Aplicativos > Loja de aplicativos**, ou digite **Loja de aplicativos** na barra de busca no topo da página.\n2. Selecione a app [VTEX Tracking](https://apps.vtex.com/vtex-vtex-tracking-integrator/p). Você também pode fazer isso pela [VTEX App Store](https://apps.vtex.com/).   \n3. Clique em **Obter App**.  \n4. Digite o **nome da conta VTEX** onde os pedidos integrados serão faturados.    \n*A conta deve ser a mesma que foi configurada no License Manager e no Checkout.*  \n4. Aceite os **termos de uso e instalação**.  \n\nFeito isso, sua plataforma VTEX terá a nova aba VTEX Tracking liberada no menu lateral, encontrada na seção de Pedidos.\n\n## Configurações da app\n\nA integração entre sua loja no Admin da VTEX, e a app VTEX Tracking depende de algumas configurações. Confira abaixo as configurações necessárias para que seu serviço VTEX Tracking seja ativado, e o passo a passo para acessar o menu de Configurações. \n\n![VTEX Tracking app install](https://cdn.statically.io/gh/vtexdocs/help-center-content/refs/heads/main/docs/pt/tutorials/vtex-tracking/vtex-tracking---todos-os-artigos/como-instalar-e-configurar-a-app-vtex-tracking-no-seu-admin-vtex_1.jpg) \n\n1. No Admin VTEX, acesse **Aplicativos > Apps instalados > VTEX Tracking**, ou digite **VTEX Tracking** na barra de busca no topo da página.\n2. Digite o **Token da API** na caixa de texto.  \n3. Se desejar, habilite a **Integração de pedidos com XML da Nota Fiscal**.    \n4. Se desejar, habilite a **Atualização do status de entrega nos pedidos**.  \n5. Clique em **Salvar**.   \n\nUma vez salvas as configurações, o token será validado, e a integração entre loja VTEX e VTEX Tracking estará ativa. Confira a seguir mais informações sobre as configurações citadas acima.\n\n### Token da API\n\nO token é o código de segurança que permite que o ambiente da loja VTEX se comunique com o ambiente do VTEX Tracking para gestão das entregas. É disponibilizado para os clientes da plataforma, pelo time VTEX Tracking, uma vez fechado o contrato.\n\nSe precisar, solicite o Token pelo [suporte VTEX](https://support.vtex.com/hc/pt-br/requests).\n\n### Integração de pedidos com XML da nota fiscal\n\nEssa opção configura como é feita a integração de pedidos de uma loja para que se tornem entregas de fato, no sistema VTEX Tracking. Habilitando essa opção, o lojista determina que o VTEX Tracking converta pacotes faturados em entregas, apenas quando o faturamento incluir o arquivo XML da Nota Fiscal, no módulo de Gerenciamento de Pedidos da VTEX.\n\nEssa configuração faz com que os dados de entrega que serão utilizados venham diretamente da Nota Fiscal, e que a integração desconsidere determinadas transportadoras que, por ventura, não farão a operação de entrega via VTEX Tracking. \n\nAssim o VTEX Tracking pode diferenciar pedidos por:\n- CNPJ do emissor\n    Essa informação indica para o VTEX Tracking o seller de onde sairá o pedido, caso hajam diversas filiais, por exemplo.\n\n- CNPJ da transportadora\n    Com este dado, o VTEX Tracking saberá qual das transportadoras disponíveis está sendo usada naquele pedido específico. Um cenário comum para isso é quando existem múltiplas opções de entrega, como por exemplo Motoboy, Transportadora ABC e Correios, mas o lojista quer integrar apenas o que for Motoboy.\n\nSe os casos descritos acima são relevantes para a sua operação, recomendamos que habilite esta opção e implemente o envio de notas fiscais na sua integração.\n\n#### Enviando a nota fiscal\n\nPara enviar uma nota fiscal na sua integração, você deve disponibilizá-la em um arquivo XML com um link público e enviar a URL no campo `invoiceUrl` da  [requisição de notificação de fatura](https://developers.vtex.com/vtex-rest-api/reference/invoice#invoicenotification) da API de gerenciamento de pedidos.\n\nPara obter um link público, você pode hospedar o arquivo XML em um serviço de nuvem. O caráter público indica apenas a configuração de privacidade do arquivo. Isso não significa que qualquer pessoa terá acesso, apenas quem tiver a URL completa. Confira o  exemplo de [nota fiscal XML](https://www.vtextracking.com/support-files/exemplo-arquivo-nfe.xml) com a URL `https://www.vtextracking.com/support-files/exemplo-arquivo-nfe.xml`.\n\nA URL enviada deve conter a extensão `.xml`, garantindo que o formato está correto. A ausência dessa extensão sinaliza que o endereço é referente a um arquivo de outro tipo (como PDF ou HTML), mesmo que tenha o texto do XML incorporado, e a integração não funcionará. \n\nApós realizar o envio, você pode conferir se teve sucesso seguindo esses passos:\n\n1. No Admin VTEX, acesse **Pedidos > Todos os pedidos**, ou digite **Todos os pedidos** na barra de busca no topo da página.\n2. Clique no pedido (faturado e com nota fiscal adicionada).\n3. Em **Fatura**, confira se o número da nota fiscal está em azul e é um link e clicável.\n4. Clique no link com o botão direito do mouse, e abra a nota fiscal em uma outra aba.\n\nSe a nota fiscal estiver correta, o envio ocorreu como esperado.\n\n> ⚠️ Observe o padrão de notas fiscais em XML estabelecido pela Secretaria de Estado da Fazenda (Sefaz) pertinente à sua operação.\n\n### Atualização do status de entrega nos pedidos\n\nPor padrão, os pedidos integrados como entregas no VTEX Tracking não são atualizados com as informações de rastreamento e status. Isso acontece porque muitas vezes o lojista já faz uso desses campos no módulo de Gerenciamento de Pedidos de outra forma. \n\nAo ativar essa opção, o VTEX Tracking passará a enviar uma atualização para o módulo de Gerenciamento de Pedidos da VTEX quando uma entrega/serviço passar para `Roteirizado`, `Em Andamento`, `Realizado` ou `Não Realizado`. Essas atualizações também incluirão a URL de rastreamento, nos detalhes do pedido. \n\n### Acessar admin VTEX Tracking\n\nUma vez feitas as configurações necessárias, o botão `Acessar` ficará ativo para que o lojista possa acessar a [plataforma web](/pt/docs/tutorials/visao-geral-vtex-tracking), ou Admin, do VTEX Tracking. Atualmente este é um ambiente separado, acessível por meio das mesmas credenciais usadas para login na sua loja VTEX."}