NF-e em Formato Texto nos Endpoints de Rastreamento

Anteriormente, a API de rastreamento disponibilizava a NF-e exclusivamente por meio de URLs de acesso (urlRastreamento e urlNFE). 

Plataformas integradoras e conectores de marketplace, como a Anymarket, não possuem capacidade para consumir a nota fiscal nesse formato, o que obrigava a ser realizada tratativas manuais no ERP, como envio do XML por e-mail ou consultas através de APIs secundárias para transmitir os dados fiscais necessários.

Como funciona a nova Feature?

Os endpoints do módulo de rastreamento passam a suportar a recepção e o retorno do novo atributo XmlNfe, contendo o código estruturado da nota fiscal em formato texto.

O comportamento do fluxo foi parametrizado sob os seguintes critérios:

• Regra de Envio (POST/PUT/PATCH): Ao enviar o payload contendo o campo XmlNfe, o preenchimento da chave de acesso (chaveAcessoNFE) torna-se obrigatoriamente requerido para validação do registro.
• Regra de Consulta (GET): O conteúdo da NF-e em formato texto será retornado nas chamadas de consulta mediante a solicitação explícita do parâmetro de busca camposAdicionais=XmlNfe.
• Garantia de Retrocompatibilidade: Os campos legados urlRastreamento e urlNFE permanecem operando normalmente, garantindo que as integrações ativas continuem funcionando sem nenhum tipo de interrupção.
• Tratamento de Exceções (Robustez): Pedidos que ainda não possuam nota fiscal emitida retornarão o campo XmlNfe como nulo/vazio, evitando quebras ou falhas no consumo dos dados pelos ecossistemas parceiros.

Endpoints Abrangidos pela Atualização

• POST / PUT / PATCH /v1/pedidos/{pedidoId}/rastreamento/status
• POST / PUT / PATCH /v1/pedidos/{pedidoId}/rastreamento/produtos/{produtoVarianteId}
• GET /v1/pedidos/{pedidoId}/status
• GET /v1/pedidos/{pedidoId}/rastreamento
• GET /v1/pedidos/{pedidoId}/rastreamento/produtos
• GET /v1/pedidos/{pedidoId}/rastreamento/produtos/{produtoVarianteId}/{pedidoRastreamentoProdutoId}

Principais Benefícios para a Operação

• Automação Operacional de Ponta a Ponta: Elimina a necessidade de intervenções manuais ou customizações complexas no ERP para o envio do XML fiscal para a Anymarket e outros conectores.
• Preservação de Integrações Existentes: A total retrocompatibilidade garante zero impacto sobre os sistemas e parceiros que já consomem a API de rastreamento no modelo tradicional.
• Resiliência e Estabilidade: A inclusão de tratamento defensivo para pedidos sem NF-e garante a continuidade do fluxo de dados sem gerar falhas nas requisições.

Ainda sobrou alguma dúvida ou quer entender todos os detalhes de configuração e começar a aplicar agora mesmo? Confira o passo a passo completo na nossa documentação oficial:

🔗Changelog de NF-e em Formato Texto