Ir para o conteúdo

Webhook de Ocorrências

POST http://seusite.com/webhook/freterapido/v1/

Método que permite inserir uma lista de metadados em um determinado frete.

Assim, é possível criar uma URL esperando as notificações de um novo status, por meio de uma requisição com os parâmetros listados abaixo.

Envio:

Parâmetros enviados no corpo da requisição:

Nome Descrição Formato / Exemplo Informado
id_frete Identificador do frete contratado na Frete Rápido. Pode ser utilizado para rastrear o frete. String de 13 caracteres *
numero_pedido Número do Pedido String Eventual
numero_pedido_pai Número do Pedido Pai String Eventual
canal Nome do canal informado no frete String Eventual
codigo Código da ocorrência. Vide todas as ocorrências disponíveis na Frete Rápido. Numérico (inteiro) *
nome Nome da ocorrência String *
data_ocorrencia Data e hora da ocorrência pela transportadora informada à Frete Rápido Datetime (YYYY-MM-DD hh:mm:ss) *
data_atualizacao Data e hora da atualização da ocorrência pela transportadora Datetime (YYYY-MM-DD hh:mm:ss) *
data_reentrega Data de previsão de nova tentativa de entrega ao destinatário Date (YYYY-MM-DD) Em caso de reentrega
prazo_devolucao Prazo em dias úteis para devolução da carga String Numérica Em caso de devolução
mensagem Mensagem de texto livre da transportadora String de até 255 caracteres Eventual
notas_fiscais Array com os dados da nota fiscal Array em json Opcional
 numero Número da nota fiscal String Numérica Se Houver NF
 serie Série da nota fiscal String Numérica Se Houver NF
 chave_acesso Chave de acesso da nota fiscal String Numérica Se Houver NF
metadados Array com os metadados da cotação Array em json Opcional
 chave Chave do metadado String Se houverem metadados
 valor Valor do metadado String Se houverem metadados
transportadora Objeto com alguns dados da transportadora Objeto em json *
 cnpj CNPJ da transportadora String Numérica *
 razao_social Razão Social da transportadora String *

* Informado sempre

Exemplo de envio:

    {
    "id_frete": "",
    "numero_pedido": "",
    "numero_pedido_pai": "",
    "canal": "",
    "codigo": 0,
    "nome": "",
    "data_ocorrencia": "",
    "data_atualizacao": "",
    "data_reentrega": null,
    "prazo_devolucao": null,
    "mensagem": "",
    "notas_fiscais": [
        {
            "numero": "",
            "serie": "",
            "chave_acesso": ""
        }
    ],
    "metadados": [
        {
            "chave": "",
            "valor": ""
        }
    ],
    "transportadora": {
        "cnpj": "",
        "razao_social": ""
    }
}
Resposta:

  • Em caso de sucesso deverá ser retornado o código de resposta HTTP 200.
Voltar ao topo