Ir para o conteúdo

Ocorrências por Período

POST https://freterapido.com/api/external/embarcador/v1/quotes/occurrences/interval?token=[seu_token]

Permite consultar as ocorrências de um frete dentro de um período especificado.

As ocorrências são apresentadas por ordem de data em um determinado intervalo, juntamente com o status.

O intervalo entre o período de início e fim deve ser de no máximo 4 horas.

Limite de 500 fretes por requisição.

Basta informar o token de integração e o intervalo desejado de início e fim.

Envio:

Parâmetros da URL:

Nome Descrição Formato / Exemplo Obrigatório
token Token de integração String de 32 caracteres *
* Obrigatório

Parâmetros do corpo da requisição:

Nome Descrição Formato / Exemplo Obrigatório
data_inicio Data de início da ocorrência Datetime (YYYY-MM-DD hh:mm) *
data_fim Data final da ocorrência Datetime (YYYY-MM-DD hh:mm) *
codigo_volume Código de rastreio do volume, nesse caso retornarão apenas os dados do volume especificado String Opcional
* Obrigatório

Exemplo de envio:

    {
      "data_inicio": "",
      "data_fim": "",
      "codigo_volume": ""
    }

Resposta:

  • Se a requisição obtiver sucesso, será retornado o código de resposta HTTP 200 com um array de objetos com a chave sendo o ID Frete Rápido e a lista de ocorrências do período especificado.
Nome
 Descrição Formato / Exemplo Retornado
id_frete Identificador do frete contratado na Frete Rápido Array Sempre
 codigo Código da ocorrência Numérico (inteiro) Sempre
 status Status da ocorrência String Sempre
 data_ocorrencia Data da ocorrência Datetime (YYYY-MM-DD hh:mm:ss) Sempre
 data_atualizacao Data de atualização da ocorrência Datetime (YYYY-MM-DD hh:mm:ss) Sempre
 data_reentrega Data em caso de nova tentativa de entrega Date (YYYY-MM-DD) Em caso de reentrega
 data_prevista_entrega Data prevista de entrega calculado no ato da cotação, com base nos dias úteis para entrega. Sendo apenas uma referência, podendo ser diferente a depender das operações de cada transportadora. Date (YYYY-MM-DD) Eventual
 prazo_devolucao Quantidade de dias úteis para devolução da carga/mercadoria String Em caso de devolução
 mensagem Mensagem livre para informação pela transportadora String até 255 caracteres Eventual
 codigo_volume Código de rastreio do volume String Eventual

Exemplo de resposta:

[
    {
        "FR11111111111": [
            {
                "codigo": "1",
                "status": "",
                "data_ocorrencia": "",
                "data_atualizacao": "",
                "data_reentrega": "",
                "data_prevista_entrega": "",
                "prazo_devolucao": "",
                "mensagem": "",
                "codigo_volume": ""
            },
            {
                "codigo": "2",
                "status": "",
                "data_ocorrencia": "",
                "data_atualizacao": "",
                "data_reentrega": "",
                "data_prevista_entrega": "",
                "prazo_devolucao": "",
                "mensagem": "",
                "codigo_volume": ""
            }
        ],
        "FR22222222222": [
            {
                "codigo": "3",
                "status": "",
                "data_ocorrencia": "",
                "data_atualizacao": "",
                "data_reentrega": "",
                "data_prevista_entrega": "",
                "prazo_devolucao": "",
                "mensagem": "",
                "codigo_volume": ""
            }
        ]
    }
]

Erro:

Voltar ao topo