Alterar Ocorrências de Frete
POST https://freterapido.com/api/external/embarcador/v1/quotes/[identificador]/occurrences?token=[seu_token]
Método que permite atualizar de forma simples o status de um frete.
Basta enviar os dados abaixo em uma requisição para a URL do método.
Atenção:
- Não será possível retroceder alguma ocorrência do fluxo de entrega, como por exemplo: de "Entregue" para "Em trânsito" ou de "Em trânsito" para "Coletado".
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 | * |
* Dados obrigatórios |
Parâmetros do corpo da requisição:
Nome | Descrição | Formato / Exemplo | Obrigatório |
---|---|---|---|
occurrence | Código da ocorrência. Vide todas as ocorrências disponíveis na Frete Rápido. | Numérico (inteiro) | * |
date_time | Data e hora da ocorrência | DateTime ("YYYY-MM-DD hh:mm:ss") | * |
message | Livre para mensagens de texto de até 255 caracteres | String | Opcional |
receipts | Link para acesso ao comprovante da ocorrência (link permanente) | Array de string | Opcional |
* Dados obrigatórios |
Exemplo de envio:
{
"occurrence": 0,
"date_time": "2021-02-11 15:26",
"message": "",
"receipts": [
"https://www.freterapido.com/comprovantes/entrega/1.jpg"
],
}
- 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”.
Erro:
- Em caso de erro, será retornado o código estabelecido na lista de códigos desta API.
- Não será possível retroceder alguma ocorrência do fluxo de entrega, como por exemplo: de "Entregue" para "Em trânsito" ou de "Em trânsito" para "Coletado".