Ir para o conteúdo

Webhook NF-e

POST http://transportadora.com/exemplo/webhook_nfe

Através desse Webhook a Transportadora receberá uma chamada todas as vezes que um Embarcador anexar ou excluir uma NF da plataforma.

Basta disponibilizar uma URL única para receber as requisições.

A cada ação realizada, o Webhook enviará o evento correspondente: Inclusão ou Exclusão.

This is a alt text.

Envio:

Parâmetros do corpo da requisição:

Nome Descrição Formato / Exemplo Informado
id_frete Identificador único de cada cotação/frete. Através deste identificador é possível relacionar todos os outros dados. String de 13 caracteres *
numero_pedido Número do pedido informado pelo Embarcador String Opcional
nfe Objeto com dados da Nota Fiscal inserida pelo Embarcador Objeto em json *
 chave_acesso Chave de acesso da NF String *
 serie Série da NF String *
 numero Número da NF String *
 quantidade_volumes Quantidade de Volumes da NF String Condicionalmente
 valor Valor da NF Numérico (float) *
 valor_total Valor total da NF Numérico (float) Condicionalmente
 valor_itens Valor total dos itens da NF Numérico (float) *
 data_emissao Data da emissão da NF Date ("YYYY-MM-DD hh:mm:ss") *
acao Ação do Embarcador Numérico (inteiro):
1 - inclusao
2 - exclusao
*

* Informados sempre

Exemplo de envio:

    {
      "id_frete": "",
      "numero_pedido": "",
      "nfe": {
        "chave_acesso": "",
        "serie": "",
        "numero": "",
        "quantidade_volumes":"",
        "valor": 0.00,
        "valor_total": 0.00,
        "valor_itens": 0.00,
        "data_emissao": ""
      },
      "acao": 1
    }

Resposta:

  • Se a requisição obtiver sucesso, deve ser retornado o código de resposta HTTP 200. Senão, pode ser retornado uma mensagem de erro para que possamos investigar.
Voltar ao topo