Rastreamento / Ocorrências do Frete
GET https://freterapido.com/api/external/embarcador/v1/quotes/[identificador]/occurrences?token=[seu_token]&codigo_volume=[codigo_volume]
Permite consultar todas as ocorrências de rastreio de um frete.
As ocorrências são apresentadas por ordem de acontecimento.
Caso escolha pelo número do pedido e haja dois fretes com o mesmo número do pedido, será retornado apenas do frete mais recente.
Através de um método, basta informar o identificador do frete ou o número do pedido e o token de integração, conforme estrutura abaixo.
Envio:
Parâmetros da URL:
Nome | Descrição | Formato / Exemplo | Obrigatório |
---|---|---|---|
identificador | Identificador do frete contratado na Frete Rápido (id_frete) ou número do pedido informado na contratação do frete (numero_pedido) | String | * |
token | Token de integração | String de 32 caracteres | * |
codigo_volume | Código de rastreio do volume, nesse caso retornarão apenas os dados do volume especificado | String | Opcional |
*Obrigatório |
Resposta:
- Se a requisição obtiver sucesso, será retornado o código de resposta HTTP 200, juntamente com os dados de rastreio do frete informado.
Nome | Descrição | Formato / Exemplo | Retornado |
---|---|---|---|
codigo | Código numérico da ocorrência na Frete Rápido | Numérico (inteiro) | 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 |
razao_social_transportadora | Razão social da transportadora na ocorrência | String até 255 caracteres | Sempre |
descricao_ocorrencia | Descrição da ocorrência na transportadora no momento da atualização | String até 255 caracteres | Eventual |
codigo_ocorrencia | Código da ocorrência na transportadora no momento da atualização | Inteiro | Eventual |
nome_entregador | Nome do entregador responsável pela ocorrência | String até 50 caracteres | Eventual |
cnpj_cpf_entregador | CNPJ/CPF do entregador responsável pela ocorrência | String até 14 caracteres | Eventual |
comprovantes | Comprovantes da ocorrência | Array com nenhum ou vários comprovantes | Eventual |
codigos_redespacho | Códigos de redespacho da ocorrência | Array com nenhum ou vários códigos | Eventual |
nome | Nome da ocorrência | String | Sempre |
codigo_volume | Código de rastreio do volume | String | Eventual |
Exemplo de resposta:
[
{
"codigo": "0",
"data_ocorrencia": "",
"data_atualizacao": "",
"data_reentrega": "",
"data_prevista_entrega": "",
"prazo_devolucao": "",
"mensagem": "",
"razao_social_transportadora": "",
"descricao_ocorrencia": "",
"codigo_ocorrencia": 0,
"nome_entregador": "",
"cnpj_cpf_entregador": "",
"comprovantes": [],
"codigos_redespacho": [],
"nome": "",
"codigo_volume": ""
},
{
"codigo": "1",
"data_ocorrencia": "",
"data_atualizacao": "",
"data_reentrega": "",
"data_prevista_entrega": "",
"prazo_devolucao": "",
"mensagem": "",
"razao_social_transportadora": "",
"descricao_ocorrencia": "",
"codigo_ocorrencia": 0,
"nome_entregador": "",
"cnpj_cpf_entregador": "",
"comprovantes": [],
"codigos_redespacho": [],
"nome": "",
"codigo_volume": ""
},
{
"codigo": "2",
"data_ocorrencia": "",
"data_atualizacao": "",
"data_reentrega": "",
"data_prevista_entrega": "",
"prazo_devolucao": "",
"mensagem": "",
"razao_social_transportadora": "",
"descricao_ocorrencia": "",
"codigo_ocorrencia": 0,
"nome_entregador": "",
"cnpj_cpf_entregador": "",
"comprovantes": [],
"codigos_redespacho": [],
"nome": "",
"codigo_volume": ""
}
]
Erro:
- Em caso de erro, será retornado o código estabelecido na lista de códigos desta API.