Ocorrências do Frete por ID Frete Rápido
POST https://freterapido.com/api/external/transportadora/v1/quotes/{id_frete}/occurrences?token={seu_token}
Método que permite atualizar de forma simples as ocorrências de um frete.
Sua Transportadora deverá enviar os dados abaixo, através de uma requisição.
Observação sobre o De/Para das Ocorrências:
Destacamos que: os códigos das ocorrências de sua transportadora devem ser enviados previamente, para que sejam inseridas na plataforma.
Observação sobre o rastreio por volume:
Em caso de rastreio por volumes, será necessário criar os volumes de cada frete, antes de enviar as ocorrências
Envio:
Parâmetros da URL:
Nome | Descrição | Formato / Exemplo | Obrigatório |
---|---|---|---|
id_frete | Identificador único de cada cotação/frete na Frete Rápido. Através deste é possível obter e relacionar todos os outros dados. | String de 13 caracteres | * |
token | Token de integração | String de 32 caracteres | * |
* Dados Obrigatórios |
Parâmetros do corpo da requisição:
Nome | Descrição | Formato / Exemplo | Obrigatório |
---|---|---|---|
ocorrencia | Código da ocorrência / status da sua Transportadora previamente informado à Frete Rápido | Numérico (inteiro) | * |
data_hora | Data e hora da ocorrência | DateTime ("YYYY-MM-DD hh:mm:ss") | * |
codigo_volume | Código de rastreio do volume | String | Opcional |
mensagem | Livre para mensagens de texto de até 255 caracteres | String | Opcional |
data_reentrega | Data de previsão para reentrega | Date ("YYYY-MM-DD") | Opcional |
prazo_devolucao | Prazo em dias úteis para devolução da carga | Numérico (inteiro) | Opcional |
comprovantes | Link para acesso ao comprovante da ocorrência (link permanente) | Array de string | Opcional |
codigos_redespacho | Código de rastreio em caso de redespacho | Array de string | Opcional |
metadados | Array de objetos contendo chave e valor com as informações adicionais da contratação | Array de objetos JSON contendo até 64 itens | * |
chave | Nome do atributo de informação extra da solicitação de coleta, deve ser nome único para chave | String de até 255 caracteres | Opcional |
valor | Corresponde ao valor do atributo da chave informada | String de até 255 caracteres | Opcional |
* Dados Obrigatórios |
Exemplo de envio:
{
"ocorrencia": 0,
"data_hora": "",
"codigo_volume": "",
"mensagem": "",
"data_reentrega": "",
"prazo_devolucao": "",
"comprovantes": [
"https://www.freterapido.com/comprovantes/entrega/1.jpg"
],
"codigos_redespacho": [
"abc-123"
],
"metadados": [
{
"chave": "",
"valor": ""
}
]
}
- Se a requisição obtiver sucesso, deve ser retornado o código de resposta HTTP 200. Em caso de erro, será retornado o parâmetro “erro”.
Nome | Descrição | Formato / Exemplo | Retornado |
---|---|---|---|
erro | Descrição do erro | String | Em caso de erro |
Exemplo de resposta:
{
"erro": "Frete não encontrado"
}