v1

latestOpenAPI 3.0.3Proprietary2026-07-26125148541.3 KB

NFe

Registrar Insucesso na Entrega

Registra um evento de insucesso na entrega da NFe.

O objetivo do evento é permitir ao remetente registrar, por meio de um evento fiscal, na respectiva nota fiscal eletrônica que acoberta a entrega da mercadoria os motivos que impediram a entrega.

Este método é síncrono.

post/nfe/{referencia}/insucesso_entrega

Path parameters

referenciastring required

Example:12345

Referência da NFe

Request body

data_tentativa_entregastring date-time required

Data e hora da tentativa de entrega (formato ISO)

numero_tentativasinteger

Número da tentativa de entrega

motivo_insucesso1 | 2 | 3 | 4 required

Motivo do insucesso:

1: Recebedor não encontrado
2: Recusa do recebedor
3: Endereço inexistente
4: Outros (exige justificativa)

justificativa_insucessostring

Justificativa do motivo do insucesso (obrigatório para motivo_insucesso=4)

latitude_entregastring

Latitude do ponto de entrega

longitude_entregastring

Longitude do ponto de entrega

hash_tentativa_entregastring required

Hash SHA-1 no formato Base64 da concatenação da chave da NFe + Base64 da imagem

data_hash_tentativastring date-time

Data e hora da geração do hash

Example request

{
  "data_tentativa_entrega": "2024-07-24T10:30:56-03:00",
  "numero_tentativas": 4,
  "motivo_insucesso": 4,
  "justificativa_insucesso": "Não foi possível realizar a entrega por erro no cadastro do endereço.",
  "latitude_entrega": "-25.428400",
  "longitude_entrega": "-49.273300",
  "hash_tentativa_entrega": "yzmPGyT1YM5KqilP56w+oPlVkx8="
}

Response

Insucesso na entrega registrado

status'autorizado' | 'erro_autorizacao'

Status do evento

status_sefazstring

Status na SEFAZ

mensagem_sefazstring

Mensagem descritiva da SEFAZ

caminho_xml_insucesso_entregastring

Caminho para download do XML

numero_insucesso_entregainteger

Número sequencial do evento

Example response

{
  "status": "autorizado",
  "status_sefaz": "135",
  "mensagem_sefaz": "Evento registrado e vinculado a NF-e",
  "caminho_xml_insucesso_entrega": "/arquivos/123456789/202406/XMLs/4124061234567800012355003000000743180111111-ie.xml",
  "numero_insucesso_entrega": 1
}